Closureを使ってスマートで再利用可能なモーダルを作ろう計画

こんにちは。つまようじ職人という名前でやらせていただいております。この記事が初投稿です。
<br>
今回ですが、SwiftにおけるClosureを用いることによって、様々な場面で再利用できるモーダルのViewController
（以下, VC）を作成していこうという内容です。
<br>

文で書いてもわかりにくいと思いますので、少しずつ画像などを使いながらやっていきたいと思います。
<br>

また、この例のサンプルのgithubはこちらになります。
https://github.com/tsumayoji1102/practice_closure


# やろうと思ったきっかけ
<br>

いろいろなアプリを見たりしていましたが、このようなデザイン性の実装がしてみたいと感じました。
<br>

これはYahoo乗り換え案内アプリの時間を設定する際に登場する画面です。
<br>

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/581911/f9b1b1c7-deb0-ab42-39a6-fd7cb0c83dcb.gif" width=50%>

<br>
特徴として、
<br>

・小さくモーダル表示される
・背景が少し暗くなる
・選択した値（画像の中では時間）をもとの画面に返却している
<br>

といった画面を作成したいと思ったということです。
<br>

このような画面を実装していくに当たって得られた収穫は、
<br>

`・TransitioningViewControllerDelegateの実装`
`・VCのモーダル表示(modalpresentationstyle = .custom`
<br>

ですが、調べても出てこなかった（というよりもちゃんと実装された例がなかった）のが、
<br>

**「クロージャー処理」の実装**でした。
<br>

選択した値を疎結合に返却する方法が分からずに、いろいろ調べた結果クロージャがあることを知りました。
<br>

しかし調べていってもこのような実装をしている例が見つかりませんでした。
<br>

こんな画面を実装したいと思っている人はあまり多くないのかな？　という疑問を持ったのですが、
自分自身どうしても実装したくてずっと調べていました。
<br>

最終的には試行錯誤でたどり着いてしまいましたが（笑）
<br>

もし同じようなことを考えてらっしゃる方がいらっしゃいましたら、参考になれば幸いです。
<br>

## クロージャー処理の実装
<br>

今回は、クロージャに焦点をあてて書きますので、transition(背景が暗くなるアニメーション)など気になる方は[コード](https://github.com/tsumayoji1102/practice_closure)を参照いただければ幸いです。

以下のような画面（４つのUIButton）を設置し、それぞれで違う値が返せるようにしました。
<br>

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/581911/18dc1e93-380d-6cf3-1c27-59df41594b5c.png" width=50%>

ボタンを押下した際に、モーダルが表示され、トランジションによって背景が暗くなります。
（トランジションが存在する理由は、そのまま遷移するとViewController特有のアニメーションが動作されてしまうため。）
<br>

そして、それぞれで値の選択ができるようになっています。
<br>

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/581911/337d1daa-14ea-cf30-fb8c-502aa86e16d0.png" width=50%>
<br>

選択してOKボタンをタップすると、モーダルが閉じ、値を返却して元のボタンに反映されるようになっています。
<br>


<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/581911/0313fb30-d81e-fc44-9995-f3f745d503f8.png" width=50%>
<br>

GIFだとこんなイメージになります。
<br>

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/581911/9873a9ef-2869-70d6-733a-73a17444f0f9.gif" width=50%>


## 仕組み
<br>

今回、ボタンが設置されているViewをTableViewController、モーダルのViewをModalViewControllerと名付けました。
（Transitionの実装は、PresentationControllerとしています。)
<br>

まずModalViewControllerでは、クロージャーを設定しておきます。
また、ピッカーに使うリストを保持しておくための配列も用意します。
<br>

```swift:ModalViewController.swift
import UIKit

class ModalViewController: UIViewController {

    @IBOutlet weak var modalView: UITableView!
    
    // ここにリストを収める
    var list: Array<String>!
    
    // クロージャー
    var closure: ((Int) -> Void)!
    
    var pickerView: UIPickerView! // ピッカー
    var OKButton:   UIButton!     // OKボタン

    override func viewDidLoad() {
      super.viewDidLoad()
       
```
<br>

クロージャーの意味としては、Int型の値を引数として返却するので、それをVoid型の関数の中で使用してくれたらよいですよ、という意味です。
<br>

正直ここがわかりにくいポイントですが、**Void型の関数というのはすなわちメソッド**です。
<br>

これは**モーダルのひらき元のViewControllerで自由に設定することができるということです。**
<br>

その際に**Int型の返却値を利用してくれれば幸いだ**、というスタンスであるということです。
<br>

そして、ModalViewControllerでOKボタンを押した際の処理では、クロージャに値を返却するようにすれば大丈夫です。
<br>

