Flutter如何做到“按条件”编译

我们在C/C++下的时候，有时候不需要编辑某些代码，只需要设置一个条件编译即可，但是到了Java、Kotlin、Dart时，这很难做到——不是说做不到，而是编译器不再支持“条件编译”这个功能，需要通过其他的途径来达到这一目的。

缘由

事情的起源是我想给DaRemote增加一个发布渠道，发布到华为的应用商店。接入HMS Core后发现多了几个权限，比如HMS CoreSdk它要求有安装应用的权限，而发行到华为应用商店的App也不需要Google play结算服务的权限。

因此，就希望能根据不同的条件把一些代码和SDK以及相关的packages排除出编译环境。

而要达到这一目的，需要分两个部分来完成：一个是Android原生端的，一个是Flutter/Dart端的。

Java & Kotlin的实现

配置build.gradle文件

原生端是使用gradle来进行编译的，那么“条件编译”的具体实现也是通过build.gradle文件的配置来进行。

Gradle支持设置不同的风味(flavor)来实现不同的编译配置，之前只是用它来修改一些参数，比如AppId，版本号等等，现在要通过它来导入不同的SDK依赖以及指定不同的代码。

首先，创建了两个不同的flavor：

flavorDimensions "flavor_iap"
productFlavors {
    google {
        dimension "flavor_iap"
        signingConfig signingConfigs.releaseGoogle
    }

    huawei {
        dimension "flavor_iap"
        signingConfig signingConfigs.releaseHuawei

然后为他们配置不同的sourceSets：

sourceSets {
    google {
        kotlin.srcDirs = ["src/google"]
    }
    huawei {
        kotlin.srcDirs = ["src/huawei"]
    }
}

最后，把依赖和flavor关联起来，即在implementation前加上flavor的名称，并且使用小驼峰格式的命名：

dependencies {
    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
    huaweiImplementation 'com.huawei.hms:appservice:5.0.4.302'
}

配置源代码

上面的sourceSets配置了不同的代码集，这些指定的代码集将和src/main下的代码进行合并——注意是合并和不是替换。

因此，第一步就是把原来/src/main下会冲突的代码移动到各自的风味目录中。
因为我的Flutter项目在这个目录（src/main/kotlin/com/.../...）下仅有一个MainActivity.kt文件，移走之后就保持为空即可。
另外在src下创建google/kotlin/com/.../...和huawei/kotlin/com/.../...目录，路径和原来的src/main下的格式保持一致。

第二步就是在两个目录下分别创建各自的MainActivity.kt文件，然后根据平台不同实现各自的功能即可。

Flutter配置

Flutter下的实现原理主要是它可以通过编译参数指定不同的入口文件：

flutter build apk --help
....
-t, --target=<path>                 The main entry-point file of the application, as run on the
                                    device.
                                    If the "--target" option is omitted, but a file name is provided
                                    on the command line, then that is used instead.
                                    (defaults to "lib/main.dart")

另外，它也支持指定flavor，可以透传到gradle：

--flavor                        Build a custom app flavor as defined by platform-specific build
                                    setup.

因为它支持不同的入口文件，所以代码需要做一些处理，把main.dart文件分离出来。

代码结构修改

我把原来的main.dart重命名为daremote.dart（即项目主widget文件），删除main函数，然后在lib目录下创建一个main.google.dart，再创建一个main.huawei.dart，两个main文件中都runApp(DaRemote());。

lib
├── daremote.dart
├── main.google.dart
├── main.huawei.dart

编译脚本

由于没有很好的办法对pubspec.yaml中的packages进行“条件控制”，比如没有找到办法创建诸如google_dependencies这样的入口，所以只能通过命令来进行控制：

flutter pub remove --offline in_app_purchase
flutter build appbundle --release --flavor=huawei -t lib/main.huawei.dart
flutter pub add --offline in_app_purchase

针对huawei的编译，先移除google的in_app_purchase包，然后通过--flavor指定风味，通过-t指定flutter的main文件，编译完成后再把包加回去。

vscode配置

开发中需要编译调试，要设置vscode的launch.json。需要注意的地方是要配置program项用以指定入口文件。

"configurations": [
    {
        "name": "huawei",
        "request": "launch",
        "type": "dart",
        "program": "lib/main.huawei.dart",
        "args": [
            "--flavor",
            "huawei",
            "-t",
            "lib/main.huawei.dart"
        ]
    },
    {
        "name": "google",
        "request": "launch",
        "type": "dart",
        "program": "lib/main.google.dart",
        "args": [
            "--flavor",
            "google",
            "-t",
            "lib.main.google.dart"
        ]
    }
]

最后

对于解释型语言也就算了，但是编译型的语言，没有“条件编译”真的是很不方便。为了达到相同的目的，得做很多额外的工作，最主要的是零零碎碎的。

曾经一度想全部通过bash脚本来控制算了，编译不同的版本的时候，通过脚本把文件覆盖成不同的内容，但最后还是花时间研究了一下，尽量用框架自身支持的方式来达到目的。