将Flutter项目打包aar上传maven

雨点打透心脏的1/2处 2023-10-09 13:38 38阅读 0赞

当Flutter作为模块 (Flutter Module) 使用的时候，我们可以将Flutter Module 打包成aar的方式，依赖到Android原生项目中，这样原生项目无需进行任何的Flutter配置，耦合最小。

我们可以直接在本地进行依赖，或者使用maven仓库对aar包进行管理。

#### 方法一 : 本地直接进行依赖 ####

在项目根目录下，使用cmd中执行 `flutter build aar`命令  
编译成功后，可以看到cmd中有显示相关的配置方式  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASGVpa28tQW5kcm9pZA_size_20_color_FFFFFF_t_70_g_se_x_16]  
需要注意的是，在Windows中，直接这样配置是会报错的，需要将本地`maven url`修改成如下所示

String storageUrl = System.env.FLUTTER_STORAGE_BASE_URL ?: "https://storage.googleapis.com"
    maven {
        
        url "file://C:/WorkSpace/Android/Flutter/flutter_module/build/host/outputs/repo"
    }
    maven {
        
        url "$storageUrl/download.flutter.io"
    }

但是，这种方式只适合个人开发的时候，对aar的管理不够友好，如果换一台电脑，或者多人开发，就会有问题了。

#### 方法二 : 直接手动上传到maven仓库中 ####

在项目根目录下，使用cmd中执行 `flutter build aar`命令  
然后在build文件夹下找到该aar，手动上传到maven仓库中  
详情可以看我的另一篇博客 [手动上传aar到nexus maven仓库][aar_nexus maven]  
这种比较简单，但经常上传的话，相对比较繁琐

#### 方式三 : 使用脚本自动上传 ####

点击`upload.bat`或在cmd中执行`upload.bat` ，自动上传aar到maven仓库

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASGVpa28tQW5kcm9pZA_size_20_color_FFFFFF_t_70_g_se_x_16_pic_center]  
具体做法

1.  在Flutter Module 项目的根目录下，新建一个`script`文件夹
2.  在`script`文件夹下新建`flutter_aar_upload.gradle`文件，并复制如下内容

