ベースラインプロファイルを作成する

Jetpack Macrobenchmark ライブラリと BaselineProfileRule を使用して、アプリのリリースごとにプロファイルを自動的に生成します。ベースラインプロファイルを使用する場合は、ビルドが改善されている com.android.tools.build:gradle:8.0.0 以降を使用することをおすすめします。

新しいベースラインプロファイルを作成する一般的な手順は次のとおりです。

ベースラインプロファイルモジュールをセットアップします。
ベースラインプロファイルの生成に役立つ JUnit テストを定義します。
最適化するクリティカルユーザージャーニー（CUJ）を追加します。
ベースラインプロファイルを生成します。

ベースラインプロファイルを生成したら、実機を使用してベンチマークを行い、速度の向上を測定します。

AGP 8.2 以降で新しいベースラインプロファイルを作成する

新しいベースラインプロファイルを作成する最も簡単な方法は、Android Studio Iguana と Android Gradle プラグイン（AGP）8.2 以降で利用可能なベースラインプロファイルモジュールテンプレートを使用することです。

Android Studio ベースラインプロファイルジェネレータモジュールテンプレートを使用すると、ベースラインプロファイルの生成とベンチマークを行うための新しいモジュールの作成を自動化できます。テンプレートを実行すると、一般的なビルド構成、ベースラインプロファイル生成、検証コードのほとんどが生成されます。このテンプレートにより、ベースラインプロファイルの生成とベンチマークを行ってアプリの起動時間を測定するためのコードが作成されます。

ベースラインプロファイルモジュールをセットアップする

ベースラインプロファイルモジュールテンプレートを実行する手順は、次のとおりです。

[File] > [New] > [New Module] を選択します。
[Templates] パネルで [Baseline Profile Generator] テンプレートを選択し、構成します。
図 1.
ベースラインプロファイルジェネレータモジュールテンプレート

テンプレートの各フィールドは次のとおりです。
- Target application: ベースラインプロファイルを生成するアプリを定義。プロジェクトにアプリモジュールが 1 つしかない場合、このリストにはアイテムが 1 つだけになります。
- Module name: 作成されるベースラインプロファイルモジュールに付ける名前。
- Package name: ベースラインプロファイルモジュールに付けるパッケージ名。
- Language: 生成されるコードを Kotlin にするか Java にするか。
- Build configuration language: ビルド構成スクリプトに Kotlin スクリプト（KTS）と Groovy のどちらを使用するか。
[Finish] をクリックすると、新しいモジュールが作成されます。ソース管理を使用している場合は、新しく作成されたモジュールファイルをソース管理に追加するよう求められることがあります。

ベースラインプロファイルジェネレータを定義する

新しく作成されたモジュールには、ベースラインプロファイルの生成とベンチマークの両方を実行し、基本的なアプリの起動時間のみをテストするテストが含まれています。これらに CUJ と高度な起動ワークフローを含めることをおすすめします。生成されたベースラインプロファイルとベンチマークコードの外部で CUJ を抽象化すると、両方で使用できるため、メンテナンスが容易になります。つまり、CUJ に対する変更が常に使用されるということです。

追加する CUJ の例については、サンプル BaselineProfileGenerator.kt ファイルをご覧ください。

ベースラインプロファイルを生成してインストールする

ベースラインプロファイルモジュールテンプレートにより、新しい実行構成が追加され、ベースラインプロファイルが生成されます。プロダクトフレーバーを使用している場合、Android Studio は複数の実行構成を作成し、フレーバーごとに個別のベースラインプロファイルを生成します。

図 2. この構成を実行すると、ベースラインプロファイルが生成される。

Generate Baseline Profile 実行構成が完了すると、プロファイリングされるモジュールの src/<var>variant</var>/generated/baselineProfiles/baseline-prof.txt ファイルに、生成されたベースラインプロファイルがコピーされます。

