Add flutter build aar by blasten · Pull Request #35217 · flutter/flutter

blasten · 2019-06-27T20:48:22Z

Description

flutter build aar

This new build command works just like flutter build apk or flutter build appbundle, but for plugins and module projects.

This PR also refactors how plugins are included in app or module projects. By building the plugins as AARs, the Android Gradle plugin is able to use Jetifier to translate support libraries into AndroidX libraries for all the plugin's native code. Thus, reducing the error rate when using AndroidX in apps.

This change also allows to build modules as AARs, so developers can take these artifacts and distribute them along with the native host app without the need of the Flutter tool. This is a requirement for add to app.

flutter build aar generates POM artifacts (XML files) which contain metadata about the native dependencies used by the plugin. This allows Gradle to resolve dependencies at the app level. The result of this new build command is a single build/outputs/repo, the local repository that contains all the generated AARs and POM files.

In a Flutter app project, this local repo is used by the Flutter Gradle plugin to resolve the plugin dependencies. In add to app case, the developer needs to configure the local repo and the dependency manually in build.gradle:

repositories {
    maven {
        url "<path-to-flutter-module>build/host/outputs/repo"
    }
}

dependencies {
    implementation("<package-name>:flutter_<build-mode>:1.0@aar") {
       transitive = true
    }
}

Related Issues

#23586
#29328
#26099
#25979
#28805
#27254
#24859

Tests

I added the following tests:

Unit test to check how the tool picks the Gradle version based on the Android Gradle plugin.
gradle_jetifier_test - Tests that Jetifier translates support into AndroidX dependencies
gradle_plugin_dependencies_test - Tests this issue: Android dependency 'androidx.core:core' has different version for the compile (1.0.0) and runtime (1.0.1) classpath. You should manually set the same version via DependencyResolution #27254
build_aar_plugin_test - Tests that plugins can be built as AARs.
build_aar_module_test - Tests that modules with plugins can be built as AARs.
Automatic migration of settings.gradle.

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

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.

packages/flutter_tools/gradle/aar_init_script.gradle

dnfield

LGTM!

jonahwilliams · 2019-07-19T18:47:18Z

packages/flutter_tools/lib/src/reporting/usage.dart

-// Next ID: cd33
+
+const String kCommandBuildAarTargetPlatform = 'cd33';
+const String kCommandBuildAarProjectType = 'cd34';


I think we might have just used this cd value

jonahwilliams

LGTM

zanderso

lgtm w/ comments and nits.

zanderso · 2019-07-19T22:14:44Z

packages/flutter_tools/lib/src/android/gradle.dart

