实际项目中,都会应用Android Gradle Plugin,根据实际中的项目模块的职责,可以具体应用如下四种插件类型。

1,apply plugin: 'com.android.application'
实际对应的原型是:com.android.build.gradle.AppExtension,表示此项目模块类型为Android App Module,对应构建生成的文件为.apk类型文件。

2,apply plugin: 'com.android.library'
实际对应的原型是:com.android.build.gradle.LibraryExtension,表示此项目模块类型为Android Library Module,对应构建生成的文件为.arr类型的文件。

3,apply plugin: 'com.android.test'
实际对应的原型是:com.android.build.gradle.TestExtension,表示此项目模块类型为Android test Module,可以在单个模块内通过targetProjectPath指定项目,用于对应项目的单元测试。

4,apply plugin: 'com.android.feature'
实际对应的原型是:com.android.build.gradle.FeatureExtension,表示此项目模块类型为Android feature Module,主要用于单个模块内实现特性,以支持Android Instant Apps

其中,一般项目中最常见的是applicationlibrary插件类型。

项目模块内应用了具体的Android Gradle Plugin类型后,可以开始进行对应的配置,如最常见的如下配置项:

apply plugin: 'com.android.application'

android {
compileSdkVersion 28
defaultConfig {
applicationId "com.happycorn"
minSdkVersion 15
targetSdkVersion 28
versionCode 1
versionName "1.0"
testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
...
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
...
} ...
} dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
...
}
复制代码

此时可以按住CTRL,通过鼠标悬浮,可以看到对应的配置原型信息。

不同的Android Gradle Plugin插件类型,对应不同的实现原型,以及对应可能不同的对外配置项。

同样的,跟踪defaultConfig{}原型信息,可以进入到如下原型说明。

/**
* Specifies defaults for variant properties that the Android plugin applies to all build
* variants.
*
* <p>You can override any <code>defaultConfig</code> property when <a
* href="https://developer.android.com/studio/build/build-variants.html#product-flavors">
* configuring product flavors</a>.
*
* <p>For more information about the properties you can configure in this block, see {@link
* ProductFlavor}.
*/
public void defaultConfig(Action<DefaultConfig> action) {
checkWritability();
action.execute(defaultConfig);
}
复制代码

可见,defaultConfig{}所对应的具体职责是:
为变体属性,指定默认值,Android plugin 可以将指定的变体属性的默认值,应用到所有的变体中。

执行action.execute(defaultConfig);后,将为DefaultConfig对象指定具体的配置。

实际项目开发中,我们往往关注此处有哪些配置项,以及每个配置项对应的含义及作用。

首先可以在Android Gradle DSL文档上对应查询DefaultConfig使用说明。
具体参见:
google.github.io/android-gra…

文档中列出了DefaultConfig对象的对外可配置的属性、方法,以及对应说明,在具体配置时,可能有些需要注意的事项,文档中也做了详尽叙述。

但无论是属性还是方法,一般在build.gradle中配置defaultConfig{}时,一般都是采用形如 key value形式,当然,实际上也可以采用对应的方法原型形式配置,效果是等价的,不过有个前提是,此方法原型是确实存在的,否则,Gradle会报错。
如:

defaultConfig {
...
minSdkVersion 15
...
} 等价于
defaultConfig {
...
minSdkVersion(15)
...
}
复制代码

defaultConfig{}中配置的属性,在构建时,会默认生成对应的变体目录下的BuildConfig.java文件,此文件中将之前配置的属性转变成了对应的JAVA常量形式。

build.gradle中配置如下:

android {
compileSdkVersion 28 defaultConfig {
applicationId "com.happycorn"
minSdkVersion 15
targetSdkVersion 28
versionCode 1
versionName "1.0"
} buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
} debug { }
} flavorDimensions "default" productFlavors {
demo {
applicationIdSuffix "demo"
} full {
applicationIdSuffix "full"
}
} }
复制代码

执行./gradlew assembleFull命令,对应生成的BuildConfig文件为:

如其中的buildTypedebug对应的BuildConfig文件内容为:

/**
* Automatically generated file. DO NOT MODIFY
*/
package com.happycorn; public final class BuildConfig {
public static final boolean DEBUG = Boolean.parseBoolean("true");
public static final String APPLICATION_ID = "com.happycorn.full";
public static final String BUILD_TYPE = "debug";
public static final String FLAVOR = "full";
public static final int VERSION_CODE = 1;
public static final String VERSION_NAME = "1.0";
}
复制代码

