More than 1 year has passed since last update.

型パラメータインジェクション - Type Parameter Injection(Swift)

Last updated at 2022-07-15Posted at 2022-05-01

はじめに

Swiftにおける型パラメータインジェクションを紹介します。

環境

OS：macOS Monterey 12.3.1
Xcode：13.3.1 (13E500a)
Swift：5.6

「型パラメータインジェクション」とは？

「型パラメータインジェクション（Type Parameter Injection）」はDIの手法のひとつで、ジェネリクスの型引数を使って依存性を注入することです。

FooProtocol.swift

protocol FooProtocol {
    static func foo()
}

Bar.swift（型パラメータインジェクション）

final class Bar<F: FooProtocol> { // 型引数で依存性を注入する
    func bar() {
        F.foo()
    }
}

この手法はTwitterで教えていただきました。
本記事ではkoherさんに合わせて「型パラメータインジェクション」と呼んでいます。

正式名称があるかどうかはわかりません。

他のインジェクションとの比較

「バスタードインジェクション（Bastard Injection）」 ¹ とコンストラクタインジェクション、型パラメータインジェクションを比較します。

バスタードインジェクション

まずはバスタードインジェクションを紹介します。

Foo をシングルトンにして、Bar のイニシャライザのデフォルト引数に指定します。

FooProtocol.swift

protocol FooProtocol {
    func foo()
}

Foo.swift

struct Foo {
    static let shared = Foo()

    private init() {} // シングルトンにするため、イニシャライザを外部に公開しない
}

extension Foo: FooProtocol {
    func foo() {
        print("Foo")
    }
}

Bar.swift（バスタードインジェクション）

final class Bar {
    private let foo: any FooProtocol

    init(foo: any FooProtocol = Foo.shared) { // イニシャライザのデフォルト引数で依存性を注入する
        self.foo = foo
    }

    func bar() {
        foo.foo()
    }
}

Bar().bar() を実行すると、 Foo と出力されます。

Bar().bar() // "Foo"

Foo をモックに差し替えるのが容易なため、 Bar はテスタブルであり、大きな問題はありません。
しかし以下のデメリットがあります。

存在型（ any ）を使っている ²
状態に依存しないことが保証されていない
- Foo のインスタンスを生成しているため
シングルトンにするためのボイラーテンプレートが存在する

コンストラクタインジェクション

「存在型を使っている」デメリットを解消するため、 FooProtocol プロトコルを Bar の型引数に指定します。

Bar.swift（コンストラクタインジェクション）

- final class Bar {
-   private let foo: any FooProtocol
+ final class Bar<F: FooProtocol> {
+   private let foo: F

-   init(foo: any FooProtocol = Foo.shared) { // イニシャライザのデフォルト引数で依存性を注入する
+   private init(foo: F) {
        self.foo = foo
    }
+ 
+   convenience init() where F == Foo {
+       self.init(foo: .shared)
+   }

    func bar() {
       foo.foo()
    }
}

これで存在型がなくなり、デメリットがひとつ減りました。

~~存在型（ any ）を使っている~~
状態に依存しないことが保証されていない
- Foo のインスタンスを生成しているため
シングルトンにするためのボイラーテンプレートが存在する

しかしボイラーテンプレートが増えてしまいました。
コンビニエンスイニシャライザを使ったデフォルト値の指定方法の詳細は、以下の記事をご参照ください。