【Swift】実行時にUIBarButtonItemのターゲットとアクションを設定する方法

実行時にバーボタンのアクションを作成するには、いくつかの手順を踏む必要があります。まずは、新しいプロジェクトの作成から始めましょう。

プロジェクトを作成したら、ストーリーボードを開き、ViewControllerを選択して「Editor」→「Embed in」からNavigation Controllerに埋め込みます。

1. アクション用のメソッドを定義する

次に、該当するViewControllerクラスを開き、ボタンが押されたときに呼び出されるObjective-C互換の関数を定義します。@objc属性を付けることで、#selectorから参照できるようになります。

@objc func barButtonAction() {
    print("Button pressed")
}

2. viewWillLayoutSubviews内でバーボタンを生成する

続いて、クラスにviewWillLayoutSubviewsメソッドを追加します。この中で、実行時にナビゲーションバーへボタンを追加する処理を行います。

バーボタンのインスタンスを作成

まず、UIBarButtonItemのインスタンスを生成します。

let barButton = UIBarButtonItem()

ボタンにタイトルを設定

次に、このバーボタンに表示名を設定します。

barButton.title = "custom"

アクションとターゲットを設定

ここが本記事のポイントです。先ほど定義したメソッドをセレクタとして指定し、ターゲットにはselfを設定します。

barButton.action = #selector(barButtonAction)
barButton.target = self

ナビゲーションバーにボタンを追加

最後に、このボタンをアプリのナビゲーションバーに追加します。ここでは左側のバーボタンとして配置しています。

self.navigationItem.setLeftBarButton(barButton, animated: true)

完成コード

ここまでの手順をまとめると、コード全体は以下のようになります。

override func viewWillLayoutSubviews() {
    let barButton = UIBarButtonItem()
    barButton.title = "custom"
    barButton.action = #selector(barButtonAction)
    barButton.target = self
    self.navigationItem.setLeftBarButton(barButton, animated: true)
}

@objc func barButtonAction() {
    print("Button pressed")
}

実行結果

上記のコードをデバイスで実行すると、ナビゲーションバーの左側に「custom」というボタンが表示されます。

このボタンを複数回押すと、コンソールには以下のように「Button pressed」というログが出力されます。

このように、viewWillLayoutSubviewsなどのタイミングでUIBarButtonItemのインスタンスを生成し、actionに#selectorで指定したメソッドを、targetにselfを設定することで、実行時に動的にバーボタンの挙動を制御できます。