Adds support for generating projects that use AndroidX support libraries #31028

josh-burton · 2019-04-14T05:01:19Z

Description

This PR modifies the Flutter tool with support for generating projects that use AndroidX support libraries rather than the legacy support library.

This is a source of pain in Flutter development and now that AndroidX is 1.0 all new Flutter projects should be using it.

Projects generated with AndroidX libraries also use Jetifier which allows any dependencies (e.g. plugins) that still use the legacy support libraries to be upgrade to use AndroidX.

With this change, the flutter tool has the following changes:

Adds an --androidx flag when creating flutter projects. This is disabled by default, and can be enabled via --androidx
Adds a new androidX property under the module section of a pubspec.yaml file. This is to control whether the generated module project uses AndroidX.
e.g.

flutter:
  uses-material-design: true

  module:
    androidX: true
    androidPackage:
    iosBundleIdentifier:

Related Issues

Generated Flutter Module Files Do Not Use AndroidX #28805

Tests

create_test.dart/androidx app project
create_test.dart/non androidx app project
create_test.dart/androidx plugin project
create_test.dart/non androidx plugin project

Checklist

I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
I signed the [CLA].
I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
I updated/added relevant documentation (doc comments with ///).
All existing and new tests are passing.
The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require Flutter developers to manually update their apps to accommodate your change?

Yes, this is a breaking change (Please read [Handling breaking changes]). Replace this with a link to the e-mail where you asked for input on this proposed change.
No, this is not a breaking change.

jiechic · 2019-05-06T00:29:31Z

Why haven't merged yet?
Is it necessary use support library by default and Optional androidx support before code merge?

josh-burton · 2019-05-06T00:46:04Z

@dnfield I've seen you comment about AndroidX support a few other places. Is it possible this PR may be merged or is there other internal work happening around it?

jiechic · 2019-05-22T09:14:05Z

Why should this PR not be merged?

josh-burton · 2019-05-22T09:40:11Z

@matthew-carroll would you be the right person to review this?

matthew-carroll · 2019-05-23T23:47:51Z

@xster you're probably in the best position to make a call on this particular solution.

xster · 2019-05-26T00:45:50Z

Thanks for your contribution @athornz

@dnfield @mklim, could you guys take a pass at this?

I'm out for a week. I'll check this wrt add-to-app when I'm back.

dnfield · 2019-05-30T05:47:09Z

Thanks for the contribution!

We've had a number of issues with jetifier not working with our current gradle setup. I'm a bit curious about how this impacts that - are you able to consume a plugin that uses the support libraries with this project structure successfully?

My main concern here is that it's not clear what benefit this really offers to someone developing a Flutter app at this point - unless it's helping with that issue.

josh-burton · 2019-05-30T06:05:33Z

Hey Dan,

With this setup, a project will work with both AndroidX and Support dependencies.

Without this, I believe Flutter projects that use plugins with AndroidX dependencies need to be upgraded to AndroidX.

I'm using this branch in a Flutter project using Jetifier and all is working well.

So the benefit is that new Flutter projects using AndroidX should just work with any plugin. Do you have any more information about the issues with Jetifier that you've had? I'd like to test this branch to make sure it solves those issues.

jiechic · 2019-05-30T06:25:53Z

@athornz
I think it should use support library as the default then androidX library is optional for old support library flutter module project update

josh-burton · 2019-05-30T06:29:26Z

Since support library is deprecated I think AndroidX should be the default. If a Flutter project with AndroidX works with Jetifier then there is no reason to use the support libraries.

We should be making use of Jetifier as Google implemented as a good way to update to AndroidX and be compatible with support libraries.

mklim · 2019-05-30T16:04:33Z

Thanks for the contribution! @athornz I agree, AndroidX with Jetifier should ideally be our default to get rid of any support issues. The problem we've run into so far is that Jetifier doesn't work with how we build Flutter apps and include plugins: #32714. You can see this by making a new template with this PR or by migrating an app manually, then depending on a an older plugin (like firebase_core: 0.1.0), then running flutter build apk.

Even with Jetifier being broken for us @dnfield I think this is probably an improvement. At least all of flutter/plugins are migrated to AndroidX at this point, so with that it makes sense to me to have the default template be migrated too. Right now people still need to migrate manually.

tvolkert

Thanks for the contribution @athornz - this is great!

@dnfield having just spent 5 hours wrestling with AndroidX issues in my project, I think this change will help enable new projects to be built.

packages/flutter_tools/lib/src/flutter_manifest.dart

packages/flutter_tools/lib/src/project.dart

packages/flutter_tools/templates/app/android.tmpl/gradle.properties.tmpl

packages/flutter_tools/templates/module/android/gradle/gradle.properties.tmpl

packages/flutter_tools/templates/plugin/android.tmpl/gradle.properties.tmpl

packages/flutter_tools/lib/src/commands/create.dart

packages/flutter_tools/lib/src/project.dart

packages/flutter_tools/templates/app/android.tmpl/gradle.properties

packages/flutter_tools/templates/module/android/gradle/gradle.properties.copy.tmpl

...plates/module/android/library/Flutter.tmpl/src/main/java/io/flutter/facade/Flutter.java.tmpl

packages/flutter_tools/templates/plugin/android.tmpl/gradle.properties

josh-burton · 2019-05-30T20:47:37Z

Thanks @dnfield and @tvolkert for the review - I think I've addressed all the comments now but let me know if there is anything else.

tvolkert

LGTM modulo one small nit.

tvolkert · 2019-05-30T22:23:48Z

LGTM. Will land on green.

Thanks again!

josh-burton · 2019-05-30T23:07:11Z

@jonahwilliams I've rebased on master now.

googlebot · 2019-05-30T23:18:51Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

#34066) This is a small follow up to the previous AndroidX PR: #31028 This fixes an issue mentioned [here](#28805) where the androidX flag for a module is not set when creating a new project: `flutter create --androidx -t module my_flutter`

…ies (flutter#31028)

flutter#34066) This is a small follow up to the previous AndroidX PR: flutter#31028 This fixes an issue mentioned [here](flutter#28805) where the androidX flag for a module is not set when creating a new project: `flutter create --androidx -t module my_flutter`

mcxinyu · 2019-07-09T03:01:43Z

Flutter.jar is not compatible with androidX

truongsinh · 2019-07-31T15:22:15Z

@mcxinyu

Flutter.jar is not compatible with androidX

Currently I have a the app crashed:

    java.lang.NoClassDefFoundError: Failed resolution of: Landroidx/lifecycle/DefaultLifecycleObserver;
        at io.flutter.embedding.engine.FlutterEngine.<init>(FlutterEngine.java:149)

is it related to flutter.jar? cc @athornz @dnfield @tvolkert

blasten · 2019-07-31T15:26:30Z

That is because we are missing AndroidX transitive dependencies from the engine. We have a fix in progress. cc @matthew-carroll

blasten · 2019-07-31T15:34:34Z

In the meanwhile, you can the dependencies manually to android/build.gradle as indicated on https://developer.android.com/jetpack/androidx/releases/lifecycle#declaring_dependencies

truongsinh · 2019-08-01T01:37:52Z

The crash still happens even after I added the following snippet to app/build.gradle

    // known issue https://github.com/flutter/flutter/pull/31028#issuecomment-516902006
    def lifecycle_version = "2.0.0"
    // ViewModel and LiveData
    implementation "androidx.lifecycle:lifecycle-extensions:$lifecycle_version"
    // alternatively - just ViewModel
    implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycle_version"
    // alternatively - just LiveData
    implementation "androidx.lifecycle:lifecycle-livedata:$lifecycle_version"
    implementation "androidx.lifecycle:lifecycle-runtime:$lifecycle_version"
    kapt "androidx.lifecycle:lifecycle-compiler:$lifecycle_version"
    // optional - ReactiveStreams support for LiveData
    implementation "androidx.lifecycle:lifecycle-reactivestreams-ktx:$lifecycle_version"
    // optional - Test helpers for LiveData
    testImplementation "androidx.arch.core:core-testing:$lifecycle_version"

blasten · 2019-08-01T23:19:34Z

@truongsinh would you mind creating an issue with a repro test case? Thanks!

truongsinh · 2019-08-02T00:25:52Z

@truongsinh would you mind creating an issue with a repro test case? Thanks!

I might take a while, but sure.

truongsinh · 2019-08-02T01:26:04Z

Actually, trying to reproduce the error on a sample, I encoutered a different problem (here's the code https://github.com/truongsinh/android_flutter_host/tree/built-in-androidx)

Cannot open a library at 'FileMapping(from=/Users/truongsinh/Dev/flutter/android_flutter_host/flutter_embedding/.android/Flutter/build/intermediates/flutter/debug/libs.jar, to=/Users/truongsinh/.gradle/caches/transforms-1/files-1.1/libs.jar/9a5b6ea5d0ab9a291353d9eb6a6ec26b/jetified-libs.jar)'

Doctor summary (to see all details, run flutter doctor -v):
[✓] Flutter (Channel unknown, v1.8.3, on Mac OS X 10.14.5 18F132, locale en-VN)
 
[✓] Android toolchain - develop for Android devices (Android SDK version 28.0.3)
[✓] Xcode - develop for iOS and macOS (Xcode 10.3)
[✓] Android Studio (version 3.4)
[✓] VS Code (version 1.36.1)
[✓] Connected device (1 available)

truongsinh · 2019-08-07T08:45:16Z

@athornz @blasten any update?

truongsinh · 2019-08-07T09:20:23Z

update from my side,

Cannot open a library at 'FileMapping(from=/Users/truongsinh/Dev/flutter/android_flutter_host/flutter_embedding/.android/Flutter/build/intermediates/flutter/debug/libs.jar, to=/Users/truongsinh/.gradle/caches/transforms-1/files-1.1/libs.jar/9a5b6ea5d0ab9a291353d9eb6a6ec26b/jetified-libs.jar)'

is solved by work around, I have to cd flutter_embedding/.android && ./gradlew assembleDebug to generate those jars file, and then I can reproduce

E/AndroidRuntime: FATAL EXCEPTION: main
    Process: pro.truongsinh.flutter.android_flutter_host.free, PID: 11100
    java.lang.NoClassDefFoundError: Failed resolution of: Landroidx/lifecycle/DefaultLifecycleObserver;
        at io.flutter.embedding.engine.FlutterEngine.<init>(FlutterEngine.java:149)
        at pro.truongsinh.flutter.android_flutter_host.FlutterEmbeddingActivity$Companion.init(FlutterEmbeddingActivity.kt:168)
        at pro.truongsinh.flutter.android_flutter_host.MainActivity.onCreate(MainActivity.kt:17)
        at android.app.Activity.performCreate(Activity.java:7802)
        at android.app.Activity.performCreate(Activity.java:7791)
        at android.app.Instrumentation.callActivityOnCreate(Instrumentation.java:1299)
        at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:3243)
        at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:3407)
        at android.app.servertransaction.LaunchActivityItem.execute(LaunchActivityItem.java:83)
        at android.app.servertransaction.TransactionExecutor.executeCallbacks(TransactionExecutor.java:135)
        at android.app.servertransaction.TransactionExecutor.execute(TransactionExecutor.java:95)
        at android.app.ActivityThread$H.handleMessage(ActivityThread.java:2016)
        at android.os.Handler.dispatchMessage(Handler.java:107)
        at android.os.Looper.loop(Looper.java:214)
        at android.app.ActivityThread.main(ActivityThread.java:7343)
        at java.lang.reflect.Method.invoke(Native Method)
        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:492)
        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:933)
     Caused by: java.lang.ClassNotFoundException: Didn't find class "androidx.lifecycle.DefaultLifecycleObserver" on path: DexPathList[[zip file "/data/app/pro.truongsinh.flutter.android_flutter_host.free-R3e6unzzN8OPsBvhFb5V2w==/base.apk"],nativeLibraryDirectories=[/data/app/pro.truongsinh.flutter.android_flutter_host.free-R3e6unzzN8OPsBvhFb5V2w==/lib/arm64, /data/app/pro.truongsinh.flutter.android_flutter_host.free-R3e6unzzN8OPsBvhFb5V2w==/base.apk!/lib/arm64-v8a, /system/lib64, /system/product/lib64]]
        at dalvik.system.BaseDexClassLoader.findClass(BaseDexClassLoader.java:196)
        at java.lang.ClassLoader.loadClass(ClassLoader.java:379)
        at java.lang.ClassLoader.loadClass(ClassLoader.java:312)
        at io.flutter.embedding.engine.FlutterEngine.<init>(FlutterEngine.java:149) 
        at pro.truongsinh.flutter.android_flutter_host.FlutterEmbeddingActivity$Companion.init(FlutterEmbeddingActivity.kt:168) 
        at pro.truongsinh.flutter.android_flutter_host.MainActivity.onCreate(MainActivity.kt:17) 
        at android.app.Activity.performCreate(Activity.java:7802) 
        at android.app.Activity.performCreate(Activity.java:7791) 
        at android.app.Instrumentation.callActivityOnCreate(Instrumentation.java:1299) 
        at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:3243) 
        at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:3407) 
        at android.app.servertransaction.LaunchActivityItem.execute(LaunchActivityItem.java:83) 
        at android.app.servertransaction.TransactionExecutor.executeCallbacks(TransactionExecutor.java:135) 
        at android.app.servertransaction.TransactionExecutor.execute(TransactionExecutor.java:95) 
        at android.app.ActivityThread$H.handleMessage(ActivityThread.java:2016) 
        at android.os.Handler.dispatchMessage(Handler.java:107) 
        at android.os.Looper.loop(Looper.java:214) 
        at android.app.ActivityThread.main(ActivityThread.java:7343) 
        at java.lang.reflect.Method.invoke(Native Method) 
        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:492) 
        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:933) 
