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

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

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

Macrobenchmark ライブラリを使用してベースラインプロファイルを作成する手順は、次のとおりです。

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

    @Test
    fun startup() = baselineProfileRule.collectBaselineProfile(
        packageName = "com.example.app",
        profileBlock = {
            startActivityAndWait()
        }
    )
}
```
ジェネレータには、アプリの起動以外の操作を含めることができます。これにより、リストのスクロール、アニメーションの実行、Activity 内での移動など、アプリのランタイムパフォーマンスの最適化が可能となります。@BaselineProfileRule を使用してクリティカルユーザージャーニーを改善するテストについて、その他の例もご覧になれます。
（省略可）ベースラインプロファイルを生成する際に難読化を無効にします。そのためには、アプリモジュールで別の ProGuard ファイルを作成し、プロファイルの生成を担当する benchmark ビルドタイプに対してのみ、-dontobfuscate を追加します。

Kotlin

buildTypes {
    val benchmark by creating {
        // Only use benchmark Proguard rules.
        proguardFiles("benchmark-rules.pro")
        // ...
    }
}

Groovy

buildTypes {
    benchmark {
        // Only use benchmark Proguard rules.
        proguardFiles 'benchmark-rules.pro'
        // ...
    }
}

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

ジェネレータは、root 権限取得済みの実機、エミュレータ、Gradle で管理されているデバイスのいずれかで、インストルメンテーションテストとして実行します。管理されているデバイスをセットアップするには、build.gradle.kts ファイルを開きます。testOptions 構成ブロックに managedDevices と devices を追加して、エミュレータの定義を作成します。ベースラインプロファイルジェネレータには root 権限が必要であるため、aosp を systemImageSource として使用します。

Kotlin

testOptions {
    managedDevices {
        devices {
            create ("pixel6Api31", ManagedVirtualDevice::class) {
                device = "Pixel 6"
                apiLevel = 31
                systemImageSource = "aosp"
            }
        }
    }
}

Groovy

testOptions {
    managedDevices {
        devices {
            pixel6Api31(com.android.build.api.dsl.ManagedVirtualDevice) {
                device = "Pixel 6"
                apiLevel = 31
                systemImageSource = "aosp"
            }
        }
    }
}

Gradle により、指定したデバイス名とモジュールで利用可能なビルドバリアントに基づいて、必要なタスクが作成されます。形式は [emulator_name][flavor][build type]AndroidTest です。このタスクは、次のようなターミナルから実行できます。

./gradlew :benchmark:pixel6Api31BenchmarkAndroidTest

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

アプリの起動時間を測定するための主な 2 つの指標は、初期表示までの時間（TTID）と完全表示までの時間（TTFD）です。TTID は、アプリの UI の最初のフレームを表示するのにかかる時間です。TTFD には、最初のフレームが表示された後に非同期で読み込まれるコンテンツを表示する時間も含まれます。

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

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

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

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

ベースラインプロファイル Gradle プラグイン

ベースラインプロファイル Gradle プラグインを使用すると、ベースラインプロファイルの生成とメンテナンスが容易になります。このプラグインは、ベースラインプロファイルを生成して、アプリモジュールにインストールするために必要な手順を実行します。

このプラグインを使用するには、プロジェクトにインストルメンテーションテストモジュールを追加し、アプリを操作してクリティカルユーザージャーニーをシミュレートする一連のテストを定義します。インストルメンテーションテストを実行すると、ベースラインプロファイル Gradle プラグインが、このようなユーザージャーニーの間に実行されたすべてのクラスとメソッドを追跡し、それらのクラスとメソッドに基づいてベースラインプロファイルを生成します。そして、生成されたベースラインプロファイルをアプリモジュールにコピーします。

インストルメンテーションテストモジュールが、プロファイルプロデューサーです。アプリモジュールは、プロファイルコンシューマです。

力を注ぐべき主な領域は、初期セットアップと、クリティカルユーザージャーニーをシミュレートするためのテストの作成です。

プラグインの使用に必要なもの

AGP 8.0.0 以降
最新の Gradle プラグインバージョン（alpha13 以上）の依存関係

プラグインを使用する

以下の例では、:app という名前のアプリモジュールが存在することを前提としています。

以下の例では、2 つのモジュールを使用しています。

プロファイルコンシューマ: プロファイルの生成対象となるアプリモジュール。以下の例では、:app です。
プロファイルプロデューサー: プロファイルを生成するためのインストルメンテーションテストを含むベースラインプロファイルテストモジュール。以下の例では、:baseline-profile という名前になっています。

このプラグインを使用する手順は以下のとおりです。

新しい com.android.test モジュールを作成します（例: :baseline-profile）。
:baseline-profile 向けに build.gradle を設定します。

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

Kotlin

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

android {

    // There are no changes here. It's documented for completeness.
    defaultConfig {
        ...
    }

    // This must point to the app module.
    targetProjectPath = ":app"

    // This is the optional managed device.
    testOptions.managedDevices.devices {
        pixel6Api31(com.android.build.api.dsl.ManagedVirtualDevice) {
            device = "Pixel 6"
            apiLevel = 31
            systemImageSource = "aosp"
        }
    }
}

// There are no changes here. It's documented for completeness.
dependencies { ... }

// This is the plugin configuration. Everything is optional. Defaults are in the
// comments. In this example, you use the GMD added earlier and disable
// connected devices.
baselineProfile {

    // This specifies the managed devices to use that you run the tests on. The
    // default is none.
    managedDevices += "pixel6Api31"

    // This 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 {

    // There are no changes here. It's documented for completeness.
    defaultConfig {
        ...
    }

    // This must point to the app module.
    targetProjectPath ':app'

    // This is the optional managed device.
    testOptions.managedDevices.devices {
        pixel6Api31(com.android.build.api.dsl.ManagedVirtualDevice) {
            device 'Pixel 6'
            apiLevel 31
            systemImageSource 'aosp'
        }
    }
}

    // There are no changes here. It's documented for completeness.
dependencies { ... }

// This is the plugin configuration. Everything is optional. Defaults are in the
// comments. In this example, you use the GMD added earlier and disable
// connected devices.
baselineProfile {

    // This specifies the managed devices to use that you run the tests on. The
    // default is none.
    managedDevices ['pixel6Api31']

    // This 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.collectBaselineProfile("com.myapp") {
            startActivityAndWait()
        }
    }
}

Java

public class BaselineProfileGenerator {

    @Rule
    Public BaselineProfileRule baselineRule = new BaselineProfileRule();

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

アプリモジュール :app の build.gradle の設定を更新します。

プラグイン 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 to 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 to the :baseline-profile module.
    baselineProfile ':baseline-profile"'
}

コード「./gradlew :app:generateBaselineProfile」を実行してプロファイルを生成します。

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

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

以下の例では、ライブラリモジュールの名前が :library で、ライブラリを利用するアプリが含まれているアプリモジュールの名前が :sample-app です。

この例では、3 つのモジュールが必要です。

アプリターゲット: サンプルアプリを含むアプリモジュール。以下の例では、:sample-app です。
プロファイルコンシューマ: プロファイルの生成対象となるライブラリモジュール。以下の例では、:library です。
プロファイルプロデューサー: モジュールを生成するためのインストルメンテーションテストを含むベースラインプロファイルテストモジュール。

ライブラリのベースラインプロファイルを生成する手順は次のとおりです。

新しい com.android.test モジュールを作成します（例: :baseline-profile）。
:baseline-profile 向けに build.gradle を設定します。

androidx.baselineprofile プラグインを適用します。
targetProjectPath が :sample-app モジュールを参照していることを確認します。
必要に応じて、GMD を追加します。以下の例では、pixel6Api31 です。
次の例に示すように、必要な設定を適用します。

Kotlin

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

android {

    // There are no changes here. It's reported for completeness.
    defaultConfig {
        minSdkVersion 23
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }

    // This must point to the app module.
    targetProjectPath = ":app"

    // This is the optional managed device.
    testOptions.managedDevices.devices {
        create("pixel6Api31") {
            device = "Pixel 6"
            apiLevel = 31
            systemImageSource = "aosp"
        }
    }
}

// There's nothing to change here.
dependencies { ... }

// This is the plugin configuration. Everything is optional. Defaults are in the
// comments. In this example, you use the GMD added earlier and disable
// connected devices.
baselineProfile {

    // This specifies the managed devices to use that you run the tests on. The
    // default is none.
    managedDevices += "pixel6Api31"

    // This 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 {

    // There are no changes here. It's reported for completeness.
    defaultConfig {
        ...
    }

    // This must point to the app module.
    targetProjectPath ':app'

    // This is the optional managed device.
    testOptions.managedDevices.devices {
        pixel6Api31(com.android.build.api.dsl.ManagedVirtualDevice) {
            device 'Pixel 6'
            apiLevel 31
            systemImageSource 'aosp'
        }
    }
}

// There's nothing to change here.
dependencies { ... }

// This is the plugin configuration. Everything is optional. Defaults are in the
// comments. In this example, you use the GMD added earlier and disable
// connected devices.
baselineProfile {

    // This specifies the managed devices to use that you run the tests on. The
    // default is none.
    managedDevices ['pixel6Api31']

    // This 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 テストモジュールでベースラインプロファイルテストを作成します。サンプルアプリに固有のもので、ライブラリのすべての機能を使用する必要があります。
ライブラリモジュール :library の build.gradle の設定を更新します。

プラグイン androidx.baselineprofile を適用します。
baselineProfile 依存関係を :baseline-profile モジュールに追加します。
次の例に示すように、必要なコンシューマプラグイン設定を適用します。

Kotlin

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

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

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

// This is the plugin configuration.
baselineProfile {

    // This filters the generated profile rules. In this example, you keep
    // all the classes in com.library and in all the subpackages.
    filter {
        include "com.mylibrary.**"
    }
}

Groovy

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

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

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

// This is the plugin configuration.
baselineProfile {

    // This filters the generated profile rules. In this example, you keep
    // all the classes in com.library and in all the subpackages.
    filter {
        include 'com.mylibrary.**'
    }
}

アプリモジュール :sample-app の build.gradle の設定を更新し、androidx.baselineprofile プラグインを追加します。

Kotlin

plugins {
    ...
    id("androidx.baselineprofile")
}
// There are no other changes to the configuration.

Groovy

plugins {
    ...
    id 'androidx.baselineprofile'
}
// There are no other changes to the configuration.

コード「./gradlew :library:generateBaselineProfile」を実行してプロファイルを生成します。

生成タスクが終了すると、ベースラインプロファイルが library/src/main/generated/baselineProfiles に格納されます。

DSL

このドキュメントでは、ベースラインプロファイル Gradle プラグインを 1 つのプラグインとして参照していますが、実際には、どのモジュールに適用されるかに応じて異なるタスクを実行する 3 つのプラグインがあります。このドキュメントのプラグイン ID は androidx.baselineprofile であり、3 つのプラグインのショートカットになっています。

このコンセプトを深く理解するには、ベースラインプロファイルの生成に必要な次のモジュールを確認してください。

ベースラインプロファイルテストの実行対象とするアプリ。これは、com.android.application が適用された Android アプリモジュールです。ライブラリのプロファイルを生成する場合は、サンプルアプリの可能性があります。アプリのプロファイルを生成する場合は、アプリ自体です。以下の例では、androidx.baselineprofile プラグインが androidx.baselineprofile.apptarget を内部的に適用しています。
実行するテストを含むベースラインプロファイルのテストモジュール。これは、com.android.test が適用された Android テストモジュールです。以下の例では、androidx.baselineprofile プラグインが androidx.baselineprofile.producer を内部的に適用しています。
ビルドプロセスで最終的にベースラインプロファイルを使用するモジュール。これは、Android アプリ com.android.application のモジュール、またはライブラリ com.android.library モジュールです。以下の例では、androidx.baselineprofile プラグインが androidx.baselineprofile.consumer を内部的に適用しています。

アプリターゲット（androidx.baselineprofile.apptarget）

これには設定がありません。

プロファイルプロデューサー（androidx.baselineprofile.producer）

Gradle で管理されているデバイスのサポート

Gradle で管理されているデバイスを使用するには、プロファイルプロデューサーモジュールの build.gradle 設定に追加します。次の例をご覧ください。

Kotlin

android {
   testOptions.managedDevices.devices {
       create("pixel6Api31") {
           device = "Pixel 6"
           apiLevel = 31
           systemImageSource = "aosp"
       }
   }
}

Groovy

android {
   testOptions.managedDevices.devices {
       pixel6Api31(ManagedVirtualDevice) {
           device 'Pixel 6'
           apiLevel = 31
           systemImageSource 'aosp'
       }
   }
}

作成された GMD に以下を追加すると、それを使用してベースラインプロファイルを生成できます。

Kotlin

baselineProfile {
    managedDevices += "pixel6Api31"
}

Groovy

baselineProfile {
    managedDevices = ['pixel6Api31']
}

次の例は、接続されているデバイスを有効または無効にして、ベースラインプロファイルを生成する追加のオプションです。

Kotlin

baselineProfile {
    ...
    useConnectedDevices = true
}

Groovy

baselineProfile {
    ...
    useConnectedDevices true
}

プロファイルコンシューマ（androidx.baselineprofile.consumer）

フレーバーごとのプロファイルと、すべてのバリアントに対する 1 つのプロファイルを生成する

バリアントごと、フレーバーごと、またはすべてのバリアントで使用する 1 つのファイルとして、プロファイルを生成できます。この動作は、次の例に示すように、マージ設定で制御できます。

Kotlin

baselineProfile {
    mergeIntoMain = true / false
}

Groovy

baselineProfile {
    mergeIntoMain true / false
}

mergeIntoMain を true に設定すると、各バリアント用に生成されるすべてのプロファイルが 1 つのプロファイルにマージされます。この設定が true の場合、バリアントごとのベースラインプロファイルを生成できないため、generateBaselineProfile という名前の単一の生成タスクのみが存在します。プロファイル出力は src/main/generated/baselineProfiles です。
mergeIntoMain を false に設定すると、マージが無効になり、バリアントごとに 1 つのプロファイルとなります。以下の例では、バリアントごとのベースラインプロファイルを生成できるので、複数の生成タスク（バリアントごとに 1 つ）が存在します。たとえば、2 つのフレーバー（無料と有料など）があり、リリースビルドタイプが 1 つの場合、生成されるタスクは次のものになります。
- generateFreeReleaseBaselineProfile
- generatePaidReleaseBaselineProfile
- generateReleaseBaselineProfile

デフォルトで、この設定はライブラリでは true に、アプリでは false に設定されています。

この動作をバリアントごとに指定することもできます。

Kotlin

baselineProfile {
    variants {
        freeRelease {
            mergeIntoMain = true / false
        }
    }
}

Groovy

baselineProfile {
    variants {
        freeRelease {
            mergeIntoMain true / false
        }
    }
}

上記の例では、フラグが true に設定されているバリアントはすべて src/main/generated/baselineProfiles にマージされ、フラグが false に設定されているバリアントのプロファイルはフォルダ src/<variant>/generated/baselineProfiles に保持されます。

新しいリリースのアセンブル時にベースラインプロファイルを自動生成する

タスク generateBaselineProfile でベースラインプロファイルの生成を手動でトリガーすることも、リリースをビルドするときに自動でトリガーすることもできます。これは次のフラグによって制御されます。

Kotlin

baselineProfile {
    automaticallyGenerateDuringBuild = true / false
}

Groovy

baselineProfile {
    automaticallyGenerateDuringBuild true / false
}

このフラグを true に設定すると、アセンブルごとに新しいベースラインプロファイルの生成がトリガーされます。これにより、最新のプロファイルがビルドに含められます。つまり、アセンブルリリースビルドタスク（./gradlew:app:assembleRelease など）を実行すると :app:generateReleaseBaselineProfile もトリガーされます。また、これによってベースラインプロファイルのインストルメンテーションテストが開始され、その実行対象となるベースラインプロファイルビルドがビルドされます。こうすることで、ユーザーが得られるパフォーマンス上のメリットは最大となりますが、ビルドとインストルメンテーションテストが二重になるため、ビルド時間も長くなります。

次の例に示すように、この動作をバリアントごとに指定することもできます。

Kotlin

baselineProfile {
    variants {
        freeRelease {
            automaticallyGenerateDuringBuild = true / false
        }
    }
}

Groovy

baselineProfile {
    variants {
        freeRelease {
            automaticallyGenerateDuringBuild true / false
        }
    }
}

上記の例では、assembleFreeRelease の開始時にタスク generateFreeReleaseBaselineProfile が実行されます。これは、ビルド時に常にプロファイルを生成する配布ビルド用の release や、内部テスト用の releaseWithoutProfile ビルドなどをユーザーが必要としている場合に役立ちます。

ベースラインプロファイルをソースに保存する

saveInSrc フラグを使用すると、ベースラインプロファイルをソースディレクトリに格納できます。

true: ベースラインプロファイルは src/<variant>/generated/baselineProfiles に保存されます。これにより、最後に生成されたプロファイルをソースに commit できます。
false: ベースラインプロファイルは、ビルドディレクトリにある中間ファイルに保存されます。こうすると、コードを commit するときに、生成された最新のプロファイルは保存されません。

Kotlin

baselineProfile {
    saveInSrc = true / false
}

Groovy

baselineProfile {
    saveInSrc true / false
}

この動作をバリアントごとに指定することもできます。

Kotlin

baselineProfile {
    variants {
        freeRelease {
            saveInSrc = true / false
        }
    }
}

Groovy

baselineProfile {
    variants {
        freeRelease {
            saveInSrc true / false
        }
    }
}

プロファイルルールをフィルタする

プラグイン設定で生成されたベースラインプロファイルルールをフィルタできます。特に、サンプルアプリやライブラリ自体の依存関係に含まれているクラスやメソッドでプロファイルルールを除外する場合に便利です。フィルタでは、パッケージとクラスで指定、包含、除外できます。除外のみを指定した場合、一致するベースラインプロファイルルールのみが除外され、その他はすべて包含されます。

フィルタ指定は次のいずれかです。

指定されたパッケージとすべてのサブパッケージと一致する、末尾が二重のワイルドカードのパッケージ名。たとえば、com.example.** は com.example.foo および com.example.foo.bar と一致します。
指定されたパッケージのみに一致する、末尾がワイルドカードのパッケージ名。たとえば、com.example.* は com.example.foo と一致しますが、com.example.foo.bar とは一致しません。
特定のクラスと一致するクラス名（例: com.example.MyClass）。

次の例は、特定のパッケージを包含または除外する方法を示しています。

Kotlin

baselineProfile {
    filter {
        include("com.somelibrary.widget.grid.**")
        exclude("com.somelibrary.widget.grid.debug.**")
        include("com.somelibrary.widget.list.**")
        exclude("com.somelibrary.widget.list.debug.**")
        include("com.somelibrary.widget.text.**")
        exclude("com.somelibrary.widget.text.debug.**")
    }
}

Groovy

baselineProfile {
    filter {
        include 'com.somelibrary.widget.grid.**'
        exclude 'com.somelibrary.widget.grid.debug.**'
        include 'com.somelibrary.widget.list.**'
        exclude 'com.somelibrary.widget.list.debug.**'
        include 'com.somelibrary.widget.text.**'
        exclude 'com.somelibrary.widget.text.debug.**'
    }
}

フィルタではバリアントもサポートされるため、次のような表現も可能です。

Kotlin

// Non-specific filters applied to all the variants.
baselineProfile {
    filter { include("com.myapp.**") }
}

// Flavor-specific filters.
baselineProfile {
    variants {
        free {
            filter {
                include("com.myapp.free.**")
            }
        }
        paid {
            filter {
                include("com.myapp.paid.**")
            }
        }
    }
}

// Build-type-specific filters.
baselineProfile {
    variants {
        release {
            filter {
                include("com.myapp.**")
            }
        }
    }
}

// Variant-specific filters.
baselineProfile {
    variants {
        freeRelease {
            filter {
                include("com.myapp.**")
            }
        }
    }
}

Groovy

// Non-specific filters applied to all the variants.
baselineProfile {
    filter { include 'com.myapp.**' }
}

// Flavor-specific filters.
baselineProfile {
    variants {
        free {
            filter {
                include 'com.myapp.free.**'
            }
        }
        paid {
            filter {
                include 'com.myapp.paid.**'
            }
        }
    }
}

// Build-type specific filters.
baselineProfile {
    variants {
        release {
            filter {
                include 'com.myapp.**'
            }
        }
    }
}

// Variant-specific filters.
baselineProfile {
    variants {
        freeRelease {
            filter {
                include 'com.myapp.**'
            }
        }
    }
}

生成したルールを適用する

ベースラインプロファイルジェネレータにより、人が読める形式（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 に追加されます。ビルドしたら、通常どおりアプリを配信します。

その他の注意事項

ベースラインプロファイルを作成する際は、次の点にもご注意ください。

コンパイル済みのベースラインプロファイルは、1.5 MB 未満でなければなりません。これは、コンパイルの前よりもはるかに大きいことが一般的であるソースファイル内のテキスト形式には適用されません。バイナリ形式のベースラインプロファイルのサイズを、assets/dexopt/baseline.prof（APK の場合）または BUNDLE-METADATA/com.android.tools.build.profiles/baseline.prof（AAB の場合）の出力アーティファクトで確認してください。

ヒント: Android Studio Flamingo（2022.2.1）以降では、APK Analyzer でサイズを確認します。
アプリのコンパイルが多すぎる広範なルールでは、ディスクアクセスの増加により起動が遅くなる可能性があります。ベースラインプロファイルを使い始めたばかりの場合は、心配する必要はありません。ただし、ジャーニーを多数追加した場合、アプリやジャーニーのサイズと数によっては、最適なパフォーマンスを得られなくなることもあります。別のプロファイルを試してアプリのパフォーマンスをテストし、追加によってパフォーマンスが退行しないことを確認してください。

Codelabs

Macrobenchmark を使用してアプリのパフォーマンスを調査する

パフォーマンスを測定するための Macrobenchmark について詳しく見てみましょう。

詳細

ベースラインプロファイルを使用してアプリのパフォーマンスを改善する

Android アプリに合わせたカスタムベースラインプロファイルを生成して、その効果を検証します。

詳細

About Baseline Profiles

Measure with Macrobenchmark library

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

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

Kotlin

Groovy

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

Kotlin

Groovy

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

ベースライン プロファイル Gradle プラグイン

プラグインの使用に必要なもの

プラグインを使用する

Kotlin

Groovy

Kotlin

Java

Kotlin

Groovy

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

Kotlin

Groovy

Kotlin

Groovy

Kotlin

Groovy

DSL

アプリ ターゲット（androidx.baselineprofile.apptarget）

プロファイル プロデューサー（androidx.baselineprofile.producer）

Gradle で管理されているデバイスのサポート

Kotlin

Groovy

Kotlin

Groovy

Kotlin

Groovy

プロファイル コンシューマ（androidx.baselineprofile.consumer）

フレーバーごとのプロファイルと、すべてのバリアントに対する 1 つのプロファイルを生成する

Kotlin

Groovy

Kotlin

Groovy

新しいリリースのアセンブル時にベースライン プロファイルを自動生成する

Kotlin

Groovy

Kotlin

Groovy

ベースライン プロファイルをソースに保存する

Kotlin

Groovy

Kotlin

Groovy

プロファイル ルールをフィルタする

Kotlin

Groovy

Kotlin

Groovy

生成したルールを適用する

その他の注意事項

Codelabs

Macrobenchmark を使用してアプリのパフォーマンスを調査する

ベースライン プロファイルを使用してアプリのパフォーマンスを改善する

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

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

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

ベースラインプロファイル Gradle プラグイン

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

アプリターゲット（androidx.baselineprofile.apptarget）

プロファイルプロデューサー（androidx.baselineprofile.producer）

プロファイルコンシューマ（androidx.baselineprofile.consumer）

新しいリリースのアセンブル時にベースラインプロファイルを自動生成する

ベースラインプロファイルをソースに保存する

プロファイルルールをフィルタする

ベースラインプロファイルを使用してアプリのパフォーマンスを改善する