生成されたベースラインプロファイルは build/outputs に作成されます。フルパスは、プロファイリングされるアプリのバリアントまたはフレーバーと、プロファイリングに Gradle で管理されているデバイスと接続されたデバイスのどちらを使用するかによって決まります。コードで使用された名前とテンプレートによって生成されたビルド構成を使用すると、ベースラインプロファイルが build/outputs/managed_device_android_test_additional_output/nonminifiedrelease/pixel6Api31/BaselineProfileGenerator_generate-baseline-prof.txt ファイルに作成されます。生成されたベースラインプロファイルのこのバージョンを直接操作する必要はありません。ただし、手動でターゲットモジュールにコピーする場合を除きます（非推奨）。

AGP 8.1 で新しいベースラインプロファイルを作成する

ベースラインプロファイルモジュールテンプレートを使用できない場合は、Macrobenchmark モジュールテンプレートとベースラインプロファイル Gradle プラグインを使用して、新しいベースラインプロファイルを作成します。これらのツールは、Android Studio Giraffe と AGP 8.1 以降に使用することをおすすめします。

Macrobenchmark モジュールテンプレートとベースラインプロファイル Gradle プラグインを使用して新しいベースラインプロファイルを作成する手順は次のとおりです。

Gradle プロジェクトに Macrobenchmark モジュールをセットアップします。
BaselineProfileGenerator という新しいクラスを定義します。
```
class BaselineProfileGenerator {
    @get:Rule
    val baselineProfileRule = BaselineProfileRule()

    @Test
    fun startup() = baselineProfileRule.collect(
        packageName = "com.example.app",
        profileBlock = {
            startActivityAndWait()
        }
    )
}
```
ジェネレータには、アプリの起動以外の操作を含めることができます。これにより、リストのスクロール、アニメーションの実行、Activity 内での移動など、アプリのランタイムパフォーマンスの最適化が可能となります。@BaselineProfileRule を使用してクリティカルユーザージャーニーを改善するテストについて、その他の例もご覧になれます。

ベースラインプロファイルを生成する際に圧縮を無効にします。そのためには、プロファイルの生成を行うアプリモジュール内にベンチマークビルドタイプを作成します。

Kotlin

buildTypes {
    create("benchmark") {
       // Enable all the optimizations from release.
       initWith(release)
       matchingFallbacks.add("release")
       // Debug key signing is available to everyone.
       signingConfig = signingConfigs.getByName("debug")
       isShrinkResources = false
       isMinifyEnabled = false
       // ...
    }
}

Groovy

buildTypes {
    benchmark {
       // Enable all the optimizations from release.
       initWith release
       matchingFallbacks = ["release"]
       // Debug key signing is available to everyone.
       signingConfig signingConfigs.debug
       shrinkResources false
       minifyEnabled false
       // ...
    }
}

ベースラインプロファイル Gradle プラグイン（libs.plugins.androidx.baselineprofile）を追加します。このプラグインを使用すると、ベースラインプロファイルの生成と将来のメンテナンスが容易になります。
ベースラインプロファイルを生成するには、ターミナルで Gradle タスク :app:generateBaselineProfile または :app:generateVariantBaselineProfile を実行します。

ジェネレータは、root 権限取得の実機、エミュレータ、Gradle で管理されているデバイスのいずれかでインストルメンテーションテストとして実行します。Gradle で管理されているデバイスを使用する場合は、ベースラインプロファイルジェネレータに root アクセス権が必要なため、aosp を systemImageSource に設定します。

注: Jetpack Macrobenchmark 1.2.0-alpha06 以降を使用すると、Android 13（API 33）以降を搭載しているデバイスで、root アクセス権なしでベースラインプロファイルを生成できます。

生成タスクが終了すると、ベースラインプロファイルが app/src/release/generated/baselineProfiles にコピーされます。

テンプレートなしで新しいベースラインプロファイルを作成する