Disconnected from the target VM, address: 'localhost:8606', transport: 'socket'

truongsinh · 2019-08-07T10:21:45Z

Figured out, with performance degradation:

I have to use lifecycle_version = "1.1.1", not 2.0.0

    def lifecycle_version = "1.1.1"
    implementation "android.arch.lifecycle:common-java8:$lifecycle_version"

Even with this, my example code still crashed (something like attempt to use destroyed engine), because I use shared cached Flutter enginer, and to fix this, have to override:

    override fun retainFlutterEngineAfterHostDestruction(): Boolean {
        return true
    }

One problem though, it seems the performance of transitioning between Kotlin activity and Flutter activity is much worse than before. Previously, with cached engine, it was really smooth. Even though low performance happens on debug mode only (not profile nor release), it might still be a performance degradation from previous version (1.5.4-hotfix)

xster · 2019-08-14T19:53:27Z

It's hard for us to make sure we follow up on comments on previously merged PRs. If there are still remaining issues or inconveniences with the flows, please file a new issue with repro steps.

blasten · 2019-08-19T05:18:16Z

@truongsinh Btw, we will start shipping Maven artifacts. As a result, these artifacts will become the source of truth for the engine dependencies such as android.arch.lifecycle:common-java8. Once this happens, there won't be more NoClassDefFoundError.