// This script is used to initialize the build in a module or plugin project.
    // During this phase, the script applies the Maven plugin and configures the
    // destination of the local repository.
    // The local repository will contain the AAR and POM files.
    
    void configureProject(Project project, String mavenUrl, String mavenUser, String mavenPwd, String version) {
        
      if (!project.hasProperty("android")) {
        
        throw new GradleException("Android property not found.")
      }
      if (!project.android.hasProperty("libraryVariants")) {
        
        throw new GradleException("Can't generate AAR on a non Android library project.")
      }
    
      project.apply plugin: "maven"
    
      // Snapshot versions include the timestamp in the artifact name.
      // Therefore, remove the snapshot part, so new runs of `flutter build aar` overrides existing artifacts.
      // This version isn't relevant in Flutter since the pub version is used
      // to resolve dependencies.
    
      project.version = version
      if (mavenUrl.startsWith("file:")) {
        
        //本地路径时，原逻辑
        project.version = project.version.replace("-SNAPSHOT", "")
      }
    
    
      project.android.libraryVariants.all {
         variant ->
        addAarTask(project, variant)
      }
    
      project.uploadArchives {
        
        repositories {
        
          mavenDeployer {
        
            repository(url: mavenUrl) {
        
              if (mavenUser != null) {
        
                authentication(userName: mavenUser, password: mavenPwd)
              }
            }
            //默认本地路径：
            //repository(url: "file://${outputDir}/outputs/repo")
          }
        }
      }
      if (!project.property("is-plugin").toBoolean()) {
        
        return
      }
    
      if (project.hasProperty('localEngineOut')) {
        
        // TODO(egarciad): Support local engine.
        // This most likely requires refactoring `flutter.gradle`, so the logic can be reused.
        throw new GradleException(
            "Local engine isn't supported when building the plugins as AAR. " +
                "See: https://github.com/flutter/flutter/issues/40866")
      }
    
      // This is a Flutter plugin project. Plugin projects don't apply the Flutter Gradle plugin,
      // as a result, add the dependency on the embedding.
      project.repositories {
        
        maven {
        
          url "https://storage.googleapis.com/download.flutter.io"
        }
      }
      String engineVersion = flutterEngineVersion()
      project.dependencies {
        
        // Add the embedding dependency.
        //使用api方式打入aar
        compileOnly("io.flutter:flutter_embedding_release:1.0.0-$engineVersion") {
        
          //    api("io.flutter:flutter_embedding_release:1.0.0-$engineVersion") {
        
          // We only need to expose io.flutter.plugin.*
          // No need for the embedding transitive dependencies.
          transitive = true
        }
      }
    }
    
    void configurePlugin(Project project, String outputDir, String mavenUser, String mavenPwd) {
        
      if (!project.hasProperty("android")) {
        
        // A plugin doesn't support the Android platform when this property isn't defined in the plugin.
        return
      }
      //flutter plugin 版本号
      File pubspecFile = project.file("../pubspec.yaml")
      String versionLine = pubspecFile.readLines().find {
         line->
        line.startsWith("version:")
      }
      def pluginVersion = versionLine.split(":")[1].trim()
      println("configurePlugin: " + project.toString() + " v" + pluginVersion)
      configureProject(project, outputDir, mavenUser, mavenPwd, pluginVersion)
    }
    
    void addAarTask(Project project, variant) {
        
      String variantName = variant.name.capitalize()
      String taskName = "assembleAar$variantName"
      project.tasks.create(name: taskName) {
        
        // This check is required to be able to configure the archives before `uploadArchives` runs.
        if (!project.gradle.startParameter.taskNames.contains(taskName)) {
        
          return
        }
        project.uploadArchives.repositories.mavenDeployer {
        
          pom {
        
            artifactId = "${
          project.name}_${
          variant.name.toLowerCase()}"
          }
        }
        overrideDefaultPublishConfig(project, variant)
        // Generate the Maven artifacts.
        finalizedBy "uploadArchives"
      }
    }
    
    // This method mimics the logic in AGP when `android.defaultPublishConfig` is set in `build.gradle`:
    // https://android.googlesource.com/platform/tools/base/+/studio-master-dev/build-system/gradle-core/src/main/java/com/android/build/gradle/internal/variant/VariantHelper.java
    //
    // Unfortunately, `android.defaultPublishConfig` cannot be overriden at this point since
    // AGP already run this code.
    void overrideDefaultPublishConfig(Project project, variant) {
        
      String variantName = variant.name.capitalize()
      Task bundle = project.tasks.findByName("bundle${
          variantName}Aar")
      // gradle:3.2.0
      if (bundle == null) {
        
        bundle = project.tasks.findByName("bundle${
          variantName}") // gradle:3.1.0
      }
      if (bundle == null) {
        
        throw new GradleException("Can't generate AAR for variant ${
          variantName}.")
      }
      // Clear the current archive artifacts since the artifacts are based on `android.defaultPublishConfig`.
      project.configurations["archives"].artifacts.clear()
      // Add the artifact that will be published.
      project.artifacts.add("archives", bundle)
    
      def scopeMappings = project.uploadArchives.repositories.mavenDeployer.pom.scopeMappings
      // Clear the scope mappings added by AGP since they are based on the current `android.defaultPublishConfig`.
      scopeMappings.mappings.clear()
      // Add the new mappings.
      for (Configuration configuration : flattenConfiguration(variant.runtimeConfiguration)) {
        
        scopeMappings.addMapping(/* priority = */ 300, configuration, "compile")
      }
    }
    
    Set<Configuration> flattenConfiguration(Configuration configuration) {
        
      Set<Configuration> configs = [configuration]
      for (Configuration extend : configuration.extendsFrom) {
        
        configs.addAll(flattenConfiguration(extend))
      }
      return configs
    }
    
    projectsEvaluated {
        
      assert rootProject.hasProperty("is-plugin")
      if (rootProject.property("is-plugin").toBoolean()) {
        
        assert rootProject.hasProperty("maven-url")
        // In plugin projects, the root project is the plugin.
        configureProject(rootProject, rootProject.property("maven-url"),
            rootProject.property("maven-user"), rootProject.property("maven-pwd"),
            project.property("buildNumber")
        )
        return
      }
      // The module project is the `:flutter` subproject.
      Project moduleProject = rootProject.subprojects.find {
         it.name == "flutter" }
    
      assert moduleProject != null
      assert moduleProject.hasProperty("maven-url")
      configureProject(moduleProject, moduleProject.property("maven-url"),
          moduleProject.property("maven-user"), moduleProject.property("maven-pwd"),
          moduleProject.property("buildNumber")
      )
    
      // Gets the plugin subprojects.
      Set<Project> modulePlugins = rootProject.subprojects.findAll {
        
        it.name != "flutter" && it.name != "app"
      }
      // When a module is built as a Maven artifacts, plugins must also be built this way
      // because the module POM's file will include a dependency on the plugin Maven artifact.
      // This is due to the Android Gradle Plugin expecting all library subprojects to be published
      // as Maven artifacts.
      String mavenUrl = moduleProject.property("maven-url")
      String version = moduleProject.property("buildNumber")
    
      println("Version: $version")
      println("MavenUrl: " + mavenUrl)
    
      //输出 配置
      String buildMode = moduleProject.gradle.startParameter
          .taskNames.find {
         it.startsWith("assembleAar") }.substring(11)
      println("BuildMode: $buildMode")
    
      println("================================================================================")
      //配置插件
      modulePlugins.each {
         pluginProject ->
        configurePlugin(pluginProject, mavenUrl,
            moduleProject.property("maven-user"), moduleProject.property("maven-pwd"))
        moduleProject.android.libraryVariants.all {
         variant ->
          // Configure the `assembleAar<variantName>` task for each plugin's projects and make
          // the module's equivalent task depend on the plugin's task.
          String variantName = variant.name.capitalize()
          moduleProject.tasks.findByPath("assembleAar$variantName")
              .dependsOn(pluginProject.tasks.findByPath("assembleAar$variantName"))
        }
      }
      //结束
      println("================================================================================")
    
      String mUrl = mavenUrl
      if (mavenUrl.startsWith("file://")) {
        
        mUrl = mavenUrl.substring(7)
      }
    
      String groupId = moduleProject.group
    
      println("""
    1. 添加maven地址
    repositories {
      maven {
          url '${
          mUrl}'
      }
      maven {
          url 'https://storage.googleapis.com/download.flutter.io'
      }
    }
    2. 添加依赖
    
    dependencies {
      implementation '${
          groupId}:flutter_${
          buildMode.toLowerCase()}:${
          version}'
    }
    """)
    }