+  }
  final Status status = logger.startProgress('Resolving dependencies...', timeout: timeoutConfiguration.slowOperation);
  GradleProject project;
  try {


The logic in this function could use some explanation in comments. For example, it's hard to tell whether gradle failing under this 'try', and falling back on the default is expected/okay, or whether something is probably going to go wrong later on.

zanderso · 2019-07-19T22:17:51Z

packages/flutter_tools/lib/src/android/gradle.dart

+  printError('');
+  printError('The Gradle project does not define a task suitable for the requested build.');
+  if (!project.buildTypes.contains(buildInfo.modeName)) {
+    printError('Review the android/app/build.gradle file and ensure it defines a ${buildInfo.modeName} build type.');


maybe return and remove else.

zanderso · 2019-07-19T22:20:11Z

packages/flutter_tools/lib/src/reporting/usage.dart

-// Next ID: cd33
+
+const String kCommandBuildAarTargetPlatform = 'cd33';
+const String kCommandBuildAarProjectType = 'cd34';


Double check these.

mklim

LGTM!

mklim · 2019-07-19T23:53:28Z

packages/flutter_tools/gradle/deprecated_settings.gradle

@@ -0,0 +1,31 @@
+include ':app'
+


packages/flutter_tools/gradle/deprecated_settings.gradle

packages/flutter_tools/gradle/aar_init_script.gradle

xster · 2019-07-23T00:32:09Z

Still LGTM

This reverts commit 11460b8.

`flutter build aar` This new build command works just like `flutter build apk` or `flutter build appbundle`, but for plugin and module projects. This PR also refactors how plugins are included in app or module projects. By building the plugins as AARs, the Android Gradle plugin is able to use Jetifier to translate support libraries into AndroidX libraries for all the plugin's native code. Thus, reducing the error rate when using AndroidX in apps. This change also allows to build modules as AARs, so developers can take these artifacts and distribute them along with the native host app without the need of the Flutter tool. This is a requirement for add to app. `flutter build aar` generates POM artifacts (XML files) which contain metadata about the native dependencies used by the plugin. This allows Gradle to resolve dependencies at the app level. The result of this new build command is a single build/outputs/repo, the local repository that contains all the generated AARs and POM files. In a Flutter app project, this local repo is used by the Flutter Gradle plugin to resolve the plugin dependencies. In add to app case, the developer needs to configure the local repo and the dependency manually in `build.gradle`: repositories { maven { url "<path-to-flutter-module>build/host/outputs/repo" } } dependencies { implementation("<package-name>:flutter_<build-mode>:1.0@aar") { transitive = true } }

This reverts commit 11460b8.

blasten added tool Affects the "flutter" command-line tool. See also t: labels. work in progress; do not review a: build Building flutter applications with the tool labels Jun 27, 2019

googlebot added the cla: yes label Jun 27, 2019

blasten force-pushed the aar branch from 077af50 to 5c7b728 Compare June 27, 2019 20:49

WIP

f3f69bf

blasten force-pushed the aar branch from 5c7b728 to f3f69bf Compare June 27, 2019 20:50

blasten added 3 commits June 27, 2019 17:30

pass flutter root

b62fb65

empty line

610addf

Fix tests

e1727df

josh-burton reviewed Jun 28, 2019

View reviewed changes

packages/flutter_tools/gradle/aar_init_script.gradle Show resolved Hide resolved

blasten added 6 commits June 27, 2019 19:56

Add option to override the build directory

5d31239

comment

1e74fb9

Fix bug in modules

32ba561

Consistent quotes

0caaeb7

Don't add flutter.jar if the flutter plugin is already used.

7d193b5

Fix bug

f3ba5a6

josh-burton reviewed Jun 28, 2019

View reviewed changes

packages/flutter_tools/gradle/aar_init_script.gradle Outdated Show resolved Hide resolved

Build plugins as aar

6c4ae20

blasten force-pushed the aar branch from 937c266 to 6c4ae20 Compare July 1, 2019 01:08

blasten added 2 commits June 30, 2019 18:13

Set plugin version

05f0f31

Set buildDir according to the the output-dir flag

a98012c

blasten force-pushed the aar branch from 64c8547 to a98012c Compare July 1, 2019 04:57

blasten added 7 commits June 30, 2019 23:22

Fix issue when Jetifier is enabled

c11bcf7

cleanup

56e35d8

Support multiple buildTypes

8c52290

Don't load plugins in settings.gradle

4e2d811

Allow incremental build of plugins

f4400c8

Pub is required

3b46092

Support Gradle 3.1.0

830a812

blasten requested a review from dnfield July 18, 2019 06:10

This was referenced Jul 18, 2019

Allow applying a local Gradle file when deploying as a module. #30895

Closed

Updates latest gradle & kotlin versions #32550

Closed

dnfield approved these changes Jul 18, 2019

View reviewed changes

jonahwilliams reviewed Jul 19, 2019

View reviewed changes

jonahwilliams approved these changes Jul 19, 2019

View reviewed changes

blasten requested review from Hixie and xster July 19, 2019 19:10

zanderso approved these changes Jul 19, 2019

View reviewed changes

mklim approved these changes Jul 20, 2019

View reviewed changes

blasten added 3 commits July 21, 2019 21:18

Format

0462f48

Merge branch 'master' into aar

14008f1

Comments

340ca53

blasten added the waiting for tree to go green label Jul 22, 2019

Linter

b7709fe

Merge branch 'master' into aar

a5325c6

blasten force-pushed the aar branch from f4349c9 to a5325c6 Compare July 23, 2019 00:46

Merge branch 'master' into aar

6eacd79

blasten merged commit 11460b8 into flutter:master Jul 23, 2019

blasten pushed a commit that referenced this pull request Jul 23, 2019

Revert "Add flutter build aar (#35217)"

b57e87a

This reverts commit 11460b8.

blasten mentioned this pull request Jul 23, 2019

Revert "Add flutter build aar" #36731

Merged

blasten pushed a commit that referenced this pull request Jul 23, 2019

Revert "Add flutter build aar (#35217)" (#36731)

c9b466f

This reverts commit 11460b8.

blasten mentioned this pull request Jul 23, 2019

Flutter build aar #36732

Merged

xster mentioned this pull request Jul 25, 2019

Flutter与Android混合编码配置笔记 qingmei2/blogs#12

Open

johnsonmh pushed a commit to johnsonmh/flutter that referenced this pull request Jul 30, 2019

Revert "Add flutter build aar (flutter#35217)" (flutter#36731)

aabdf52

This reverts commit 11460b8.

jmagman mentioned this pull request Dec 18, 2019

Support creation of an engine AAR instead of a JAR for Android. #22102

Open

TahaTesser mentioned this pull request Jun 29, 2020

New flutter plugin won't compile #60359

Open

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add flutter build aar#35217

Add flutter build aar#35217
blasten merged 70 commits intoflutter:masterfrom
blasten:aar

blasten commented Jun 27, 2019 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

dnfield left a comment

Uh oh!

jonahwilliams Jul 19, 2019

Uh oh!

jonahwilliams left a comment

Uh oh!

zanderso left a comment

Uh oh!

zanderso Jul 19, 2019

Uh oh!

zanderso Jul 19, 2019

Uh oh!

zanderso Jul 19, 2019

Uh oh!

mklim left a comment

Uh oh!

mklim Jul 19, 2019

Uh oh!

Uh oh!

Uh oh!

xster commented Jul 23, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

Conversation

blasten commented Jun 27, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Tests

Checklist

Breaking Change

Uh oh!

Uh oh!

Uh oh!

dnfield left a comment

Choose a reason for hiding this comment

Uh oh!

jonahwilliams Jul 19, 2019

Choose a reason for hiding this comment

Uh oh!

jonahwilliams left a comment

Choose a reason for hiding this comment

Uh oh!

zanderso left a comment

Choose a reason for hiding this comment

Uh oh!

zanderso Jul 19, 2019

Choose a reason for hiding this comment

Uh oh!

zanderso Jul 19, 2019

Choose a reason for hiding this comment

Uh oh!

zanderso Jul 19, 2019

Choose a reason for hiding this comment

Uh oh!

mklim left a comment

Choose a reason for hiding this comment

Uh oh!

mklim Jul 19, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

xster commented Jul 23, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

blasten commented Jun 27, 2019 •

edited

Loading