Skip to content

Android & Annotations ​

このチュートリアルでは、リストから選択したユーザーに挨拶を表示するAndroidアプリを作成します。クラスへのアノテーションの付与、モジュールへのスキャン、ViewModelへの独自のスコープ付き依存関係の付与、そして@KoinApplicationクラスからのKoinの起動方法を学びます。所要時間は約10分で、Android Studioが必要です。

このチュートリアルではアノテーションを使用します。Compiler Plugin DSLを使用した同じアプリについては、AndroidおよびAndroid ViewModelを参照してください。スタイルの比較については、Choosing your styleを参照してください。

コードの取得 ​

完全なサンプルコードは koin-getting-started/android-annotations にあります。リポジトリをクローンし、Android Studioでandroid-annotationsフォルダを開いてください。

Gradleのセットアップ ​

このサンプルでは、Koin Compiler Pluginを適用し、koin-androidとkoin-annotationsを追加します。バージョンはバージョンカタログで管理されます。

toml
# 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-annotations = { module = "io.insert-koin:koin-annotations", version.ref = "koin" }
koin-test-junit4 = { module = "io.insert-koin:koin-test-junit4", version.ref = "koin" }

[plugins]
koin-compiler = { id = "io.insert-koin.compiler.plugin", version.ref = "koin-plugin" }
kotlin
// 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)
    implementation(libs.koin.annotations)

    testImplementation(libs.koin.test.junit4)
}

Compiler Pluginはアノテーションを処理し、Kotlin 2.3.20以降が必要です。koin-annotationsはKoinと同じバージョンを使用します。コンパイル時の安全性(Compile-time safety)はデフォルトで有効になっています。詳細については、Gradle setupおよびCompiler Plugin setupを参照してください。

アプリケーションの概要 ​

ActivityはViewModelに挨拶を要求します。ViewModelはUserRepositoryからデータを読み取るUserServiceを使用し、自身のライフサイクルにスコープが限定されたUserPresenterを保持します。

User -> UserRepository -> UserService -> UserViewModel (+ UserPresenter) -> MainActivity

ユーザーデータの作成 ​

まずはデータクラスとデフォルトのユーザーリストを作成します。

kotlin
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")
)

これらのユーザーが、リポジトリに保存されるデータとなります。

リポジトリの作成 ​

リポジトリはユーザーをメモリ内に保持します。実装クラスに@Singletonアノテーションを付与します。

kotlin
import org.koin.core.annotation.Singleton

interface UserRepository {
    fun findUserOrNull(name: String): User?
    fun addUsers(users: List<User>)
}

@Singleton
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)
    }
}

KoinはUserRepositoryImplをそのスーパータイプにバインドするため、UserRepositoryのリクエストに対してこのインスタンスが提供されます。@Singletonは@Singleと同等です(Definitionsを参照)。

サービスの作成 ​

UserServiceは作成時にユーザーを読み込み、挨拶メッセージを準備します。

kotlin
interface UserService {
    fun getUserOrNull(name: String = DEFAULT_USER.name): User?
    fun loadUsers()
    fun prepareHelloMessage(user: User?): String
}

@Singleton
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"
    }
}

Compiler Pluginがコンストラクタを読み取り、UserRepositoryインスタンスを自動で渡します。

PresenterとViewModelの作成 ​

Presenterは挨拶をフォーマットします。各ViewModelが独自のインスタンスを取得できるように、@ViewModelScopeアノテーションを付与します。

kotlin
import org.koin.core.annotation.ViewModelScope

@ViewModelScope
class UserPresenter(
    private val userService: UserService
) {

    fun sayHello(name: String): String {
        val user = userService.getUserOrNull(name)
        val message = userService.prepareHelloMessage(user)
        return "[UserPresenter] $message"
    }
}

ViewModelには@KoinViewModelを付与し、さらにスコープ付きPresenterを受け取れるように@ViewModelScopeを付与します。