truongsinh · 2019-08-19T06:39:15Z

@truongsinh Btw, we will start shipping Maven artifacts. As a result, these artifacts will become the source of truth for the engine dependencies such as android.arch.lifecycle:common-java8. Once this happens, there won't be more NoClassDefFoundError.

Do we have a github issue or PR to track this?

blasten · 2019-08-19T17:17:56Z

There's #11439

googlebot added the cla: yes label Apr 14, 2019

josh-burton changed the base branch from master to dev April 14, 2019 05:10

goderbauer added the tool label Apr 15, 2019

josh-burton force-pushed the androidx branch 2 times, most recently from 87a0556 to 31cd632 Compare April 23, 2019 05:24

josh-burton mentioned this pull request Apr 29, 2019

Migrate FlutterActivity and FlutterFragment to androidX? #31772

Closed

This was referenced May 24, 2019

Add2App does not support AndroidX out of the box #31189

Closed

AndroidX support #23586

Closed

xster requested review from dnfield and mklim May 26, 2019 00:45

dnfield requested a review from jonahwilliams May 30, 2019 05:49

tvolkert reviewed May 30, 2019

View reviewed changes

dnfield reviewed May 30, 2019

View reviewed changes

packages/flutter_tools/templates/app/android.tmpl/gradle.properties Show resolved Hide resolved

