如何在所有Android应用模块中复用android.variantFilter实现？

问题描述 #

我希望为所有Android应用模块使用相同的android.variantFilter(...)实现。目前我在“app”模块中已有一个可正常工作的variantFilter：

android.variantFilter { variant ->
    String buildType = variant.buildType.name
    String flavor = variant.getFlavors().get(0).name

    if ((buildType == 'debug' && (flavor == 'canary' || flavor == 'int' || flavor == 'prd')) ||
            (buildType == 'release' && (flavor == 'dev' || flavor == 'loc')))
        variant.setIgnore(true)
}

但该应用包含多个模块，我想对所有模块执行同样的变体过滤，无需在每个模块的build.gradle文件中重复实现此variantFilter。请问是否可以在中心位置（例如应用的顶层build.gradle文件）定义该过滤器，然后在各模块的build.gradle文件中引用？

解决方案 #

当然可以实现全局复用，无需在每个模块重复编写过滤逻辑，以下两种方式任选其一：

方式一：顶层定义全局闭包，模块按需引用

这是最简单的实现方式，适合中小规模多模块项目：

1. 在项目根目录的build.gradle中定义全局闭包
   在buildscript块之外，通过ext属性定义可复用的过滤逻辑：

   // 项目根目录 build.gradle
   ext {
       globalVariantFilter = { variant ->
           String buildType = variant.buildType.name
           String flavor = variant.getFlavors().get(0).name
   
           if ((buildType == 'debug' && (flavor == 'canary' || flavor == 'int' || flavor == 'prd')) ||
                   (buildType == 'release' && (flavor == 'dev' || flavor == 'loc')))
               variant.setIgnore(true)
       }
   }
   

2. 在各模块的build.gradle中引用闭包
   在模块的android代码块内直接调用全局闭包：

   // 模块级 build.gradle
   android {
       // 其他Android配置（compileSdk、defaultConfig等）
       variantFilter globalVariantFilter
   }
   

方式二：自定义Gradle插件自动注入（无侵入式）

适合大型多模块项目，无需手动修改每个模块的配置：

1. 创建buildSrc插件目录
   在项目根目录下创建buildSrc/src/main/groovy/（若用Kotlin DSL则创建kotlin目录），新增插件类：

   package com.yourteam.gradle
   
   import org.gradle.api.Plugin
   import org.gradle.api.Project
   
   class GlobalVariantFilterPlugin implements Plugin<Project> {
       @Override
       void apply(Project project) {
           // 仅对Android应用/库模块生效
           project.plugins.withId("com.android.application") {
               configureFilter(project)
           }
           project.plugins.withId("com.android.library") {
               configureFilter(project)
           }
       }
   
       private void configureFilter(Project project) {
           project.android.variantFilter { variant ->
               String buildType = variant.buildType.name
               String flavor = variant.getFlavors().get(0).name
   
               if ((buildType == 'debug' && (flavor == 'canary' || flavor == 'int' || flavor == 'prd')) ||
                       (buildType == 'release' && (flavor == 'dev' || flavor == 'loc')))
                   variant.setIgnore(true)
           }
       }
   }
   

2. 注册插件
   在buildSrc/src/main/resources/META-INF/gradle-plugins/目录下，创建com.yourteam.variant-filter.properties文件：

   implementation-class=com.yourteam.gradle.GlobalVariantFilterPlugin
   

3. 全局应用插件
   在项目根目录的build.gradle中，为所有子模块自动应用插件：

   // 项目根目录 build.gradle
   subprojects {
       plugins.apply("com.yourteam.variant-filter")
   }
   

注意事项 #

• 如果你的项目使用多维度Flavor配置，variant.getFlavors().get(0)可能无法匹配预期维度，需要根据实际Flavor结构调整代码。
• 方式一灵活可控，可选择特定模块应用；方式二完全无侵入，适合所有模块统一规则的场景。

内容的提问来源于stack exchange，提问作者arkascha