Flutter 3.19(3.16)に上げるときに困ったこと

2024年2月16日にFlutter3.19がリリースされました。[What's new]
メイントピックはGemini AI SDKかなと思うのですが、個人的に気になっているのはスクロールの改善などのImpelerによるパフォーマンスの向上です。
他にも実装が面倒なDeep linkを簡単に実装できるようになるDeepLinking web validatorや、iOSのネイティブフォントが適用されるようになった点、Adaptive Switchが追加されて、iOSネイティブと同じUIが簡単に実装できるようになっていっているのは良い流れかなと思います。

早速Flutterをアップデートしていきたかったのですが、使っているライブラリの関係で現在開発しているプロジェクトがFlutter3.13.xのまま上げられておらず、3.19がでたタイミングで一気にあげようとしたときに詰まったことをメモしていきます。 (そのため3.16へのmigrationも含まれます)

Gradleの書き換え

Flutter 3.16からGradleの plugins{} ブロックでプラグインを適用できるようになり、現在ではむしろpluginsを使う方法が推奨されています。
そのため、Flutter 3.16以前に作られたプロジェクトの場合はGradleの書き方を結構変える必要があります。
さらに、Android Studioのバージョンも上がっていき、AGP(Android Gradle Plugin)のバージョンも上げる必要が出てきます。そのため、AGP8に上げるための準備もしていきます。

AGP 8.x

現在の最新はAGP8.3になります。実際はそこまで上げなくても動きますが、この際一気に変える方がいいと思います。 AGPのアップデートに伴いJDKの最小バージョンが17に変わっています。そうなってくると、Gradleのバージョンも上げる必要がでてきて、Kotlinのバージョンも上げる必要があります。
このように連鎖的にアップデートが必要になるので結構大変でした。
AGPバージョンによる組み合わせはこちら(Compatibility) に書いてあります。

Kotlinは最新バージョンでなくても(1.9.x以上なら)動作しますが今回は1.9.22にしました。

Gradle

Gradleはかなり書き方が変わっています。
正直書き換えるとミスる可能性もあるので、Flutterの最新バージョンでflutter createしたサンプルプロジェクトのGradleをそのまま参考にするのが一番楽です。

/android/settings.gradle

それぞれ書き換えていきます。
まずは /android/settings.gradle です。

pluginManagement {
    def flutterSdkPath = {
        def properties = new Properties()
        file("local.properties").withInputStream { properties.load(it) }
        def flutterSdkPath = properties.getProperty("flutter.sdk")
        assert flutterSdkPath != null, "flutter.sdk not set in local.properties"
        return flutterSdkPath
    }
    settings.ext.flutterSdkPath = flutterSdkPath()

    includeBuild("${settings.ext.flutterSdkPath}/packages/flutter_tools/gradle")

    repositories {
        google()
        mavenCentral()
        gradlePluginPortal()
    }
}

plugins {
    id "dev.flutter.flutter-plugin-loader" version "1.0.0"
    id "com.android.application" version "8.3.0" apply false
    id "org.jetbrains.kotlin.android" version "1.9.22" apply false
}

include ":app"

/android/build.gradle


allprojects {
    repositories {
        google()
        mavenCentral()
    }
}

rootProject.buildDir = '../build'
subprojects {
    project.buildDir = "${rootProject.buildDir}/${project.name}"
}
subprojects {
    project.evaluationDependsOn(':app')
}

tasks.register("clean", Delete) {
    delete rootProject.buildDir
}

/android/app/build.gradle

plugins {
    id "com.android.application"
    id "kotlin-android"
    id "dev.flutter.flutter-gradle-plugin"
}

def localProperties = new Properties()
def localPropertiesFile = rootProject.file('local.properties')
if (localPropertiesFile.exists()) {
    localPropertiesFile.withReader('UTF-8') { reader ->
        localProperties.load(reader)
    }
}

def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
if (flutterVersionCode == null) {
    flutterVersionCode = '1'
}

def flutterVersionName = localProperties.getProperty('flutter.versionName')
if (flutterVersionName == null) {
    flutterVersionName = '1.0'
}

android {
    namespace "com.example.hoge"
    compileSdk flutter.compileSdkVersion
    ndkVersion flutter.ndkVersion

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }

    kotlinOptions {
        jvmTarget = '1.8'
    }

    sourceSets {
        main.java.srcDirs += 'src/main/kotlin'
    }

    defaultConfig {
        applicationId "com.example.hoge"

        minSdkVersion flutter.minSdkVersion
        targetSdkVersion flutter.targetSdkVersion
        versionCode flutterVersionCode.toInteger()
        versionName flutterVersionName
    }

    buildTypes {
        release {
            signingConfig signingConfigs.debug
        }
    }
}

flutter {
    source '../..'
}

dependencies {}

gradle-wrapper.properties

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

新しく作ったプロジェクトはデフォルトでJava versionが18になっていますが、今回のAGPのアップデートで最低17になっています。
既存プロジェクトのアップデートでJava versionが指定されていない場合はビルドできないので気をつけましょう。

BuildConfig

android.defaults.buildfeatures.buildconfig がデフォルトでfalseになっています。

trueにしたい場合はgradle.propertiesに上記をtrueで書くかbuild.gradleに以下を記述する必要があります。

android {
  buildFeatures {
    buildConfig true
  }
}

R

nonTransitiveRClassがtrueになっています。
要するにRが他のモジュールを参照しなくなっています。
困る場合はfalseにで回避はできますが、パフォーマンスの問題があるため完全修飾名で参照するなどして回避する方をおすすめします。

ライブラリ対応

AGP7の頃から警告は出ていましたが、8からはnamespaceの対応が必須になっています。
Manifestファイルにかいてあるpackageの部分は削除して、Gradle側に namespace を追加しましよう。


...

android {
  namespace "com.example.app"

  sourceSets {
    ...
  }

...

}

ちなみにこのnamespaceがかなり厄介で、依存しているライブラリがnamespaceに対応していないとFlutter自体のアップデートができません。

著名なリポジトリはだいたい対応がされているのですが、あまりメンテされていないリポジトリだと対応されていないため、自分でForkして使う必要があるので注意しましょう。
IssueやPull Requestに誰かが対応しているリポジトリがあったりするのでそれを使うのでも良いと思いますが、セキュリティやライセンスには注意しましょう。

PopScopeの変更

3.16からですが、WillPopScopeがDeprecatedになってPopScopeに変わりました。
細かい変更はこちらのドキュメントを参考にしてください。
色々な画面でハンドリングしていたので、結構面倒でした。😇

参考) https://docs.flutter.dev/release/breaking-changes/android-predictive-back

まとめ

プロジェクトによっては足りないかもしれませんが、直近2回分のFlutterアップデートで対応したことリストになります。

pubspecはシンプルな仕組みですが、Gradleなどに比べると依存解決の仕方があまりうまくないなという印象があります。
放置したFlutterアップデートは地味に大変なので、サボらず都度上げるように心がけましょう。

February 29, 2024