dnfield reviewed May 30, 2019

View reviewed changes

packages/flutter_tools/templates/module/android/gradle/gradle.properties.copy.tmpl Show resolved Hide resolved

dnfield reviewed May 30, 2019

View reviewed changes

...plates/module/android/library/Flutter.tmpl/src/main/java/io/flutter/facade/Flutter.java.tmpl Show resolved Hide resolved

dnfield reviewed May 30, 2019

View reviewed changes

packages/flutter_tools/templates/plugin/android.tmpl/gradle.properties Show resolved Hide resolved

tvolkert approved these changes May 30, 2019

View reviewed changes

googlebot added cla: yes and removed cla: no labels May 30, 2019

blasten added the waiting for tree to go green label Jun 1, 2019

blasten merged commit d0e45a2 into flutter:master Jun 1, 2019

josh-burton mentioned this pull request Jun 7, 2019

Adds the androidX flag to a modules pubspec.yaml template so it is se… #34066

Merged

kiku-jw pushed a commit to kiku-jw/flutter that referenced this pull request Jun 14, 2019

Adds support for generating projects that use AndroidX support librar…

ab931f2

…ies (flutter#31028)

Saifallak mentioned this pull request Jun 15, 2019

New Flutter project not compatible with AndroidX flutter/flutter-intellij#3244

Closed

truongsinh mentioned this pull request Aug 1, 2019

Add2App cannot go to non-initial routes when using cached flutter engine #31185

Closed

github-actions bot locked as resolved and limited conversation to collaborators Aug 4, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds support for generating projects that use AndroidX support libraries #31028

Adds support for generating projects that use AndroidX support libraries #31028

josh-burton commented Apr 14, 2019 •

edited

Loading

jiechic commented May 6, 2019

josh-burton commented May 6, 2019

jiechic commented May 22, 2019

josh-burton commented May 22, 2019

matthew-carroll commented May 23, 2019

xster commented May 26, 2019 •

edited

Loading

dnfield commented May 30, 2019

josh-burton commented May 30, 2019

jiechic commented May 30, 2019

josh-burton commented May 30, 2019

mklim commented May 30, 2019

tvolkert left a comment

josh-burton commented May 30, 2019

tvolkert left a comment

tvolkert commented May 30, 2019

josh-burton commented May 30, 2019

googlebot commented May 30, 2019

mcxinyu commented Jul 9, 2019

truongsinh commented Jul 31, 2019

blasten commented Jul 31, 2019

blasten commented Jul 31, 2019

truongsinh commented Aug 1, 2019

blasten commented Aug 1, 2019

truongsinh commented Aug 2, 2019

truongsinh commented Aug 2, 2019 •

edited

Loading

truongsinh commented Aug 7, 2019

truongsinh commented Aug 7, 2019

truongsinh commented Aug 7, 2019 •

edited

Loading

xster commented Aug 14, 2019

blasten commented Aug 19, 2019

truongsinh commented Aug 19, 2019

blasten commented Aug 19, 2019

Adds support for generating projects that use AndroidX support libraries #31028

Adds support for generating projects that use AndroidX support libraries #31028

Conversation

josh-burton commented Apr 14, 2019 • edited Loading

Description

Related Issues

Tests

Checklist

Breaking Change

jiechic commented May 6, 2019

josh-burton commented May 6, 2019

jiechic commented May 22, 2019

josh-burton commented May 22, 2019

matthew-carroll commented May 23, 2019

xster commented May 26, 2019 • edited Loading

dnfield commented May 30, 2019

josh-burton commented May 30, 2019

jiechic commented May 30, 2019

josh-burton commented May 30, 2019

mklim commented May 30, 2019

tvolkert left a comment

Choose a reason for hiding this comment

josh-burton commented May 30, 2019

tvolkert left a comment

Choose a reason for hiding this comment

tvolkert commented May 30, 2019

josh-burton commented May 30, 2019

googlebot commented May 30, 2019

mcxinyu commented Jul 9, 2019

truongsinh commented Jul 31, 2019

blasten commented Jul 31, 2019

blasten commented Jul 31, 2019

truongsinh commented Aug 1, 2019

blasten commented Aug 1, 2019

truongsinh commented Aug 2, 2019

truongsinh commented Aug 2, 2019 • edited Loading

truongsinh commented Aug 7, 2019

truongsinh commented Aug 7, 2019

truongsinh commented Aug 7, 2019 • edited Loading

xster commented Aug 14, 2019

blasten commented Aug 19, 2019

truongsinh commented Aug 19, 2019

blasten commented Aug 19, 2019

josh-burton commented Apr 14, 2019 •

edited

Loading

xster commented May 26, 2019 •

edited

Loading

truongsinh commented Aug 2, 2019 •

edited

Loading

truongsinh commented Aug 7, 2019 •

edited

Loading