Android Driver SDK 5.0 移行ガイド

このガイドでは、バージョン 5.0 に移行するために必要な変更について説明します。

Gradle と Android Gradle プラグインのアップデート

Gradle プラグインと Android Gradle プラグインのバージョンをアップグレードする

まず、Gradle と Android Gradle プラグインのバージョンをアップグレードします。このアップグレードでは、特定の SDK 依存関係(Kotlin 1.9 など)との互換性が向上し、いくつかの重要なバグが修正されています。

この SDK メジャー リリースでは、Android アプリ プロジェクトに次のバージョン依存関係が必要です。

  • Gradle バージョン v7.5.0 以降、v7.6.0 以下。
  • v7.4.x の範囲の Android Gradle プラグイン(AGP)バージョン。

より上位のバージョンのプラグインをターゲットにすることもできますが、非推奨の警告が表示されることや、一部の新機能が動作しないことがあります。

Gradle のバージョンを変更するには、プロジェクトの /gradle/wrapper/gradle-wrapper.properties ファイルの行を変更します。

distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-all.zip

Android Gradle プラグインのバージョンを変更するには、buildscript ブロックを含む build.gradle ファイルを変更します。次に例を示します。

buildscript {
    repositories {
        google()
        mavenCentral()
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:7.4.1'
    }
}

Java 7 から Java 8 へのライブラリ サポートの移行

ステップ 1 - Java 8 ライブラリのサポートを有効にする

ソース

SDK の最小 API レベルは 23 で、必要な AGP バージョンは 7.4 以降であるため、構成は前述のソース ドキュメントと若干異なります。

buildscript {

    repositories {
        google()
        mavenCentral()
        jcenter()
        maven {
            url = uri("https://storage.googleapis.com/r8-releases/raw")
        }
    }
    dependencies {
        classpath 'com.android.tools:r8:8.0.46'
        classpath 'com.android.tools.build:gradle:7.4.1'
    }
}

android {
    compileOptions {
        // Flag to enable support for the new language APIs
        coreLibraryDesugaringEnabled true
        // Sets Java compatibility to Java 8
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

dependencies {
    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs_nio:2.0.3'
}

ステップ 2 - Proguard または Dexguard から R8 に移行する

R8、ソース

AGP v7.4 以降では、バイナリのデフォルトの圧縮、難読化、最適化ツールとして R8 が使用されるため、この時点では特別なアクションは必要ありません。

プロジェクトを AGP 4.0 以降から移行すると、AGP からファイルの削除について次の警告が表示されることがあります。

  • build.gradle ファイルでの useProguard true の使用状況
  • gradle.properties ファイルでの android.enableR8=false の使用状況

通常、これらの行を削除すると問題が解決します。

Kotlin 1.6 から 1.9 への移行

ステップ 1 - Kotlin Gradle プラグイン 1.9.0 に移行する

ソース

アプリの最上位モジュールの build.gradle ファイルで、Kotlin Gradle プラグインのバージョンを更新します。buildscript ブロックの依存関係に org.jetbrains.kotlin:kotlin-gradle-plugin が欠落している場合に備えて、必ず追加してください。

buildscript {
  dependencies {
    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.0"
  }
}

Kotlin Gradle プラグイン 1.6.X または 1.7.X を使用している場合は、アプリを Kotlin 合成から移行する必要があります。詳しくは、公式の移行ガイドをご覧ください。

ステップ 2 - kotlin-stdlib を 1.9.0 にアップグレードする

ソース

アプリの build.gradle ファイルで kotlin-stblib を 1.9.0 にアップグレードします。

dependencies {
    implementation "org.jetbrains.kotlin:kotlin-stdlib:1.9.0"
}

kotlin-stdlib-jdk7 または kotlin-stdlib-jdk8 への参照をすべて削除してください。Kotlin 1.8.0 以降、両方の依存関係が kotlin-stdlib に統合されています。

StatusListener のサポート終了

StatusListener インターフェースは非推奨になり(v6 で削除予定)、DriverStatusListener に置き換えられました。

主な変更点は次の 3 つです。

  1. implements インターフェースを StatusListener から DriverStatusListener に変更します。
  2. Nullable cause パラメータを updateStatus に追加します。
  3. setStatusListener ではなく DriverContextBuilder.setDriverStatusListener を呼び出します。

DriverStatusListenerStatusListener と同じ構造を共有します。主な違いは、DriverStatusListener.updateStatus()cause という名前の追加パラメータを受け取る点です。これにより、ユーザーは更新の原因に関する分析情報をエラー ステータス レベルとともに得ることができます。

通常、cause を使用して、位置情報の更新に失敗した場合に Fleet Engine から返されたエラーコードを取得します。

次のサンプルは、StatusListener の実装方法を示しています。

class MyStatusListener implements StatusListener {
  /** Called when background status is updated during actions such as location reporting. */
  @Override
  public void updateStatus(
      StatusLevel statusLevel, StatusCode statusCode, String statusMsg) {
    // Implementation
  }
}

// Inject StatusListener into DriverContext.
DriverContextBuilder.setStatusListener(new MyStatusListener());

DriverStatusListener の実装例を次に示します。

class MyStatusListener implements DriverStatusListener {
  /** Called when background status is updated during actions such as location reporting. */
  @Override
  public void updateStatus(
      StatusLevel statusLevel, StatusCode statusCode, String statusMsg, @Nullable Throwable cause) {
    // Existing implementation

    if (cause != null && cause instanceof StatusRuntimeException) {
      if (Status.NOT_FOUND.getCode().equals(cause.getStatus().getCode())) {
        // NOT_FOUND gRPC exception thrown by Fleet Engine.
      }
    }
  }
}

DriverContextBuilder.setStatusListener(new MyStatusListener());

DriverStatusListener を関数インターフェースとして実装する

DriverStatusListener は、前身と同様に Java 関数インターフェースをサポートしています。次に例を示します。

DriverContextBuilder.setDriverStatusListener((statusLevel, statusCode, statusMsg, cause) -> {
  if (cause != null && cause instanceof StatusRuntimeException) {
    if (Status.NOT_FOUND.getCode().equals(cause.getStatus().getCode())) {
      // NOT_FOUND gRPC exception thrown by Fleet Engine.
    }
  }
});