Androidにおけるインジェクション

モジュールを宣言し、Koinを開始したら、AndroidのActivity、Fragment、またはServiceでインスタンスを取得するにはどうすればよいでしょうか？

Androidクラスへの対応

Activity、Fragment、ServiceはKoinComponents拡張機能で拡張されています。任意のComponentCallbacksクラスはKoin拡張機能にアクセスできます。

以下のKotlin拡張機能にアクセスできます：

• by inject() - Koinコンテナから遅延評価されるインスタンス
• get() - Koinコンテナから即座に取得されるインスタンス

プロパティを遅延インジェクションとして宣言できます：

module {
    // definition of Presenter
    factory { Presenter() }
}

class DetailActivity : AppCompatActivity() {

    // Lazy inject Presenter
    override val presenter : Presenter by inject()

    override fun onCreate(savedInstanceState: Bundle?) {
        //...
    }
}

または、インスタンスを直接取得することもできます：

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)

    // Retrieve a Presenter instance
    val presenter : Presenter = get()
}

INFO

クラスに拡張機能がない場合は、KoinComponentインターフェースを実装するだけで、他のクラスからインスタンスをinject()またはget()できます。

定義におけるAndroid Contextの使用

ApplicationクラスがKoinを設定すると、androidContext関数を使用してAndroid Contextをインジェクションできます。これにより、モジュールで必要になったときに後で解決できるようになります。

class MainApplication : Application() {

    override fun onCreate() {
        super.onCreate()

        startKoin {
            // inject Android context
            androidContext(this@MainApplication)
            // ...
        }
        
    }
}

あなたの定義において、androidContext()関数とandroidApplication()関数は、Koinモジュール内でContextインスタンスを取得することを可能にし、Applicationインスタンスを必要とする式を簡単に記述するのに役立ちます。

val appModule = module {

    // create a Presenter instance with injection of R.string.mystring resources from Android
    factory {
        MyPresenter(androidContext().resources.getString(R.string.mystring))
    }
}

AndroidスコープとAndroid Contextの解決

Context型をバインドするスコープがある場合でも、異なるレベルからContextを解決する必要があるかもしれません。

以下の設定を見てみましょう：

class MyPresenter(val context : Context)

startKoin {
  androidContext(context)
  modules(
    module {
      scope<MyActivity> {
        scoped { MyPresenter( <get() ???> ) }
      }
    }
  )
}

MyPresenterで適切な型を解決するには、以下を使用します：

• get()は最も近いContextの定義を解決します。ここではソーススコープのMyActivityになります。
• androidContext()も最も近いContextの定義を解決します。ここではソーススコープのMyActivityになります。
• androidApplication()もApplicationの定義を解決します。ここではKoinのセットアップで定義されたソーススコープのcontextオブジェクトになります。