1.  在`script`文件夹下新建`upload.bat`

接着，使用记事本编辑`upload.bat`

cd ..
    cd .android
    gradlew -I=../script/flutter_aar_upload.gradle -Pmaven-url=http://nexus.liubike.com/repository/AndroidRepository/ -Pmaven-user=admin -Pmaven-pwd=123456 -Pis-plugin=false -PbuildNumber=1.0.3 assembleAarRelease

> 还可以配置打包的cpu架构 `-Ptarget-platform=android-arm,android-arm64,android-x64`

然后就可以点击`upload.bat`或在cmd中执行`upload.bat`  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASGVpa28tQW5kcm9pZA_size_20_color_FFFFFF_t_70_g_se_x_16_pic_center]

然后，我们看一下maven仓库  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASGVpa28tQW5kcm9pZA_size_20_color_FFFFFF_t_70_g_se_x_16_pic_center 1]  
可以看到，已经有这个aar了

最后，我们像使用其他普通的maven 第三方库一样，进行使用即可

1.  在根目录的build.gradle中添加maven地址

repositories {
        
      maven {
        
          url 'http://nexus.liubike.com/repository/AndroidRepository/'
      }
      maven {
        
          url 'https://storage.googleapis.com/download.flutter.io'
      }
    }

1.  在app的build.gradle中添加依赖

dependencies {
        
      implementation 'com.heiko.flutter_module:flutter_release:1.0.3'
    }

编译，发现成功运行 !

> 如果是mac os 或 linux，可以看这一篇 [https://blog.csdn.net/qq\_37299249/article/details/115012889][https_blog.csdn.net_qq_37299249_article_details_115012889]

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASGVpa28tQW5kcm9pZA_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/5e9164eb4fbf4ee08980d1f6ef914682.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBASGVpa28tQW5kcm9pZA==,size_20,color_FFFFFF,t_70,g_se,x_16
[aar_nexus maven]: https://blog.csdn.net/EthanCo/article/details/117779069?ops_request_misc=%257B%2522request%255Fid%2522%253A%2522163548818416780261955079%2522%252C%2522scm%2522%253A%252220140713.130102334.pc%255Fblog.%2522%257D&request_id=163548818416780261955079&biz_id=0&utm_medium=distribute.pc_search_result.none-task-blog-2~blog~first_rank_v2~rank_v29-1-117779069.pc_v2_rank_blog_default&utm_term=maven&spm=1018.2226.3001.4450
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASGVpa28tQW5kcm9pZA_size_20_color_FFFFFF_t_70_g_se_x_16_pic_center]: https://img-blog.csdnimg.cn/aecb8bdf1ea141e4bb95c942cedd9ed5.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBASGVpa28tQW5kcm9pZA==,size_20,color_FFFFFF,t_70,g_se,x_16#pic_center
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBASGVpa28tQW5kcm9pZA_size_20_color_FFFFFF_t_70_g_se_x_16_pic_center 1]: https://img-blog.csdnimg.cn/f6c6089ae420435d9b4594bbcc3e3cb5.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBASGVpa28tQW5kcm9pZA==,size_20,color_FFFFFF,t_70,g_se,x_16#pic_center
[https_blog.csdn.net_qq_37299249_article_details_115012889]: https://blog.csdn.net/qq_37299249/article/details/115012889