Android Studio のベースラインプロファイルモジュールテンプレート（推奨）または Macrobenchmark テンプレートを使用してベースラインプロファイルを作成することをおすすめしますが、ベースラインプロファイル Gradle プラグインをお使いいただくことも可能です。ベースラインプロファイル Gradle プラグインの詳細については、ベースラインプロファイルの生成を構成するをご覧ください。

ベースラインプロファイルの Gradle プラグインを直接使用してベースラインプロファイルを作成する手順は次のとおりです。

新しい com.android.test モジュールを作成します（例: :baseline-profile）。

:baseline-profile の build.gradle.kts ファイルを構成します。

androidx.baselineprofile プラグインを適用します。
targetProjectPath が :app モジュールを参照していることを確認します。
必要に応じて、Gradle で管理されているデバイス（GMD）を追加します。以下の例では、pixel6Api31 です。指定しなかった場合、プラグインは接続されているデバイス（エミュレータまたは実機）を使用します。
次の例に示すように、必要な設定を適用します。

Kotlin

plugins {
    id("com.android.test")
    id("androidx.baselineprofile")
}

android {
    defaultConfig {
        ...
    }

    // Point to the app module, the module that you're generating the Baseline Profile for.
    targetProjectPath = ":app"
    // Configure a GMD (optional).
    testOptions.managedDevices.devices {
        pixel6Api31(com.android.build.api.dsl.ManagedVirtualDevice) {
            device = "Pixel 6"
            apiLevel = 31
            systemImageSource = "aosp"
        }
    }
}

dependencies { ... }

// Baseline Profile Gradle plugin configuration. Everything is optional. This
// example uses the GMD added earlier and disables connected devices.
baselineProfile {
    // Specifies the GMDs to run the tests on. The default is none.
    managedDevices += "pixel6Api31"
    // Enables using connected devices to generate profiles. The default is
    // `true`. When using connected devices, they must be rooted or API 33 and
    // higher.
    useConnectedDevices = false
}

Groovy

plugins {
    id 'com.android.test'
    id 'androidx.baselineprofile'
}

android {
    defaultConfig {
        ...
    }

    // Point to the app module, the module that you're generating the Baseline Profile for.
    targetProjectPath ':app'
    // Configure a GMD (optional).
    testOptions.managedDevices.devices {
        pixel6Api31(com.android.build.api.dsl.ManagedVirtualDevice) {
            device 'Pixel 6'
            apiLevel 31
            systemImageSource 'aosp'
        }
    }
}

dependencies { ... }

// Baseline Profile Gradle plugin configuration. Everything is optional. This
// example uses the GMD added earlier and disables connected devices.
baselineProfile {
    // Specifies the GMDs to run the tests on. The default is none.
    managedDevices ['pixel6Api31']
    // Enables using connected devices to generate profiles. The default is
    // `true`. When using connected devices, they must be rooted or API 33 and
    // higher.
    useConnectedDevices false
}

:baseline-profile テストモジュールでベースラインプロファイルテストを作成します。次の例は、アプリを起動してアイドル状態になるのを待つテストです。

Kotlin

class BaselineProfileGenerator {

    @get:Rule
    val baselineRule = BaselineProfileRule()

    @Test
    fun startupBaselineProfile() {
        baselineRule.collect("com.myapp") {
            startActivityAndWait()
        }
    }
}

Java

public class BaselineProfileGenerator {

    @Rule
    Public BaselineProfileRule baselineRule = new BaselineProfileRule();

    @Test
    Public void startupBaselineProfile() {
        baselineRule.collect(
            "com.myapp",
            (scope -> {
                scope.startActivityAndWait();
                Return Unit.INSTANCE;
            })
        )
    }
}

アプリモジュールの build.gradle.kts ファイルを更新します（:app など）。

プラグイン androidx.baselineprofile を適用します。
baselineProfile 依存関係を :baseline-profile モジュールに追加します。

Kotlin

