90%不知道的Android Build Variant的使用


productFlavors最常见的用法就是配置不同的渠道包了,相信以下配置大家都非常熟悉

productFlavors{

xiaomi{

//指定manifest中CHANNEL_VALUE的值

manifestPlaceholders = [CHANNEL_VALUE: “xiaomi”]

}

huawei{

manifestPlaceholders = [CHANNEL_VALUE: “huawei”]

}

}

上面的例子通过定义不同的flavor,覆盖manifest中的CHANNEL_VALUE配置参数,这样就起到对不同渠道进行区分的作用。

productFlavors{

flavorDimensions ‘isFree’,

free {

//免费版和付费版最低适配版本不同

minSdkVersion 21

//免费版和付费版使用不同的包名

applicationId ‘com.example.android.free’

//写入不同的res值

resValue “string”,‘tag’,‘free’

//指定所在的维度

dimension ‘isFree’

}

paid {

minSdkVersion 24

applicationId ‘com.example.android.paid’

resValue “string”,‘tag’,‘paid’

dimension ‘isFree’

}

}

创建并配置产品变种后,点击通知栏中的 Sync Now。同步完成后,Gradle 会根据 build 类型和产品变种自动创建 build 变体,并按照 <product-flavor><Build-Type> 为其命名。在上面的例子中,则Gradle 会创建以下 build 变体:

  • freeDebug

  • freeRelease

  • paidDebug

  • paidRelease

flavorDimensions


注意,从AGP 3.0开始,必须至少明确指定一个flavor dimensiondimension的指定方式在上面的例子已经体现了。可能有部分同学按照要求随意给不同的flavor指定了某个dimension,但是不知道这个东西具体的作用。

实际上dimension的作用将多个产品变种的配置组合在一起。例如上面的例子,我们是通过是否付费这个角度定义了freepaid两个flavor。那么它们俩就应该属于同一个dimension。所以我们分配了isFree这个dimension

假如我们的app还区分国内版和国际版,那么我们还可以定义一个 areadimension,如下

productFlavors{

flavorDimensions ‘isFree’,“area”

free {

minSdkVersion 21

applicationId ‘com.example.android.free’

resValue “string”,‘tag’,‘free’

dimension ‘isFree’

}

paid {

minSdkVersion 24

applicationId ‘com.example.android.paid’

resValue “string”,‘tag’,‘paid’

dimension ‘isFree’

}

domestic{

dimension ‘area’

}

overseas {

dimension ‘area’

}

}

通过上面的定义,我们就拥有了四种组合,分别是

  • freeDomestic 免费国内版

  • freeOverseas 免费国际版

  • paidDomestic 付费国内版

  • paidOverseas 付费国际版

这里有个注意的地方是,flavor组合的顺序是根据flavorDimensions的元素排序决定的。假如我们将

isFreearea的顺序颠倒一下

flavorDimensions “area”,‘isFree’

那么原先的freeDomestic将变成domesticFree。这会造成什么影响呢?

实际上第一个flavor是具有高优先级的。 假如free和domestic都定义了各自的包名

productFlavors{

flavorDimensions “area”,‘isFree’

free {

applicationId ‘com.example.android.free’

dimension ‘isFree’

}

domestic{

dimension ‘area’

applicationId ‘com.example.android.domestic’

}

}

那么最终的包名将会是com.example.android.domestic

matchingFallbacks


在某些情况下,app模块包含了某些flavors而library模块却没有,在这种情况下,app无法和library的flavor相匹配,通过指定matchingFallbacks来兜底。例如下面这个例子,app依赖了library

//app build.gradle

productFlavors{

flavorDimensions ‘isFree’

free {

dimension ‘isFree’

matchingFallbacks = [‘demo’]

}

paid {

dimension ‘isFree’

}

}

//library build.gradle

productFlavors{

flavorDimensions ‘isFree’

demo {

dimension ‘isFree’

}

paid {

dimension ‘isFree’

}

}

当执行assembleFreeRelease时,由于library不存在freeflavor,那么会使用demo进行替代。

如果app不指定matchingFallbacks的话,是无法通过编译的,会报如下错误

Could not resolve all artifacts for configuration ‘:app:freeDebugCompileClasspath’.

Could not resolve project :library.

Required by:

project :app

所以,如果library和app都定义了ProductFlavor,那么需要对齐,否则需要指定matchingFallbacks进行兜底。注意,library和app需要定义在同个dimension下。

SourceSet

========================================================================

