プロジェクトへのコンポーネントの追加

初めに、アーキテクチャ コンポーネントのアプリ アーキテクチャ ガイドを一読することをおすすめします。このガイドでは、すべての Android アプリに適用される有用な原則と、アーキテクチャ コンポーネントを組み合わせて使用する方法が説明されています。

アーキテクチャ コンポーネントは Google の Maven リポジトリから入手できます。このコンポーネントを使用するには、リポジトリをプロジェクトに追加する必要があります。

settings.gradle ファイルを開き、下記のように google() リポジトリを追加します。

Groovy

dependencyResolutionManagement {
   ...
    repositories {
        google()
        jcenter()
    }
}

Kotlin

dependencyResolutionManagement {
    ...
    repositories {
        google()
        jcenter()
    }
}

依存関係の宣言

アプリまたはモジュール用の build.gradle ファイルを開き、必要なアーティファクトを依存関係として追加します。すべてのアーキテクチャ コンポーネントの依存関係を追加することも、サブセットを選択することもできます。

リリースノートで、各アーキテクチャ コンポーネントの依存関係を宣言する手順をご覧ください。

各コンポーネントの最新のバージョン番号については、AndroidX リリースをご覧ください。

AndroidX リファクタリングの詳細と、これらのクラス パッケージおよびモジュール ID への影響については、AndroidX リファクタリングのドキュメントをご覧ください。

Kotlin

Kotlin 拡張モジュールは、複数の AndroidX 依存関係でサポートされています。これらのモジュールの名前には、「-ktx」という接尾辞が付いています。次に例を示します。

Groovy

implementation "androidx.lifecycle:lifecycle-viewmodel:$lifecycle_version"

Kotlin

implementation("androidx.lifecycle:lifecycle-viewmodel:$lifecycle_version")

これは次のようになります。

Groovy

implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycle_version"

Kotlin

implementation("androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycle_version")

Kotlin 拡張機能のドキュメントなどについて詳しくは、KTX のドキュメントをご覧ください。

注: Kotlin ベースのアプリでは、annotationProcessor ではなく kapt を使用してください。また、kotlin-kapt プラグインも追加する必要があります。