plugins {
    id("com.android.application")
    id("androidx.baselineprofile")
}

android {
    // There are no changes to the `android` block.
    ...
}

dependencies {
    ...
    // Add a `baselineProfile` dependency on the `:baseline-profile` module.
    baselineProfile(project(":baseline-profile"))
}

Groovy

plugins {
    id 'com.android.application'
    id 'androidx.baselineprofile'
}

android {
    // No changes to the `android` block.
    ...
}

dependencies {
    ...
    // Add a `baselineProfile` dependency on the `:baseline-profile` module.
    baselineProfile ':baseline-profile"'
}

プロファイルを生成するには、Gradle タスク :app:generateBaselineProfile または :app:generateVariantBaselineProfile を実行します。
生成タスクが終了すると、ベースラインプロファイルが app/src/release/generated/baselineProfiles にコピーされます。

AGP 7.3～7.4 で新しいベースラインプロファイルを作成する

AGP 7.3～7.4 でベースラインプロファイルを生成することは可能ですが、ベースラインプロファイル Gradle プラグインとその最新機能を使用できるように、AGP 8.1 以降にアップグレードすることを強くおすすめします。

AGP 7.3～7.4 でベースラインプロファイルを作成する必要がある場合、以下の点を除き、AGP 8.1 の手順と同じです。

ベースラインプロファイル Gradle プラグインは追加しないでください。
ベースラインプロファイルを生成するには、Gradle タスク ./gradlew [emulator name][flavor][build type]AndroidTest を実行します（例: ./gradlew :benchmark:pixel6Api31BenchmarkAndroidTest）。
生成されたベースラインプロファイルルールをコードに手動で適用する必要があります。

生成されたルールを手動で適用する

ベースラインプロファイルジェネレータにより、人が読める形式（HRF）のテキストファイルがデバイスで作成され、ホストマシンにコピーされます。生成されたプロファイルをコードに適用する手順は次のとおりです。

プロファイルを生成したモジュールの build フォルダ（[module]/build/outputs/managed_device_android_test_additional_output/[device]）にある HRF ファイルを見つけます。

プロファイルの命名パターンは [class name]-[test method name]-baseline-prof.txt となっています（例: BaselineProfileGenerator-startup-baseline-prof.txt）。
生成されたプロファイルを特定のフレーバー用としてアプリモジュールの src/flavor/baselineProfiles にコピーします。すべてのフレーバーにこのプロファイルを適用するには、src/main/baselineProfiles にコピーします。

注: 8.0.0 より前のバージョンの Android Gradle プラグインを使用している場合は、ベースラインプロファイルファイルをアプリモジュールの src/main/ にコピーして、名前を baseline-prof.txt に変更します。
アプリの build.gradle.kts ファイルで ProfileInstaller ライブラリに依存関係を追加し、クラウドプロファイルを利用できないローカルのベースラインプロファイルのコンパイルを有効にします。これは、ベースラインプロファイルをローカルでサイドローディングする唯一の方法です。
```
dependencies {
     implementation("androidx.profileinstaller:profileinstaller:1.3.1")
}
```
アプリの製品版をビルドします。その際、適用された HRF ルールがバイナリ形式にコンパイルされて APK または AAB に追加されます。ビルドしたら、通常どおりアプリを配信します。

ベースラインプロファイルのベンチマークを行う

ベースラインプロファイルのベンチマークを行うには、StartupBenchmarks.kt または StartupBencharks.java ファイルで定義されたベンチマークを実行するガターアクションから新しい Android Instrumented Test Run 構成を作成します。ベンチマークテストの詳細については、Macrobenchmark クラスを作成すると Macrobenchmark ライブラリで測定を自動化するをご覧ください。

これを Android Studio 内で実行すると、ベースラインプロファイルから得られる速度改善の詳細がビルド出力に含まれます。

