Android のベストプラクティス

このガイドでは、メモリ管理、セキュリティ、および Hilt からの移行に関する Android 特有のベストプラクティスについて説明します。

INFO

モジュールの一般的な概念については、Modules を参照してください。スコープについては、Scopes および Android Scopes を参照してください。

メモリ管理

Activity/Fragment のリークを避ける

// ❌ 悪い例 - Activity のリーク
module {
    single { SomeService(get<Activity>()) }  // シングルトン内での Activity 参照！
}

// ✅ 良い例 - Application コンテキストを使用する
module {
    single { SomeService(androidContext()) }  // Application コンテキスト、安全
}

// ✅ 良い例 - Activity スコープを使用する
module {
    activityScope {
        scoped { SomeService(/* activity スコープの依存関係 */) }
    }
}

スコープを適切に閉じる

// ✅ 良い例 - 自動スコープ管理
class MyActivity : ScopeActivity() {
    override val scope: Scope by activityScope()
    // onDestroy でスコープが自動的に閉じられる
}

// ❌ 悪い例 - クリーンアップなしの手動スコープ
class MyActivity : AppCompatActivity() {
    private val myScope = createScope<MyActivity>()
    // スコープが閉じられない - メモリリーク！
}

// ✅ 良い例 - クリーンアップを伴う手動スコープ
class MyActivity : AppCompatActivity() {
    private lateinit var myScope: Scope

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        myScope = createScope<MyActivity>()
    }

    override fun onDestroy() {
        myScope.close()
        super.onDestroy()
    }
}

長命なオブジェクト内の参照をクリアする

// ❌ 悪い例 - UI への参照を保持している
class UserRepository {
    private val listeners = mutableListOf<UserUpdateListener>()  // Activity の参照を保持する可能性がある

    fun addListener(listener: UserUpdateListener) {
        listeners.add(listener)
    }
}

// ✅ 良い例 - 弱参照（WeakReference）または手動でのクリーンアップ
class UserRepository {
    private val listeners = mutableListOf<WeakReference<UserUpdateListener>>()

    fun addListener(listener: UserUpdateListener) {
        listeners.add(WeakReference(listener))
    }

    fun removeListener(listener: UserUpdateListener) {
        listeners.removeAll { it.get() == listener || it.get() == null }
    }
}

Android でのデバッグ

Android ロガーを有効にする

startKoin {
    androidLogger(Level.DEBUG)  // すべての Koin 操作を表示
    androidContext(this@MyApplication)
    modules(appModules)
}

デバッグビルドでモジュールを検証する

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()

        startKoin {
            androidContext(this@MyApplication)
            modules(allModules)
        }

        // 代わりにユニットテストで verify() を使用する
        // appModule.verify()
    }
}

デバッグ用のスコープコールバック

class DebugActivity : ScopeActivity() {
    override val scope: Scope by activityScope()

    init {
        scope.registerCallback(object : ScopeCallback {
            override fun onScopeClose(scope: Scope) {
                Log.d("Koin", "Scope ${scope.id} closing")
            }
        })
    }
}

セキュリティのベストプラクティス

モジュール内にシークレットを保存しない

// ❌ 悪い例 - ハードコードされたシークレット
module {
    single {
        Retrofit.Builder()
            .addInterceptor { chain ->
                chain.proceed(
                    chain.request().newBuilder()
                        .header("API-Key", "super-secret-key")  // 不可！
                        .build()
                )
            }
            .build()
    }
}

// ✅ 良い例 - 安全なストレージからのシークレット
module {
    single {
        val securePrefs = get<SecurePreferences>()
        Retrofit.Builder()
            .addInterceptor(AuthInterceptor(securePrefs))
            .build()
    }
}

Dagger/Hilt からの移行

INFO

Koin は jakarta.inject の JSR-330 アノテーション（@Singleton、@Inject、@Named）をサポートしています。使い慣れたアノテーションをそのまま使用し続けることができます。JSR-330 Compatibility を参照してください。

アノテーションのマッピング

Hilt	Koin アノテーション
@Singleton	@Singleton (JSR-330 互換)
@Provides	@Factory
@Binds	@Singleton ... bind Interface::class
@Inject	@Inject (JSR-330 互換)
@HiltViewModel	@KoinViewModel
@InstallIn(SingletonComponent)	@Module + @ComponentScan
@InstallIn(ActivityComponent)	@Scope(ActivityScope::class)

移行の例

// 移行前 (Hilt)
@HiltViewModel
class HomeViewModel @Inject constructor(
    private val repository: UserRepository
) : ViewModel()

@Singleton
class UserRepositoryImpl @Inject constructor(
    private val api: ApiService
) : UserRepository

// 移行後 (Koin) - 最小限の変更！
@KoinViewModel
class HomeViewModel(
    private val repository: UserRepository
) : ViewModel()

@Singleton  // JSR-330 を引き続き使用
class UserRepositoryImpl(
    private val api: ApiService
) : UserRepository

モジュールの移行

// 移行前 (Hilt)
@InstallIn(SingletonComponent::class)
@Module
object NetworkModule {
    @Provides
    @Singleton
    fun provideRetrofit(): Retrofit = Retrofit.Builder().build()
}

// 移行後 (Koin アノテーション)
@Module
class NetworkModule {
    @Singleton
    fun provideRetrofit(): Retrofit = Retrofit.Builder().build()
}

段階的な移行

// ステップ 1: 新機能のために Hilt と並行して Koin を追加
@KoinViewModel
class NewFeatureViewModel(
    private val repository: NewFeatureRepository
) : ViewModel()

@Singleton
class NewFeatureRepository(private val api: ApiService)

// ステップ 2: 既存の機能を一つずつ移行
@Singleton
class MigratedRepository(private val api: ApiService) : UserRepository

// ステップ 3: 移行完了後に Hilt を削除

関連項目

• Scopes - コアとなるスコープの概念
• Android Scopes - Android ライフサイクルスコープ
• Testing - Android テストガイド
• Multi-Module Apps - Android モジュールの整理