BuildConfig文件为JAVA源码级别,构建时也会对应被编译打包到包中,可以直接在对应的模块中使用。

利用此特性,我们经常可以在项目中对变体环境进行逻辑判断,对应的进行逻辑处理。 如:判断是否是DEBUG,对应的输出Log等。

if (BuildConfig.DEBUG) {
Log.d(TAG, "come here...");
}
复制代码

另外,DefaultConfig对象中专门对外提供了buildConfigField(type, name, value)方法,用于向构建时生成的BuildConfig.java类中增加新的属性。

如:defaultConfig{}中通过buildConfigField(type, name, value)添加如下。

defaultConfig {
...
// 是否打对对用户的内测包
innerTest = project.hasProperty('innertest') ? innertest : 'false'
buildConfigField "boolean", "INNER_TEST", innerTest // 添加模块对应的模块名
buildConfigField "String", "MODULE_NAME", "\"${project.name}\""
}
复制代码

生成的BuildConfig.java中将有对应属性产生。

public final class BuildConfig {
...
// Fields from default config.
public static final boolean INNER_TEST = false;
public static final String MODULE_NAME = "app";
}
复制代码

利用此特性,可以很有技巧性的去处理项目中的一些特定的问题。参照上例代码中的两个追加的属性。
如:
Gradle构建时,通过命令参数-P传入对应参数键值,可以将其在defaultConfig{}中添加,以自动在BuildConfig.java中生成对应属性,然后程序中对应进行一些逻辑的特别处理。

if (BuildConfig.INNER_TEST) {
// 用户内测的一些逻辑处理
...
}
复制代码

又如:
调用项目日志系统时,可以传入对应的模块名,以实现对各个模块的日志过滤展示等。
此时就可以通过project.name取到模块名,追加到BuildConfig.java中。然后调用日志库时可以取用。

CLog.e(BuildConfig.MODULE_NAME, TAG, e)
复制代码

更进一步,此处对各个模块通过defaultConfig{}配置向BuildConfig.java中追加属性可以写成:

allprojects {
...
afterEvaluate { project ->
def android = project.extensions.findByName("android")
if(android != null){
def defaultConfig = android["defaultConfig"]
defaultConfig.buildConfigField("String", "MODULE_NAME", "\"${project.name}\"")
}
}
}
复制代码

使得整体用法显得非常灵活。

除了buildConfigField(type, name, value)方法外,还有一个实用方法resValue(String type, String name, String value)
resValue(String type, String name, String value)等价于向模块res/values中新增一个资源。

如:在buildTypedebug中新增资源:

buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
} debug {
resValue("string", "app_name_debug", "HappyCornDebug")
resValue("integer", "token", "365")
}
}
复制代码

编译后,对应变体目录结构下会生成资源文件,及对应的资源键值。

项目中对应需要的此资源的地方也可以直接取用:

getResources().getString(R.string.app_name_debug);
getResources().getInteger(R.integer.token);
复制代码

defaultConfig{}中配置的属性与productFlavors中具体Flavor中配置的属性重复时,Android Gradle构建时将以productFlavors中的对应配置为准,可以理解成将defaultConfig{}中对应的配置覆盖掉了。但applicationIdSuffix除外(applicationIdSuffix依然是追加的形式)。

在现实的项目需求中,外部传入的参数键值或通过Gradle/Android Gradle脚本获取的值,结合defaultConfig{}配置,变体,以及对应生成的BuildConfig.java或资源文件,实现一些特定场景下的需求,整体可以非常灵活,且具有一定的技巧性。

作者:HappyCorn
链接:https://juejin.im/post/5c70a1f56fb9a04a0e2dd008
来源:掘金
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