StartupBenchmarks_startupCompilationBaselineProfiles
timeToInitialDisplayMs   min 161.8,   median 178.9,   max 194.6
StartupBenchmarks_startupCompilationNone
timeToInitialDisplayMs   min 184.7,   median 196.9,   max 202.9

必要なコードパスをすべてキャプチャする

アプリの起動時間を測定するための主な 2 つの指標は次のとおりです。

最初の表示までの時間（TTID）: アプリの UI の最初のフレームを表示するのにかかる時間。
完全表示までの時間（TTFD）: TTID と、最初のフレームが表示された後に非同期で読み込まれるコンテンツを表示する時間の合計。

TTFD は、ComponentActivity の reportFullyDrawn() メソッドが呼び出されると報告されます。reportFullyDrawn() が呼び出されない場合、代わりに TTID が報告されます。reportFullyDrawn() が呼び出されるタイミングを、非同期読み込みが完了するまで遅延することが必要になる場合があります。たとえば、UI に RecyclerView や遅延リストなどの動的リストが含まれている場合、リストが最初に描画された後、つまり UI が完全に描画されたとマークされた後で完了するバックグラウンドタスクによって、データが入力される場合があります。このような場合、UI が完全に描画された状態になった後で実行されたコードは、ベースラインプロファイルに含まれません。

リストへのデータ入力をベースラインプロファイルに含めるには、getFullyDrawnReporter() を使用して FullyDrawnReporter を取得し、アプリコードでレポーターを追加します。バックグラウンドタスクでリストへのデータ入力が完了したらレポーターを解放します。すべてのレポーターが解放されるまで、FullyDrawnReporter が reportFullyDrawn() メソッドを呼び出すことはありません。こうすることで、ベースラインプロファイルにリストへのデータ入力に必要なコードパスが含まれるようになります。これにより、ユーザーにとってのアプリの動作が変わることはありませんが、ベースラインプロファイルには必要なすべてのコードパスが含まれるようになります。

アプリで Jetpack Compose を使用している場合は、以下の API を使用して完全に描画された状態を示します。

ReportDrawn は、コンポーザブルで直ちにインタラクションが発生する準備が整っていることを示します。
ReportDrawnWhen は、コンポーザブルでインタラクションの準備が整ったタイミングを示す list.count > 0 などの述語を受け取ります。
ReportDrawnAfter は、完了時にインタラクションの準備が整ったことを示す停止中のメソッドを受け取ります。

あなたへのおすすめ

注: JavaScript がオフになっている場合はリンクテキストが表示されます
Macrobenchmark の指標をキャプチャする
Macrobenchmark を作成する
JankStats ライブラリ

ベースラインプロファイルについて

ライブラリのベースラインプロファイルを作成する

ベースライン プロファイルを作成する

AGP 8.2 以降で新しいベースライン プロファイルを作成する

ベースライン プロファイル モジュールをセットアップする

ベースライン プロファイル ジェネレータを定義する

ベースライン プロファイルを生成してインストールする

AGP 8.1 で新しいベースライン プロファイルを作成する

Kotlin

Groovy

テンプレートなしで新しいベースライン プロファイルを作成する

Kotlin

Groovy

Kotlin

Java

Kotlin

Groovy

AGP 7.3～7.4 で新しいベースライン プロファイルを作成する

生成されたルールを手動で適用する

ベースライン プロファイルのベンチマークを行う

必要なコードパスをすべてキャプチャする

あなたへのおすすめ

ベースラインプロファイルを作成する

AGP 8.2 以降で新しいベースラインプロファイルを作成する

ベースラインプロファイルモジュールをセットアップする

ベースラインプロファイルジェネレータを定義する

ベースラインプロファイルを生成してインストールする

AGP 8.1 で新しいベースラインプロファイルを作成する

テンプレートなしで新しいベースラインプロファイルを作成する

AGP 7.3～7.4 で新しいベースラインプロファイルを作成する

ベースラインプロファイルのベンチマークを行う