SourceSet即源代码集,我们可以使用 SourceSet 代码块更改 Gradle 为源代码集的每个组件收集文件的位置。这样我们就无需改变文件的位置。换句话说,有了SourceSet,我们可以按照自己的偏好指定代码和资源的路径

基本使用


属性

以下是AndroidSourceSets提供的属性

| Property | Description |

| — | — |

| aidl | Android AIDL目录 |

| assets | Assets目录 |

| java | Java目录 |

| jni | JNI目录 |

| jniLibs | JNI libs目录 |

| manifest | AndroidManifest路径 |

| name | source set的名称 |

| renderscript | RenderScript目录 |

| res | res资源目录 |

| resources | Java resources目录 |

以上的配置除了manifest对应的是AndroidSourceFile 对象,即为单一文件,其余的都是AndroidSourceDirectorySet对象,我们来看下AndroidSourceDirectorySet接口提供了哪些方法。

public interface AndroidSourceDirectorySet extends PatternFilterable {

@NonNull

String getName();

//添加资源路径到集合中,最终AGP会从集合里取出所有的文件

@NonNull

AndroidSourceDirectorySet srcDir(Object srcDir);

//添加多个资源路径到集合中

@NonNull

AndroidSourceDirectorySet srcDirs(Object… srcDirs);

//指定资源的路径,与上面两个方法不同的时候,该方法会覆盖原有的集合

@NonNull

AndroidSourceDirectorySet setSrcDirs(Iterable<?> srcDirs);

//以FileTree形式返回资源

@NonNull

FileTree getSourceFiles();

//返回过滤规则

@NonNull

PatternFilterable getFilter();

//将源文件夹作为一个列表返回

@NonNull

List getSourceDirectoryTrees();

//返回资源文件列表

@NonNull

Set getSrcDirs();

/** Returns the [FileCollection] that represents this source sets. */

@Incubating

FileCollection getBuildableArtifact();

}

因此我们可以修改源集的位置,我们来看一个简单配置

def basePath = projectDir.parentFile.absolutePath

def resPath = new File(basePath, “res”)

def manifestPath = new File(basePath, “AndroidManifest.xml”)

sourceSets {

main {

res.srcDir(resPath)

manifest.srcFile(manifestPath)

}

}

我们可以通过sourceSets任务来打印具体的配置

:app:sourceSets

//输出

main


Compile configuration: compile

build.gradle name: android.sourceSets.main

Java sources: [app/src/main/java]

//AndroidMnaifest路径被改到app根目录下

Manifest file: AndroidManifest.xml

//可以看刚才添加的res目录

Android resources: [app/src/main/res, res]

Assets: [app/src/main/assets]

AIDL sources: [app/src/main/aidl]

RenderScript sources: [app/src/main/rs]

JNI sources: [app/src/main/jni]

JNI libraries: [app/src/main/jniLibs]

Java-style resources: [app/src/main/resources]

paid


Compile configuration: paidCompile

build.gradle name: android.sourceSets.paid

Java sources: [app/src/paid/java]

Manifest file: app/src/paid/AndroidManifest.xml

Android resources: [app/src/paid/res]

Assets: [app/src/paid/assets]

AIDL sources: [app/src/paid/aidl]

RenderScript sources: [app/src/paid/rs]

JNI sources: [app/src/paid/jni]

JNI libraries: [app/src/paid/jniLibs]

Java-style resources: [app/src/paid/resources]

//省略其他源集

方法

| 方法 | 描述 |

| — | — |

| setRoot(path) | 将源集的根设置为给定的路径。源集合的所有条目都位于此根目录下。 |

通过setRoot方法,我们可以直接指定某个源集的目录,例如如果你有多个ProductFlavor,并且创建了对应的源集目录,那么我们可以把非main的目录都放到一起,避免src目录太多文件。

sourceSets.all { set ->

if (set.name.toLowerCase().contains(flavor)

&& !set.name.equals(“main”)) {

set.setRoot(“src/other/$flavor”)

}

}

源集类型


main 源集包含了所有其他构件变体共用的代码和资源,即所有的其他构建变体,src/main是其共同拥有的。

其他源集目录为可选项,如果我们想要为某个单独的构建变体添加特有的代码或者资源,可以创建对应的目录。例如,构建“demoDebug”这个变体, Gradle 会查看以下目录,并为它们指定以下优先级

  1. src/demoDebug/(build 变体源代码集)

  2. src/debug/(build 类型源代码集)

  3. src/demo/(产品变种源代码集)

  4. src/main/(主源代码集)

当存在重复的资源时,Gradle 将按以下优先顺序决定使用哪一个文件(左侧源集替换右侧源集的文件和设置):

