Android Consumer SDK 3.0 移行ガイド

Kotlin 2.0 に移行する

Consumer SDK for Android 3.0 以降を使用している場合は、Kotlin 2.0 にアップグレードする必要があります。このページでは、新しい Kotlin バージョンへの移行を容易にするためのガイダンスを提供します。

Gradle と AGP の互換性

Kotlin 2.0 には、Gradle と Android Gradle プラグイン（AGP）のバージョンに関する最小バージョンと最大バージョンの要件があります。プロジェクトが Kotlin 2.0 の要件を満たしていることを確認します。

Consumer SDK 3.0 以降に必要な AGP の最小バージョン

Consumer SDK 3.0 には AGP 7.3 以降が必要です。

フル R8 モード

Consumer SDK v3 以前は、完全な R8 モードをサポートしていません。アプリが AGP 8.0 以降をターゲットとしている場合は、フル R8 モードを明示的に無効にする必要があります。

# settings.gradle
android.enableR8.fullMode=false

Kotlin バージョンの互換性

Kotlin は、以前の 3 つの言語バージョンとの下位互換性をサポートしています。つまり、Consumer SDK で Kotlin 1.7 以降をすでに使用している場合は、互換性を破る変更をすべて解決しなくても、Kotlin 2.0 にアップグレードできます。ただし、Kotlin の互換性は安定版の言語機能にのみ適用されます。Kotlin 言語のアルファ版、ベータ版、試験運用版の機能を使用している場合は、アップグレード時に追加の変更が必要になることがあります。

Kotlin 互換性フラグ

前のセクションで説明したように、Kotlin はアップグレード時に最大 3 つ前のバージョンの言語をサポートします。Kotlin には、互換性を破る変更を制限するのに役立つ 2 つのフラグが用意されています。

language-version X.Y

このフラグは、以前の Kotlin バージョンの動作に対する互換性を破る変更を元に戻します。 たとえば、Kotlin 1.7 を使用している場合は、[ - language-version 1.7] を指定すると、新しい互換性を破る変更は有効になりません。

android {
   kotlinOptions {
       languageVersion = '1.7'
   }
}
api-version X.Y

このフラグにより、依存するダウンストリーム コードが Kotlin 2.0 を組み込む準備が整う前に、新しい API が使用されるのを防ぐことができます。

android {
   kotlinOptions {
       apiVersion = '1.7'
   }
}

よりターゲットを絞ったアプローチ

Kotlin 互換性フラグを使用するだけでなく、Kotlin のリリースノートを確認し、アップグレード元のバージョンから保持する動作を選択することをおすすめします。Kotlin の各バージョンの互換性ガイドには、互換性を破る変更のリストと、元の動作を維持するために設定できるフラグが記載されています。