Skip to content

Androidのベストプラクティス ​

このページでは、Koinでリーク、クラッシュ、またはシークレット(機密情報)の露出を引き起こすAndroid特有の間違いと、それらを回避する方法を説明します。本ページは、AndroidスコープとAndroidでのKoinの開始を理解していることを前提としています。一般的なモジュール構成についてはモジュールで、エラーメッセージについてはトラブルシューティングで説明しています。

メモリリークとContextリーク ​

インスタンスは、自身よりも長寿命な何かがその参照を保持し続けることでリークします。Androidにおいて、その典型的な被害を受けるのがActivityです。singleはプロセスと同じ期間存続しますが、Activityは次の画面回転までしか存続しません。

singleに渡されるActivity ​

kotlin
// リークの例: singleが最初のActivityを永続的に保持し続ける
class UserActivity : AppCompatActivity() {
    private val tracker: ScreenTracker by inject { parametersOf(this) }
}

val appModule = module {
    single { params -> ScreenTracker(params.get<Activity>()) }
}

singleは最初の呼び出し時のパラメータを使用して一度だけ作成されます。それ以降の呼び出しでは同じインスタンスが返されるため、最初のActivityが保持されたままになります。代わりに以下のいずれかを使用してください。

  • Application context: クラスが必要とするのがリソースやシステムサービスのみである場合は、Contextを持つsingleとして宣言します。single内において、ContextはApplicationになります。
  • Activity scope: クラスがActivityを必要とする場合は、activityScope { }内または@ActivityScopeを付けて宣言します。これはActivityごとに作成され、Activityとともに破棄されます。
  • Factory with parameters: 呼び出し元がActivityを渡す場合はfactoryを使用し、Activityのライフタイムを超えて結果を保持しないようにします。

Compiler Pluginは、Context、Activity、Application、Fragment、SavedStateHandleをプラットフォームから提供される型として扱うため、定義の欠落としてはレポートしません。また、指定された定義内でActivityパラメータが安全であるかどうかまでは判別できないため、コードレビューで確認してください。

シングルトンによって保持されるリスナー ​

kotlin
class UserRepository {
    private val listeners = mutableListOf<UserListener>()

    fun addListener(listener: UserListener) { listeners += listener }
    fun removeListener(listener: UserListener) { listeners -= listener }
}

リポジトリはsingleです。ActivityやFragmentが自身をリスナーとして登録したまま削除しない場合、リポジトリがその画面を生かし続けることになります。対応するライフサイクルコールバック(onStart()に対してはonStop()、onViewCreated()に対してはonDestroyView())でリスナーを解除するか、Flowを公開してrepeatOnLifecycleで収集(collect)してください。これにより、自動的に収集がキャンセルされます。

オーナーよりも長生きするスコープ付きインスタンス ​

  • Retained scope: activityRetainedScopeは画面回転を跨いで存続します。そのインスタンスはActivity、View、Fragmentを参照してはなりません。
  • Fragment scope: これはonDestroyView()の後、onDestroy()で閉じられます。FragmentスコープのインスタンスにViewやバインディングを保持しないでください。
  • ViewModel: ActivityスコープやFragmentスコープのインスタンスをViewModelに注入しないでください。ViewModelは画面回転を跨いで存続しますが、Activityスコープは存続しません。

これらのルールについてはAndroidスコープで説明しています。

独自に作成するスコープ ​

activityScope()、fragmentScope()、ScopeActivity、ScopeFragment、ScopeServiceは、ライフサイクルに合わせてスコープを閉じます。getKoin().createScope()で作成したスコープにはライフサイクルがありません。手動で閉じないと、その中のすべてのインスタンスがメモリ上に残り続けます。

kotlin
// ログイン時
val sessionScope = getKoin().createScope<UserSession>(userId)

// ログアウト時
sessionScope.close()

Androidでのデバッグ ​

調査中は、Logcatのロガーをdebugレベルで有効にしてください。

kotlin
startKoin {
    androidLogger(Level.DEBUG)
    androidContext(this@MainApplication)
    modules(appModule)
}

Logcatで[Koin]タグをフィルタリングします。debugレベルでは、Koinは各モジュールのロード、各解決(resolution)とその所要時間、および各スコープのオープン/クローズをログに出力します。リリースビルドではLevel.ERRORまたはLevel.NONEを使用してください。

Android特有のエラー:

エラー主な原因
MissingAndroidContextExceptionstartKoinでandroidContext()が指定されていない
KoinApplication has not been startedApplicationクラスがマニフェストで宣言されていない、またはContentProviderがそのonCreate()内で注入を行っている(Androidエントリーポイントを参照)
スコープ型に対するNoDefinitionFoundExceptionActivityまたはFragmentにスコープがない(ScopeActivity、AndroidScopeComponent)
ClosedScopeExceptionスコープがすでに閉じられているonDestroy()内またはそれ以降で、コードがスコープ付きインスタンスを解決しようとしている。クリーンアップはonCloseScope()内で行う
Workersが "Could not instantiate" で失敗するデフォルトのWorkManagerイニシャライザがマニフェストに残っている(WorkManagerを参照)

Compiler Pluginを使用すると、定義の欠落はビルド時にレポートされます(コンパイル時の安全性を参照)。

TIP

実際のユーザーセッションにおける解決時間、スコープのライフタイム、Koinエラーを確認するには、本番環境のモニタリングを参照してください。

シークレット(機密情報) ​

APKはアンパック(解凍)が可能です。APK内にコンパイルされたものやassets/に保存されたものはすべて読み取ることができます。

  • ハードコードされたキー: APIキーをモジュール内に文字列リテラルとして記述しないでください。
  • Koin properties: androidFileProperties()はAPK内に同梱されるassets/koin.propertiesを読み取ります。これは設定用として使用し、シークレットには絶対に使用しないでください。
  • BuildConfigフィールド: これらもAPK内にコンパイルされます。ソースコード管理からは値を隠せますが、APKからは隠せません。

シークレットは実行時にバックエンドから取得するか、暗号化ストレージにトークンを保持し、値そのものではなくストレージを注入するようにしてください。

kotlin
class AuthInterceptor(private val tokens: TokenStore) : Interceptor {
    override fun intercept(chain: Interceptor.Chain): Response =
        chain.proceed(
            chain.request().newBuilder()
                .header("Authorization", "Bearer ${tokens.currentToken()}")
                .build()
        )
}

TokenStoreは暗号化ストレージに支えられたsingleであり、AuthInterceptorはOkHttpClientの定義に追加されます(Androidライブラリの統合を参照)。

HiltまたはDaggerからの移行 ​

アノテーションのマッピング、モジュールの移行、段階的な移行については、Hiltからの移行で説明しています。@Injectやjakarta.injectアノテーションを維持する方法については、JSR-330アノテーションを参照してください。