Android Gradle defaultConfig详解及实用技巧的更多相关文章

  1. Android Studio gradle配置详解

    android gradle配置详解 AppExtension类及其属性 可能大部分人看到AppExtension类会感觉到非常的陌生,其实我们在app中的build.gradle中填写配置信息的时候 ...

  2. Android Studio系列教程五--Gradle命令详解与导入第三方包

    Android Studio系列教程五--Gradle命令详解与导入第三方包 2015 年 01 月 05 日 DevTools 本文为个人原创,欢迎转载,但请务必在明显位置注明出处!http://s ...

  3. Android SDK Manager详解

    Android基础知识——Android SDK Manager详解   做Android开发时,免不了使用Android SDK Manager,安装需要的sdk版本.buildTools版本等等. ...

  4. Android apk签名详解——AS签名、获取签名信息、系统签名、命令行签名

    Apk签名,每一个Android开发者都不陌生.它就是对我们的apk加了一个校验参数,防止apk被掉包.一开始做Android开发,就接触到了apk签名:后来在微信开放平台.高德地图等平台注册时,需要 ...

  5. 《Android游戏开发详解》一1.7 控制流程第1部分——if和else语句

    本节书摘来异步社区<Android游戏开发详解>一书中的第1章,第1.7节,译者: 李强 责编: 陈冀康,更多章节内容可以访问云栖社区"异步社区"公众号查看. 1.7 ...

  6. android:ToolBar详解

    android:ToolBar详解(手把手教程) 泡在网上的日子 发表于 2014-11-18 12:49 第 124857 次阅读 ToolBar 42 来源 http://blog.mosil.b ...

  7. Android之canvas详解

    首先说一下canvas类: Class Overview The Canvas class holds the "draw" calls. To draw something, y ...

  8. 【转】Android Canvas绘图详解(图文)

    转自:http://www.jcodecraeer.com/a/anzhuokaifa/androidkaifa/2012/1212/703.html Android Canvas绘图详解(图文) 泡 ...

  9. Android 核心分析 之八Android 启动过程详解

    Android 启动过程详解 Android从Linux系统启动有4个步骤: (1) init进程启动 (2) Native服务启动 (3) System Server,Android服务启动 (4) ...

随机推荐

  1. Binary Search 的递归与迭代实现及STL中的搜索相关内容

    与排序算法不同,搜索算法是比较统一的,常用的搜索除hash外仅有两种,包括不需要排序的线性搜索和需要排序的binary search. 首先介绍一下binary search,其原理很直接,不断地选取 ...

  2. Python_字符串连接

    #join() 与split()相反,join()方法用来将列表中多个字符串进行连接,并在相邻两个字符串之间插入指定字符 li=['apple','peach','banana','pear'] se ...

  3. SpringCloud实战-Feign声明式服务调用

    在前面的文章中可以发现当我们通过RestTemplate调用其它服务的API时,所需要的参数须在请求的URL中进行拼接,如果参数少的话或许我们还可以忍受,一旦有多个参数的话,这时拼接请求字符串就会效率 ...

  4. Zookeeper vs etcd vs Consul

    Zookeeper vs etcd vs Consul [编者的话]本文对比了Zookeeper.etcd和Consul三种服务发现工具,探讨了最佳的服务发现解决方案,仅供参考. 如果使用预定义的端口 ...

  5. Linux kernel的中断子系统之(五):驱动申请中断API

    返回目录:<ARM-Linux中断系统>. 总结:二重点区分了抢占式内核和非抢占式内核的区别:抢占式内核可以在内核空间进行抢占,通过对中断处理进行线程化可以提高Linux内核实时性. 三介 ...

  6. spring-boot-oracle spring-batch

    Install/Configure Oracle express Oracle xe installer for linux (I don't care if you're running linux ...

  7. python获取日期加减之后的日期

    python语言中的datetime模块可以利用其中的方法获取不同的日期,比如获取当前日期.明天.昨天.上个月.下个月和明年.下面利用几个实例说明这些日期的获取方法,操作如下:     第一步,利用d ...

  8. BZOJ_1828_[Usaco2010 Mar]balloc 农场分配_线段树

    BZOJ_1828_[Usaco2010 Mar]balloc 农场分配_线段树 Description Input 第1行:两个用空格隔开的整数:N和M * 第2行到N+1行:第i+1行表示一个整数 ...

  9. React从入门到放弃之前奏(5):ReactRouter4

    概念 安装:npm i -S react-router react-router-dom GitHub:ReactTraining/react-router React Router中有三种类型的组件 ...

  10. ISCC 2018 Writeup

    题解部分:Misc(除misc500).Web(除Only Admin.Only admin can see flag.有种你来绕.试试看).Reverse.Pwn.Mobile Misc( Auth ...