Flutter 小技巧之 3.7 更灵活的编译变量支持

news2024/12/31 6:37:16

今天我们聊个简单的知识点，在 Flutter 3.7 的 release-notes 里，有一个没有出现在 announcement 说明上的 change log ，可能对于 Flutter 团队来说这个功能并不是特别重要，但是对于我个人而言，这是一个十分重要的能力补充：

[flutter_tools] Fix so that the value set by --dart-define-from-file can be passed to Gradle by @blendthink in https://github.com/flutter/flutter/pull/114297

翻到这个小功能，纯属是意外之喜。

Dart

在 3.7 版本之前，如果我们需要在编译时动态给 Flutter 添加变量信息，那么我们会用到 --dart-define ，例如：

flutter run --dart-define=APP_CHANNEL=Offical

const APP_CHANNEL = String.fromEnvironment('APP_CHANNEL');

我们可以通过 --dart-define 在命令行指定一个变量，然后在 Flutter 里通过 String.fromEnvironment 读取它，一般场景下它是满足需求的，但是：

如果当你需要定义多个变量时，命令就会变得冗长且不好维护
如果你是混合开发，变量还需要同步修改到原生项目的配置里，就会变得麻烦

在此之前，针对同步修改到不同原生项目的配置，我是通过自定义脚本去实现：

Android 上利用 gradle 脚本，参考 RN 上的 dotenv 读取某个脚本配置，修改 project.env
iOS 上通过读取脚本配置，然后利用系统的 PlistBuddy 命令在编译时插入和修改某些参数

而现在，从 Flutter 3.7 开始，它变得更简单了，因为你可以使用 --dart-define-from-file ：

flutter run --dart-define-from-file=config.json

// config.json // 
{
  "TEST_KEY1": "test key 1",
  "TEST_KEY2": "test key 2"
}

同样是 dart define ，但是 --dart-define-from-file 可以直接从一个 json 文件上读取配置，然后转成一个 Map，之后配置到 Environment 里，同样是可以在 dart 里通过 String.fromEnvironment 去读取参数，而 json 文件的配置方式，可以让你在需要配置多个变量时参数管理变得更好维护。

那到这里就结束了吗？显然不是，前面我们说过同步修改到不同原生项目的配置，而 Flutter 3.7 下官方也正式支持。

Android

首先是 Android ，我们可以在 app/build.gradle 文件下定义一个 dartEnvVar 变量，它主要是用来读取前面 json 文件注入到 project 的参数。

然后我们就可以在 app/build.gradle 下直接通过 dartEnvVar 引用对应参数，比如定义 resValue ，可以看到 dartEnvVar 在编译时，成功读取到 json 文件里的参数。

如下图所示，能通过 project 读取 dart 的环境变量配置之后，我们就可以定义有 resValue 去修改 AndroidManifest 文件，甚至定义插入到 BuildConfig 里在原生代码引用，而对于配置我们只需要维护一份 json 文件即可。

那它是如何实现的？简单来说，在 flutter/packages/flutter_tools/lib/src/build_info.dart 脚本下，之前读取的 json 文件可以得到一个 dartDefineConfigJsonMap 对象，它会被转化为一个 Gradle 参数列表，在之后的 assembleTask 里被作为参数执行。