Android
このチュートリアルでは、リストから選択したユーザーに挨拶するAndroidアプリを構築します。Koinモジュールの宣言方法、ActivityへのPresenterのインジェクト方法、そしてApplicationクラスからのKoinの起動方法を学びます。所要時間は約10分で、Android Studioが必要です。
このチュートリアルではCompiler Plugin DSLを使用します。アノテーションを使用した同じアプリの実装については、Android & Annotationsを参照してください。スタイルの比較については、Choosing your styleを参照してください。Android ViewModelチュートリアルでは、Presenterの代わりにViewModelを使用して同じアプリを構築します。
コードの取得
完全なサンプルはkoin-getting-started/androidにあります。リポジトリをクローンし、Android Studioでandroidフォルダーを開いてください。
Gradleのセットアップ
サンプルではKoin Compiler Pluginを適用し、koin-androidを追加しています。バージョンはバージョンカタログ(Version Catalog)で管理されています。
# gradle/libs.versions.toml
[versions]
# Kotlin、Android Gradle Plugin、AndroidXのエントリは省略されています
koin = "<KOIN_VERSION>"
koin-plugin = "<KOIN_PLUGIN_VERSION>"
[libraries]
koin-android = { module = "io.insert-koin:koin-android", version.ref = "koin" }
koin-test-junit4 = { module = "io.insert-koin:koin-test-junit4", version.ref = "koin" }
koin-android-test = { module = "io.insert-koin:koin-android-test", version.ref = "koin" }
[plugins]
koin-compiler = { id = "io.insert-koin.compiler.plugin", version.ref = "koin-plugin" }// app/build.gradle.kts
plugins {
alias(libs.plugins.android.application)
alias(libs.plugins.kotlin.android)
alias(libs.plugins.koin.compiler)
}
dependencies {
implementation(libs.android.appcompat)
implementation(libs.koin.android)
testImplementation(libs.koin.test.junit4)
testImplementation(libs.koin.android.test)
}Compiler PluginにはKotlin 2.3.20以降が必要です。現在のバージョンおよびBOMについては、Gradle setupを参照してください。プラグインのオプションについては、Compiler Plugin setupを参照してください。
アプリケーションの構成
ActivityはPresenterに挨拶メッセージを要求します。PresenterはUserRepositoryから読み取りを行うUserServiceを使用します。
User -> UserRepository -> UserService -> UserPresenter -> MainActivityユーザーデータの作成
まずはデータクラスとユーザーのデフォルトリストの作成から始めます。
data class User(val name: String, val email: String)
val DEFAULT_USER = User("Alice", "alice@example.com")
val DEFAULT_USERS = listOf(
DEFAULT_USER,
User("Bob", "bob@example.com"),
User("Charlie", "charlie@example.com")
)これらのユーザーが、リポジトリに保存されるデータとなります。
リポジトリの作成
リポジトリはユーザーをメモリ内に保持し、名前で検索します。
interface UserRepository {
fun findUserOrNull(name: String): User?
fun addUsers(users: List<User>)
}
class UserRepositoryImpl : UserRepository {
private val _users = arrayListOf<User>()
override fun findUserOrNull(name: String): User? {
return _users.firstOrNull { it.name == name }
}
override fun addUsers(users: List<User>) {
_users.addAll(users)
}
}UserRepositoryImplには依存関係がないため、Koinは追加情報なしでこれを生成できます。
サービスの作成
UserServiceは生成時にユーザーを読み込み、挨拶メッセージを準備します。
interface UserService {
fun getUserOrNull(name: String = DEFAULT_USER.name): User?
fun loadUsers()
fun prepareHelloMessage(user: User?): String
}
class UserServiceImpl(
private val userRepository: UserRepository
) : UserService {
init {
loadUsers()
}
override fun getUserOrNull(name: String): User? = userRepository.findUserOrNull(name)
override fun loadUsers() {
userRepository.addUsers(DEFAULT_USERS)
}
override fun prepareHelloMessage(user: User?): String {
return user?.let { "Hello '${user.name}' (${user.email})!" } ?: "User not found"
}
}UserServiceImplはUserRepositoryに依存しています。Koinはこれをコンストラクタ経由で渡します。
Koinモジュールの宣言
モジュールは、Koinが生成するコンポーネントを宣言する場所です(Core Conceptsを参照)。両方のコンポーネントをシングルトンとして宣言し、それぞれのインターフェースにバインドします。
import org.koin.dsl.bind
import org.koin.dsl.module
import org.koin.plugin.module.dsl.single
val appModule = module {
single<UserRepositoryImpl>() bind UserRepository::class
single<UserServiceImpl>() bind UserService::class
}これで、UserServiceを要求するコンポーネントはすべて同じUserServiceImplインスタンスを取得するようになります。singleとbindの詳細については、Definitionsで解説されています。
Presenterの作成
Presenterは名前を挨拶メッセージに変換します。
class UserPresenter(
private val userService: UserService
) {
fun sayHello(name: String): String {
val user = userService.getUserOrNull(name)
val message = userService.prepareHelloMessage(user)
return "[UserPresenter] $message"
}
}リクエストごとに新しいインスタンスが生成され、Koinがその参照を保持しないように、factoryを使って宣言します。
import org.koin.plugin.module.dsl.factory
val appModule = module {
single<UserRepositoryImpl>() bind UserRepository::class
single<UserServiceImpl>() bind UserService::class
factory<UserPresenter>()
}factoryのPresenterは、それを使用するActivityのライフサイクルを超えて生存することはないため、Activityのリークを防ぐことができます。
ActivityへのPresenterのインジェクト
MainActivityでPresenterを取得するには、by inject()デリゲートを使用します。
import org.koin.android.ext.android.inject
class MainActivity : AppCompatActivity() {
private val presenter: UserPresenter by inject()
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_simple)
val nameInput = findViewById<EditText>(R.id.nameInput)
val sayHelloButton = findViewById<Button>(R.id.sayHelloButton)
val textField = findViewById<TextView>(R.id.text)
sayHelloButton.setOnClickListener {
val userName = nameInput.text.toString().trim().ifEmpty { "Alice" }
textField.text = presenter.sayHello(userName)
}
}
}by inject()は、最初に使用されるタイミングでPresenterを遅延解決(Lazy Resolve)します。これをサポートしている他のAndroidコンポーネントについては、Android Entry Pointsに記載されています。
Koinの開始
ApplicationクラスでKoinを開始し、そのクラスをAndroidManifest.xmlに登録します。
import org.koin.android.ext.koin.androidContext
import org.koin.android.ext.koin.androidLogger
import org.koin.core.context.startKoin
import org.koin.core.logger.Level
class MainApplication : Application() {
override fun onCreate() {
super.onCreate()
startKoin {
androidLogger(Level.DEBUG)
androidContext(this@MainApplication)
modules(appModule)
}
}
}androidContext()によってAndroidのContextが定義から利用可能になり、androidLogger()によってKoinのログがLogcatに出力されます。アプリを実行し、名前を入力してボタンをタップすると、挨拶メッセージが表示されます。その他のオプションについては、Starting Koin on Androidを参照してください。
次のステップ
- Core Concepts: モジュール、定義、インジェクションの背景にあるメンタルモデル。
- Android ViewModel: ViewModelを使用した同じアプリの構築。
- Android Entry Points: Fragment、Service、Receiverなどへのインジェクト。
- Instrumented testing: Koinを使用したAndroidアプリのテスト。
- Tooling: Koin向けのIDEプラグインとモニタリングツール。
