介绍
多渠道打包常规方式有两种,Flavor
和 --dart-define
,后者是 Flutter1.17
新增的命令行可选参数,比Flavor
配置更简单,非常适合用于环境配置
运行命令:
flutter run --dart-define=DARTDEFINE_APP_ENV=debug
通常为了区分不同的环境,会在测试和开发的apk名字后添加后缀,而且不同开发环境对应不同接口环境。所以以标题、域名和后缀作为要更改的环境变量,开始 --dart-define
配置之旅。
Flutter 配置
环境配置
新建一个环境配置文件,用来获取不同的环境变量。
// 环境配置
class EnvConfig {
final String appTitle;
final String appDomain;
EnvConfig({
required this.appTitle,
required this.appDomain,
});
}
// 获取的配置信息
class Env {
// 获取到当前环境
static const appEnv = String.fromEnvironment(EnvName.envKey);
// 开发环境
static final EnvConfig _debugConfig = EnvConfig(
appTitle: "debugTitle",
appDomain: "http://www.debugxxx.com",
);
// 发布环境
static final EnvConfig _releaseConfig = EnvConfig(
appTitle: "releaseTitle",
appDomain: "http://www.releasexxx.com",
);
// 测试环境
static final EnvConfig _testConfig = EnvConfig(
appTitle: "testTitle",
appDomain: "http://www.testxxx.com",
);
static EnvConfig get envConfig => _getEnvConfig();
// 根据不同环境返回对应的环境配置
static EnvConfig _getEnvConfig() {
switch (appEnv) {
case EnvName.debug:
return _debugConfig;
case EnvName.release:
return _releaseConfig;
case EnvName.test:
return _testConfig;
default:
return _debugConfig;
}
}
}
// 声明的环境
abstract class EnvName {
// 环境key
static const String envKey = "DART_DEFINE_APP_ENV";
// 环境value
static const String debug = "debug";
static const String release = "release";
static const String test = "test";
}
在EnvName
里声明了三个环境,这是运行命令和打包命令里要填写的值。envKey
是对应的key
。
使用配置
在main
文件里使用前面配置的值,标题使用配置的标题,在页面中显示配置的域名:
return Scaffold(
appBar: AppBar(
title: Text(Env.envConfig.appTitle),
),
body: Center(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [
Text(
'配置的域名是:',
),
Text(
Env.envConfig.appDomain,
style: Theme.of(context).textTheme.headline4,
),
],
),
),
);
运行
在终端输入命令,先运行debug
环境:
flutter run --dart-define=DART_DEFINE_APP_ENV=debug
注意,这里的DART_DEFINE_APP_ENV
和debug
是和env_config
里的对应的。
标题和域名是Env
里配置的对应debug
的参数。
然后运行test
环境:
flutter run --dart-define=DART_DEFINE_APP_ENV=test
IDE配置
命令行容易输错怎么办?那就配置 IDE 。
- 点击菜单上的编辑配置
- 输入命令:
- 添加
test
的配置:
复制了一份,命名为test
,把参数改为test
- 继续复制一份
release
。
然后要运行哪个环境,选择对应的配置即可。
Android 配置
不仅仅在 dart 文件里使用到配置信息,原生代码也使用到,比如配置推送和bugly,另外测试人员为了区分环境也会要求在配置不同的应用名称后缀,那么就需要在原生代码里修改。
在build.gradle
里设置默认配置参数
// android/app/build.gradle
/// 设置默认配置参数
def dartDefine = [
DARTDEFINE_APP_ENV: 'debug',
]
然后从dart-defines
里获取定义的键值对,添加到dartEnv
里。
// android/app/build.gradle
/// 设置默认配置参数
def dartDefine = [
DART_DEFINE_APP_ENV: 'debug',
]
if (project.hasProperty('dart-defines')) {
dartDefine = dartDefine + project.property('dart-defines')
.split(',')
.collectEntries { entry ->
def pair = URLDecoder.decode(entry).split('=')
[(pair.first()): pair.last()]
}
}
定义 resValue
,或者BuildConfig
,这里因为要改应用名,需要引用string
资源,所以用 resValue
:
defaultConfig {
applicationId "com.example.flutter_flavors"
minSdkVersion 16
targetSdkVersion 30
versionCode flutterVersionCode.toInteger()
versionName flutterVersionName
resValue "string","app_name","flutter_flavor${dartEnv.DART_DEFINE_APP_ENV}"
}
在清单文件引用:
每次运行不同的环境,就可以看到不同的应用名字。在代码里也可以通过getString("app_name")
获取到定义的值。
Ios 配置
右键项目,选择在 xcode 里打开:
右键 Flutter 目录选择 new flie,选择如下所示的类型。填入名称 Dart
:
添加默认值:
DART_DEFINE_APP_ENV=flutter_flavor
在 Debug.xcconfig 和 Release.xcconfig 里分别添加引用:
#include "DartDefine.xcconfig"
#include "DartDefineConfig.xcconfig"
第一行是引用我们创建的配置文件,第二行是在编译时生成的(下一步配置生成代码)。
在 Info 里修改Bundle name
为我们配置的值:
编辑Schema:
这里有两个地方需要注意,上面要选中 Runner ,下面的输出文件名称要和上一步引用的一致。
到此 Ios 也配置完成。选择 test 配置运行:
应用名变成了选择的配置。
打包
打包命令和运行命令的后缀一样:
flutter build apk --dart-define=DARTDEFINE_APP_ENV=release
源码
Flutter 环境:
Doctor summary (to see all details, run flutter doctor -v):
[✓] Flutter (Channel stable, 2.0.5, on Mac OS X 10.15.6 19G2021 darwin-x64,
locale zh-Hans-CN)
[✓] Android toolchain - develop for Android devices (Android SDK version 30.0.3)
[✓] Xcode - develop for iOS and macOS
[✓] Chrome - develop for the web
[✓] Android Studio (version 4.2)
[✓] VS Code (version 1.56.0)
[✓] Connected device (2 available)