kotlin
import org.koin.core.annotation.KoinViewModel
import org.koin.core.annotation.ViewModelScope

@ViewModelScope
@KoinViewModel
class UserViewModel(
    private val userService: UserService,
    private val userPresenter: UserPresenter
) : ViewModel() {

    fun sayHello(name: String): String {
        val user = userService.getUserOrNull(name)
        val message = userService.prepareHelloMessage(user)
        return "[UserViewModel] $message"
    }
}

PresenterはViewModelと同じ期間生存し、ViewModelが破棄(クリア)されると解放されます。ViewModelスコープについてはViewModelで、スコープ全般についてはScopesで解説されています。

Koinモジュールの宣言 ​

モジュールは定義をグループ化します(Core Conceptsを参照)。サンプルのパッケージをスキャンするモジュールクラスを宣言します。

kotlin
import org.koin.core.annotation.ComponentScan
import org.koin.core.annotation.Configuration
import org.koin.core.annotation.Module

@Module
@ComponentScan("org.koin.sample")
@Configuration
class AppModule

@ComponentScanは、org.koin.sampleとそのサブパッケージ内のすべてのアノテーション付きクラスを登録します。@Configurationは、モジュールを@KoinApplicationエントリポイントから検出可能にします。どちらについてもModulesで説明されています。

ActivityへのViewModelの注入 ​

MainActivityでby viewModel()デリゲートを使用します。

kotlin
import org.koin.androidx.viewmodel.ext.android.viewModel

class MainActivity : AppCompatActivity() {

    private val viewModel: UserViewModel by viewModel()

    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 = viewModel.sayHello(userName)
        }
    }
}

by viewModel()はViewModelファクトリを自動生成し、インスタンスをActivityのライフサイクルにバインドします。その他のデリゲートについてはAndroid ViewModelを参照してください。

Koinの起動 ​

Applicationクラスに@KoinApplicationアノテーションを付与し、型付きのstartKoin<T>()でKoinを起動します。このクラスをAndroidManifest.xmlに登録してください。

kotlin
import org.koin.android.ext.koin.androidContext
import org.koin.android.ext.koin.androidLogger
import org.koin.core.annotation.KoinApplication
import org.koin.core.annotation.KoinViewModelScopeApi
import org.koin.core.logger.Level
import org.koin.core.option.viewModelScopeFactory
import org.koin.plugin.module.dsl.startKoin

@OptIn(KoinViewModelScopeApi::class)
@KoinApplication
class MainApplication : Application() {

    override fun onCreate() {
        super.onCreate()

        startKoin<MainApplication> {
            androidContext(this@MainApplication)
            androidLogger(level = Level.DEBUG)
            options(viewModelScopeFactory())
        }
    }
}

startKoin<MainApplication>はすべての@Configurationモジュールを読み込むため、modules()を呼び出す必要はありません。viewModelScopeFactory()は、@ViewModelScopeに必要なスコープをViewModelごとに作成するようKoinに指示します。これはオプトインAPI(@KoinViewModelScopeApi)です。その他のオプションについてはStarting Koin on Androidを参照してください。

ビルド時のグラフ検証 ​

プロジェクトをビルドします。Compiler Pluginがグラフ全体を検証します。依存関係の不足、クォリファイアの不一致、あるいは未宣言のViewModelに対するby viewModel()の呼び出しがある場合、該当するファイルと行番号とともにビルドが失敗します。

アプリを実行し、名前を入力してボタンをタップすると、挨拶が表示されます。プラグインがチェックする内容についてはCompile-Time Safetyに記載されています。

次のステップ ​

  • Core Concepts: モジュール、定義、注入の背後にあるメンタルモデル。
  • Android scopes: AndroidにおけるActivity、Fragment、ViewModelのスコープ。
  • Annotations Reference: 各アノテーションとそのパラメータの一覧。
  • Instrumented testing: Koinを使用したAndroidアプリのインストルメンテーションテスト。
  • Tooling: Koin向けのIDEプラグインと監視ツール。