```swift:ModalViewController.swift
  // OKボタンタップ後
    @objc func tapButton(_ sender: UIButton){
        
        // クロージャで選択したもののインデックス番号を返却
        closure(pickerView.selectedRow(inComponent: 0))
        self.dismiss(animated: true, completion: nil)
    }
```
<br>

こうすることで、クロージャーに値をいれてモーダルを閉じることができます。
<br>

そして、もとの画面でそのクロージャのメソッドを設定します。
<br>

少しわかりにくいかもしれませんが、遷移元の画面でボタンを押した際に動作するメソッド内に記述していきます。
<br>

それぞれのボタンでタグの値を設定し、それによって分岐するように作成しております。
<br>

```swift:TableViewController
// ボタンタップ時（遷移元)
    @objc func tapButton(_ sender: UIButton){
        
        // モーダル作成
        let ModalVC = self.storyboard?.instantiateViewController(identifier: "ModalViewController") as? ModalViewController
        // トランジションの実装
        ModalVC?.transitioningDelegate = self
        ModalVC?.modalPresentationStyle = .custom
        
        // タグで分岐
        switch sender.tag {
        case ButtonTag.name.rawValue:
            // リスト、クロージャーを設定
            let list = ["田中", "鈴木", "山本", "片山", "剛力"]
            ModalVC?.list = list
            ModalVC?.closure = { index in
                let name = list[index]
                sender.setTitle("名前は\(name)", for: .normal)
            }
            break
        case ButtonTag.sex.rawValue:
            // リスト、クロージャーを設定
            let list = ["男性", "女性"]
            ModalVC?.list = list
            ModalVC?.closure = { index in
                let sex = list[index]
                sender.setTitle("性別は\(sex)", for: .normal)
            }
            break
        case ButtonTag.hobby.rawValue:
            // リスト、クロージャーを設定
            let list = ["釣り", "釣り以外"]
            ModalVC?.list = list
            ModalVC?.closure = { index in
                let sex = list[index]
                sender.setTitle("趣味は\(sex)", for: .normal)
            }
            break
        case ButtonTag.cake.rawValue:
            // リスト、クロージャーを設定
            let list = ["ショートケーキ", "チョコケーキ", "モンブラン"]
            ModalVC?.list = list
            ModalVC?.closure = { index in
                let cake = list[index]
                sender.setTitle("好きなケーキは\(cake)", for: .normal)
            }
            break
        default:
            break
        }
        
        self.present(ModalVC!, animated: true, completion: nil)
        
    }
```

それぞれのケースで、モーダルのlistに選択リストを代入し、クロージャの返却値をインデックスとして取得し、
選択した文字列をボタンに代入しています。
<br>

`index in` と記載されているところがポイントで、indexは返ってくる引数であり、名前の付け方は自由です。
indexでなくても構いません。
<br>

そして、inの後ろにVoidのメソッドを設定していきます。とはいっても、普通にやりたい処理を書いていくだけで良いです。
<br>

## クロージャは順番が難しい

今回はモーダルでの実装から逆算するように説明しましたが、コードの流れ方としては
<br>

`①TableViewControllerより、モーダルのインスタンスを作成`
`②モーダルのクロージャのVoidを、引数を利用しながら設定（TableViewController内でどう使いたいかをイメージ)`
`③モーダルに画面遷移、そして閉じる時に値が返却される`
`④TableViewControllerに値が返却され、そしてクロージャに設定したVoidが動く`
<br>

となっております。**設定したクロージャのメソッドはモーダルが閉じたときに動作する**、という認識を持って作成すると整理しやすいかと思います。
<br>

この辺りを理解するのに自分自身も多くの時間がかかりました。
<br>

## クロージャーを使うメリット


僕が特に良いなと感じていることは、クロージャのVoidの設定が自由であることから、**モーダル自体はかなり疎結合になることです**。
<br>

iOSアプリの実装においてしんどいなと思うポイントは、ViewController同士で値の受け渡しをさせすぎると複雑になり、保守や新規実装もめんどくさければテストも難しくなります。
<br>

しかし、このサンプルをとってもクロージャを設定することで、代入するリストはその都度自由に設定できますし、返却する値も統一して実装することができます。
<br>

ピッカーでなくともこのようにして値の返却ができるようになれば、かなり保守性の高いコードをかけること間違いなしです。

## まとめ、感想

私自身クロージャーを理解する努力を怠れば、4つのボタンに対して4つのモーダルを作成し設定してしまっていたのではないかと感じています。
<br>

少しでも僕自身の苦しみが他の誰かへの貢献につながれば幸いです。最後まで読んでくださりありがとうございました。