前言

我们在写 flutter 项目时每次执行 pub clean 后.android 项目同样会重新创建，在我们项目中遇到minSdkVersion 默认(17)及 kotlin 默认 (1.3.50) 版本低，相信大家都遇到过，每次都需要手动设置，考虑这种手动操作繁琐让我团队成员不胜其扰。通过 py 脚本一键处理这个问题，大家也就能愉快开发了~😆

minSdkVersion 版本问题

iShot2022-03-07 22.25.13.png

kotlin 版本问题

iShot2022-03-07 22.45.30.png

思考

之前我们手动修改 flutter 自动生成的 build.gradle 的模板文件，具体可以看这里 传送门。但每次都需要自己去手动去修改模板文，文件路径打开比较麻烦，并且我们更新 flutter 版本后这里也会重置掉。既然如此我想通过 Python 脚本自动去生成对应的模板文件覆盖即可。

使用

方式一

  • 配置好 ssh 工具 shuttle 一键执行，其实 shuttle 的命令是用 json 来设置，可以结合 [jsonnet](https://github.com/google/jsonnet) 去动态生成，这样就可以复用给别人

image.png

  • 当然我们也可以直接终端执行,不过需要自己写好对应的路径相对麻烦些如下, 所以我更推荐使用 ssh 工具 shuttle 一键执行。
    1. cd /Users/zhengzeqin/Desktop/GitLab/TWHouseScript; python flutter_android_build_gradle_set.py -p '/Users/addcn/flutter/packages/flutter_tools/templates/module/android/gradle/build.gradle.tmpl' -a /Users/addcn/flutter/packages/flutter_tools/templates/module/android/host_app_common/app.tmpl/build.gradle.tmpl

方式二

路径我们也可以写在脚本里，定义好需要修改的 flutter sdk 的目标模板路径即可，具体如下

  1. # 定义 flutter 目标 android project build_gradle 配置的路径
  2. _project_build_gradle_set_file = "/Users/zhengzeqin/flutter/packages/flutter_tools/templates/module/android/gradle/build.gradle.tmpl"
  3. # 定义 flutter 目标 android app build_gradle 配置的路径
  4. _app_build_gradle_set_file = "/Users/zhengzeqin/flutter/packages/flutter_tools/templates/module/android/host_app_common/app.tmpl/build.gradle.tmpl"
  6. # 定义需要写入的 android project 根目录的 build_gradle 配置
  7. _build_gradle_tmpl_for_project = "/build_gradle_tmpl_for_project.txt"
  9. # 定义需要写入的 android app 目录的 build_gradle 配置
  10. _build_gradle_tmpl_for_app = "/build_gradle_tmpl_for_app.txt"
  13. # ...
  16. if __name__ == "__main__":
  17.     # 执行脚本路径修改 Android build gradle 的目标模板
  18.     set_android_build_gradle_params_files()
  19.     pass

完整脚本代码

自定义 Android Project 的 build gradle 模板

  1. def flutterPluginVersion = 'managed'
  3. apply plugin: 'com.android.application'
  5. android {
  6.     compileSdkVersion 31
  8.     compileOptions {
  9.         sourceCompatibility JavaVersion.VERSION_1_8
  10.         targetCompatibility JavaVersion.VERSION_1_8
  11.     }
  13.     defaultConfig {
  14.         applicationId "{{androidIdentifier}}.host"
  15.         minSdkVersion 21
  16.         targetSdkVersion 31
  17.         versionCode 1
  18.         versionName "1.0"
  19.     }
  21.     buildTypes {
  22.         profile {
  23.             initWith debug
  24.         }
  25.         release {
  26.             // TODO: Add your own signing config for the release build.
  27.             // Signing with the debug keys for now, so `flutter run --release` works.
  28.             signingConfig signingConfigs.debug
  29.         }
  30.     }
  32. }
  33. buildDir = new File(rootProject.projectDir, "../build/host")
  34. dependencies {
  35.     implementation project(':flutter')
  36.     implementation fileTree(dir: 'libs', include: ['*.jar'])
  37.     implementation 'androidx.appcompat:appcompat:1.0.2'
  38.     implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
  39. }

自定义 Android App 的 build gradle 模板

  1. // Generated file. Do not edit.
  3. buildscript {
  4.     ext.kotlin_version = '1.6.10'
  5.     repositories {
  6.         google()
  7.         mavenCentral()
  8.     }
  10.     dependencies {
  11.         classpath 'com.android.tools.build:gradle:{{agpVersion}}'
  12.         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
  13.         classpath "org.jetbrains.kotlin:kotlin-android-extensions:$kotlin_version"
  14.     }
  15. }
  17. allprojects {
  18.     repositories {
  19.         google()
  20.         mavenCentral()
  21.     }
  22. }
  24. task clean(type: Delete) {
  25.     delete rootProject.buildDir
  26. }

需要修改的 Flutter 目标模板

image.png

脚本代码

  1. # -*- coding: utf-8 -*-
  2. # -*- author: zhengzeqin -*-
  3. # -*- date: 2022-03-07 -*-
  5. """
  6. Flutter 修改默认生成的 minSdkVersion 问题
  7. flutter pub get 会自动生成 android 目录，但是如果要修改 build.gradle 文件里面的内容，需要每次都要手动改一下，很麻烦
  8. 解决办法
  9. 修改 flutter 自动生成的 build.gradle 的模板文件
  10. 模板文件路径: flutter_sdk/packages/flutter_tools/templates/module/android/host_app_common/app.tmpl/build.gradle.tmpl
  11. py 解决思路: 通过脚本一键复制修改 flutter 配置模板
  12. """
  14. import os
  15. import sys
  16. import getopt
  18. # 定义 flutter 目标 android project build_gradle 配置的路径
  19. _project_build_gradle_set_file = "/Users/zhengzeqin/flutter/packages/flutter_tools/templates/module/android/gradle/build.gradle.tmpl"
  20. # 定义 flutter 目标 android app build_gradle 配置的路径
  21. _app_build_gradle_set_file = "/Users/zhengzeqin/flutter/packages/flutter_tools/templates/module/android/host_app_common/app.tmpl/build.gradle.tmpl"
  23. # 定义需要写入的 android project 根目录的 build_gradle 配置
  24. _build_gradle_tmpl_for_project = "/build_gradle_tmpl_for_project.txt"
  26. # 定义需要写入的 android app 目录的 build_gradle 配置
  27. _build_gradle_tmpl_for_app = "/build_gradle_tmpl_for_app.txt"
  29. # 读取文件内容
  30. def readfile(file_name):
  31.     file2 = open(file_name)
  32.     str = file2.read()
  33.     file2.close()
  34.     return str
  37. # 设置 build_gradle 的内容
  38. def android_gradle_set():
  39.     # 获取当前文件路径
  40.     concurrent = os.path.abspath(os.path.dirname(__file__))
  41.     read_file_path = concurrent + '/build_gradle_tmpl_for_project.txt'
  42.     write_file_path = concurrent + '/build.gradle.tmpl'
  43.     read_file = open(read_file_path, 'r')
  44.     write_file = open(write_file_path, "w")
  46.     s = read_file.read()
  47.     w = write_file.write(s)
  49.     read_file.close()
  50.     write_file.close()
  52. # 从文件路径中写入到目标文件
  53. def set_build_gradle_file(read_file_path, write_file):
  54.     read_file = open(read_file_path, 'r')
  55.     write_file = open(write_file, "w")
  56.     s = read_file.read()
  57.     write_file.write(s)
  58.     read_file.close()
  59.     write_file.close()
  61. # 获取当前文件夹的路径
  62. def get_current_path():
  63.     return os.path.abspath(os.path.dirname(__file__))
  65. # 设置 app 的 file
  66. def set_app_build_gradle_file():
  67.     read_file_path = get_build_gradle_file(_build_gradle_tmpl_for_app)
  68.     set_build_gradle_file(read_file_path, _app_build_gradle_set_file)
  70. # 设置 project 根目录的 file
  71. def set_pro_build_gradle_file():
  72.     read_file_path = get_build_gradle_file(_build_gradle_tmpl_for_project)
  73.     set_build_gradle_file(read_file_path, _project_build_gradle_set_file)
  75. # 读取本地配置文件
  76. def get_build_gradle_file(build_gradle_tmpl):
  77.     concurrent = os.path.abspath(os.path.dirname(__file__))
  78.     read_file_path = concurrent + build_gradle_tmpl
  79.     return  read_file_path
  81. # 通过本地文件配置路径修改 Android 项目的 build_gradle 配置
  82. def set_android_build_gradle_params_files():
  83.     set_pro_build_gradle_file()
  84.     set_app_build_gradle_file()
  86. # 通过参数配置路径修改 Android 项目的 build_gradle 配置
  87. def set_android_build_gradle_argv_files():
  88.     argv = sys.argv[1:]
  89.     # android project build_gradle 配置的路径
  90.     project_path = ""
  91.     # android app build_gradle 配置的路径
  92.     app_path = ""
  93.     # 默认关闭
  94.     is_close_bitcode = True
  95.     try:
  96.         opts, args = getopt.getopt(argv, "p:a:", ["project=", "app="])
  97.     except getopt.GetoptError:
  98.         print('flutter_android_gradle_set.py -p "项目路径"')
  99.         sys.exit(2)
  101.     print("opts ===>", opts)
  103.     for opt, arg in opts:
  104.         if opt in ["-p", "--project"]:
  105.             project_path = arg
  106.         if opt in ["-a", "--app"]:
  107.             app_path = arg
  108.     # 设置 project build gradle
  109.     read_pro_file_path = get_build_gradle_file(_build_gradle_tmpl_for_project)
  110.     set_build_gradle_file(read_pro_file_path, project_path)
  111.     # 设置 app build gradle
  112.     read_app_file_path = get_build_gradle_file(_build_gradle_tmpl_for_app)
  113.     set_build_gradle_file(read_app_file_path, app_path)
  115. if __name__ == "__main__":
  116.     # set_android_build_gradle_params_files()
  117.     set_android_build_gradle_argv_files()
  118.     pass

脚本地址