构建变体 > 构建类型[BuildType] > 产品风味[ProductFlavor] > 主源集[main] > 库依赖项

  • java/ 目录中的所有源代码将一起编译以生成单个输出

注意的是,java文件是不能被覆盖的,如果我们在main目录中创建了src/main/Utility.java,那么是不能其他源集目录中定义同名文件进行覆盖的,因为,Gradle 在构建过程中会查看这两个目录并抛出“重复类”错误。如果我们想要在不同的 build 类型有不同版本的 Utility.java,只能让每个 build 类型定义各自的文件版本,这样是比较麻烦的。

  • 所有Manifest都将合并为一个清单。合并的优先级和上面提到的一致。

  • 同样,values/ 目录中的文件也会合并在一起。如果两个文件同名,例如存在两个 strings.xml 文件,按照上述的优先级覆盖。

  • res/ 和 asset/ 目录中的资源会打包在一起。

  • 最后,在构建 APK 时,Gradle 会为库模块依赖项随附的资源和清单指定最低优先级。

配置过滤规则


回顾上面的AndroidSourceDirectorySet接口,其继承了PatternFilterable接口

public interface PatternFilterable {

Set getIncludes();

Set getExcludes();

PatternFilterable setIncludes(Iterable includes);

PatternFilterable setExcludes(Iterable excludes);

PatternFilterable include(String… includes);

PatternFilterable include(Iterable includes);

PatternFilterable include(Spec includeSpec);

PatternFilterable include(Closure includeSpec);

PatternFilterable exclude(String… excludes);

PatternFilterable exclude(Iterable excludes);

PatternFilterable exclude(Spec excludeSpec);

PatternFilterable exclude(Closure excludeSpec);

该接口提供了一系列的includeexclude方法,我们可以对源集目录做一些过滤。

sourceSets {

main {

java {

exclude ‘com/cooke/library/Test.java’

exclude ‘com/cooke/library/model/**.java’

}

}

}

上面例子提到,其他的源集目录无法覆盖同名java文件,但是我们可以通过SourceSet对main目录中的java进行exclude.

注意:includeexclude并不能对res生效,如果想要对res进行过滤,需要通过定义res/raw/keep.xml,详见Android文档,这里就不具体展开了。

Variant

======================================================================

Variant 即为变体,可以分为ApplicationVariantLibraryVariant,分别对应了apk的变体和aar的变体。变体的构成由BuildTypeProductFlavor组合而成.即

variant = buildType * productFlavor

例如上面我们定义了freepaid两种productFlavor,结合debugrelease两种buildType,就产生了4种组合,如下图

我们可以遍历ApplicationVariantLibraryVariant列表,干预构建apk和aar的过程。

最常见的就是重命名apk的名称。

android.applicationVariants.all {

variant ->

variant.outputs.all {

outputFileName = “KaTeX parse error: Expected group after '_' at position 16: {applicationId}_̲{buildType.name}_vKaTeX parse error: Expected group after '_' at position 28: …ig.versionName}_̲{releaseTime()}.apk”

}

### Android 构建 Variant 详细说明 #### 定义与组成 构建变体由一种 `Build Type` 和一种 `Product Flavor` 组成[^3]。通过组合同的产品风味和构建类型,可以创建多个同版本的应用程序。 #### 自动生成的任务 Gradle 的 Android 插件会自动为每个配置的构建变体创建相应的任务。这些任务遵循命名模式 `assemble<Flavor><BuildType>` 来生成特定变体的 APK 文件。例如,执行命令 `assembleBlueDebug` 将仅编译并打包名为 "blue" 的风味以及调试类型的变体应用;而运行 `assemble` 则会触发所有定义好的变体进行打包过程[^1]。 #### 自动化资源管理 当调用了 `assemble` 或者任何具体的组装指令之后,Gradle 仅仅负责代码层面的工作,在文件结构方面也有着细致入微的操作——它会在项目的指定路径下(`app/build/source/buildConfig`)按照各个变体分别建立对应的目录树,并放置必要的配置类如 `BuildConfig.java`。此文件包含了诸如应用程序 ID (`APPLICATION_ID`)、当前使用的构建类型 (`BUILD_TYPE`) 和所选的产品风味 (`FLAVOR`) 等重要信息,开发者可以通过访问此类来获取有关正在处理的具体变体的信息[^2]。 ```java // 示例:如何在代码中读取 BuildConfig 中的内容 if (BuildConfig.FLAVOR.equals("free")) { // 执行免费版特有的逻辑... } else if (BuildConfig.BUILD_TYPE.equals("release")) { // 发布版本特有条件判断... } ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值