[Swift]プロトコルの拡張で既定値を設定する。

1 はじめに
2 プロトコルの拡張について
3 さいごに
4 おすすめ書籍

はじめに

こんにちはsuzukiです。前回に引き続き今回もSwiftプロトコルについて触れていこうと思います。内容はプロトコルの拡張についてです。それではよろしくお願い致します。

プロトコルの拡張について

プロトコルの拡張機能はSwift2で実装されてます。主な使用パターンはデリゲートで宣言されている変数に既定値の設定です。
例えば配列を管理しているCollectionプロトコルではisEmptyや、first等がプロトコルの拡張と言う形で実装されています。

プロトコルに既定値を設定

プロトコルに既定値を設定する方法の例として簡単にコードを書いてみました。
デリゲートの内容としてはクラス名の文字列の取得と取得したクラス名をprintで呼び出しているだけです。

//デリゲートの宣言
protocol ClassDelegate {
    var classString:String {get}
    func sayClass()
}
//ClassDelegateを拡張して既定値を設定
extension ClassDelegate{
    //下記の様に変数や機能を宣言はできない。
    //var  hogeString:String{get}
    //func hogeMethod()
    
    //下記の様に値を設定する
    var classString:String {
        return String(describing: type(of: self))
    }

    func sayClass(){
        print(classString)
    }
}

//デリゲートの宣言

protocol ClassDelegate {

var classString:String {get}

func sayClass()

}

//ClassDelegateを拡張して既定値を設定

extension ClassDelegate{

//下記の様に変数や機能を宣言はできない。

//var hogeString:String{get}

//func hogeMethod()

//下記の様に値を設定する

var classString:String {

return String(describing: type(of: self))

}

func sayClass(){

print(classString)

}

コメントにも書いてありますが宣言の追加は行えません。もしどうしても新規に宣言を行いたいのであれば、拡張ではなく元のProtocol・継承を使うべきです。

プロトコルを設定したクラスの作成

実際にクラスを作ってみました。
ViewControllerではClassDelegateのためのコードは書いていませんが既定値が実装されているためエラーが出ません。

class ViewController: UIViewController ,ClassDelegate{
    override func viewDidLoad() {
        sayClass()
        print(classString)
    }
    override func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
        // Dispose of any resources that can be recreated.
    }
}

class ViewController: UIViewController ,ClassDelegate{

override func viewDidLoad() {

sayClass()

print(classString)

}

override func didReceiveMemoryWarning() {

super.didReceiveMemoryWarning()

// Dispose of any resources that can be recreated.

}

制約をつけてプロトコルに既定値を設定

前回のプロトコルの説明の際に準拠する対象を意識せず設定できると説明させていただきました。プロトコルの拡張で既定値の設定を行う場合、プロトコルを設定する対象をある程度意識した実装をする必要があります。
その様な場合は拡張を行う際に制約をつける事で異なる既定値を設定することができます。
例えばUIViewControllerクラスから呼ばれる際の既定値を設定する場合

extension ClassDelegate where Self : UIViewController{
    //UIViewControllerから呼ばれる場合の既定値
    var classString:String {
        return "!!ViewController!!"
    }
}

extension ClassDelegate where Self : UIViewController{

//UIViewControllerから呼ばれる場合の既定値

var classString:String {

return "!!ViewController!!"

}

上記の様に記述できます。Whereを利用してSelfがUIViewControllerの場合の際の既定値として設定しています。Selfの箇所は他の条件を設定することも可能です。
Swift4以上ではプロトコル同士をassociatedtypeで指定できる様になっているみたいです(詳しく調べ切れておりません、ごめんなさい)

実際に今回の内容をまとめてコードを記述してみました。

//デリゲートの宣言
protocol ClassDelegate {
    var classString:String {get}
    func sayClass()
}
//ClassDelegateを拡張して既定値を設定
extension ClassDelegate{
    //今回のテストでは呼ばれていない
    var classString:String {
        return String(describing: type(of: self))
    }
    //こちらは共通で呼ばれている
    func sayClass(){
        print(classString)
    }
}

//UIViewControllerから呼ばれた時
extension ClassDelegate where Self : UIViewController{
    //下記の様に既定値を設定する
    var classString:String {
        return "!!ViewController!!"
    }
}
//TestObjectから呼ばれた時
extension ClassDelegate where Self : TestObject{
    //下記の様に既定値を設定する
    var classString:String {
        return "!!TestObject!!"
    }
}
//ViewController
class ViewController: UIViewController ,ClassDelegate{
    override func viewDidLoad() {
        let testObject = TestObject()
        testObject.delegate = self
        //testObjectのsayClassを()を呼び出し
        testObject.sayClass()
        //testObjectからViewControllerのsayClass()を呼び出し
        testObject.callDelegate()
        
    }
    override func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
        // Dispose of any resources that can be recreated.
    }
}

class TestObject:ClassDelegate {
    var delegate: ClassDelegate?
    func callDelegate(){
        delegate?.sayClass()
    }
}

//デリゲートの宣言

protocol ClassDelegate {

var classString:String {get}

func sayClass()

}

//ClassDelegateを拡張して既定値を設定

extension ClassDelegate{

//今回のテストでは呼ばれていない

var classString:String {

return String(describing: type(of: self))

}

//こちらは共通で呼ばれている

func sayClass(){

print(classString)

}

//UIViewControllerから呼ばれた時

extension ClassDelegate where Self : UIViewController{

//下記の様に既定値を設定する

var classString:String {

return "!!ViewController!!"

}

//TestObjectから呼ばれた時

extension ClassDelegate where Self : TestObject{

//下記の様に既定値を設定する

var classString:String {

return "!!TestObject!!"

}

//ViewController

class ViewController: UIViewController ,ClassDelegate{

override func viewDidLoad() {

let testObject = TestObject()

testObject.delegate = self

//testObjectのsayClassを()を呼び出し

testObject.sayClass()

//testObjectからViewControllerのsayClass()を呼び出し

testObject.callDelegate()

}

override func didReceiveMemoryWarning() {

super.didReceiveMemoryWarning()

// Dispose of any resources that can be recreated.

}

class TestObject:ClassDelegate {

var delegate: ClassDelegate?

func callDelegate(){

delegate?.sayClass()

}

さいごに

最後までお付き合いいただきありがとうございます。
新しいプロジェクトのプロトコルあたりの実装をみるととても難解に見えます。
依存関係をなくすため、クラス間のやり取りが集中するので仕方ないですが、
さらにはプロトコルの継承、プロトコルの拡張、プロトコルを設定されているクラスの継承、、、
色々考慮することが多いのでしっかり設計段階で決めて書類に残して行きたいですね。また次回もよろしくお願い致します。