🪙
【Android】Koin を使ってみた
Koin の導入
build.gradle
buildscript {
// 追加
ext.koin_version = '3.1.2'
ext.kotlin_version = '1.5.20'
repositories {
google()
mavenCentral()
}
dependencies {
classpath "com.android.tools.build:gradle:7.0.0"
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
}
}
app/build.gradle
dependencies {
// 追加
implementation "io.insert-koin:koin-android:$koin_version"
}
jcenter
の閉鎖で、Koin プロジェクトの ID がorg.koin
からio.insert-koin
に変更されています。
Due to Jcenter shutdown, the koin project's maven group id was previously org.koin and is now io.insert-koin. Please check your configuration with modules below.
Application
で初期化する
アプリ起動時、最初に呼び出されるApplication
を継承したクラスでKoin
を初期化します。
MyApp.kt
package com.example.sample
import android.app.Application
import org.koin.android.ext.koin.androidContext
import org.koin.core.context.startKoin
class MyApp : Application() {
override fun onCreate() {
super.onCreate()
startKoin {
androidContext(this@MyApp)
modules(modules)
}
}
}
AppModule.kt
モジュール宣言を別ファイルに切り出しています。各宣言は以下の目的で使います。
-
single
: シングルトンでモジュール宣言 -
factory
: モジュール宣言したクラスが必要になるたび、インスタンスを生成する -
viewModel
: ViewModel のモジュール宣言で使用する
package com.example.sample
import com.example.sample.model.repository.Repository
import com.example.sample.model.repository.RepositoryImpl
import com.example.sample.ui.MainViewModel
import org.koin.androidx.viewmodel.dsl.viewModel
import org.koin.dsl.module
val modules = module {
// interface で DI したいときは、ジェネリクスに interface、{ } に継承したクラスを定義する。
single<Repository> { RepositoryImpl() }
viewModel { MainViewModel() }
// AndroidViewModel を継承している場合、コンストラクタで Application が必要になるので get() を使う
viewModel { SampleViewModel(get()) }
}
AndroidManifest.xml
android:name
にMyApp.kt
を設定して、アプリ起動時に呼び出されるようにします。
<application
android:name=".MyApp"
android:allowBackup="true"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_name"
android:roundIcon="@mipmap/ic_launcher_round"
android:supportsRtl="true">
<activity
android:name=".ui.MainActivity"
android:exported="true">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
</application>
DI
MainActivity.kt
class MainActivity : AppCompatActivity() {
private val _viewModel: MainViewModel by inject()
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
}
}
MainViewModel.kt
class MainViewModel : ViewModel() {
private val _repository: Repository by inject(Repository::class.java)
init {
fetchRepositories()
}
private fun fetchRepositories(userName: String = "user") {
viewModelScope.launch(Dispatchers.IO) {
val result = _repository.fetchRepositories(userName)
}
}
}
Discussion