flutter/packages/flutter_tools/templates/module
Emmanuel Garcia 242a4225a1
Flutter build aar (#36732)
`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
    }
}
2019-07-23 09:27:42 -07:00
..
android Flutter build aar (#36732) 2019-07-23 09:27:42 -07:00
common Fix typo in main.dart templates (#35684) 2019-07-08 10:36:44 -07:00
ios Clean up host_app_ephemeral_cocoapods Profile build settings (#36498) 2019-07-19 12:49:26 -07:00
README.md Rename 'application' back to 'module', and make 'app' the default again for templates. (#22888) 2018-10-10 11:01:40 -07:00

Templates for Flutter Module

common

Written to root of Flutter application.

Adds Dart project files including pubspec.yaml.

android

library

Written to the .android/ hidden folder.

Contents wraps Flutter/Dart code as a Gradle project that defines an Android library.

Executing ./gradlew flutter:assembleDebug in that folder produces a .aar archive.

Android host apps can set up a dependency to this project to consume Flutter views.

gradle

Written to .android/ or android/.

Mixin for adding Gradle boilerplate to Android projects.

host_app_common

Written to either .android/ or android/.

Contents define a single-Activity, single-View Android host app with a dependency on the .android/Flutter library.

Executing ./gradlew app:assembleDebug in the target folder produces an .apk archive.

Used with either android_host_ephemeral or android_host_editable.

host_app_ephemeral

Written to .android/ on top of android_host_common.

Combined contents define an ephemeral (hidden, auto-generated, under Flutter tooling control) Android host app with a dependency on the .android/Flutter library.

host_app_editable

Written to android/ on top of android_host_common.

Combined contents define an editable (visible, one-time generated, under app author control) Android host app with a dependency on the .android/Flutter library.

ios

library

Written to the .ios/Flutter hidden folder.

Contents wraps Flutter/Dart code for consumption by an Xcode project.

iOS host apps can set up a dependency to this contents to consume Flutter views.

host_app_ephemeral

Written to .ios/ outside the Flutter/ sub-folder.

Combined contents define an ephemeral (hidden, auto-generated, under Flutter tooling control) iOS host app with a dependency on the .ios/Flutter folder contents.

The host app does not make use of CocoaPods, and is therefore suitable only when the Flutter part declares no plugin dependencies.

host_app_ephemeral_cocoapods

Written to .ios/ on top of host_app_ephemeral.

Adds CocoaPods support.

Combined contents define an ephemeral host app suitable for when the Flutter part declares plugin dependencies.