devbox
weixin_40725706
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Android Gradle defaultConfig详解及实用技巧

作者：weixin_40725706 | 2024-03-22 13:28:58

赞

踩

安卓读取buildtypes里面的buildconfigfield

实际项目中，都会应用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。

其中，一般项目中最常见的是application和library插件类型。

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

  1. apply plugin: 'com.android.application'
  2.  
  3. android {
  4.     compileSdkVersion 28
  5.     defaultConfig {
  6.         applicationId "com.happycorn"
  7.         minSdkVersion 15
  8.         targetSdkVersion 28
  9.         versionCode 1
  10.         versionName "1.0"
  11.         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
  12.         ...
  13.     }
  14.     buildTypes {
  15.         release {
  16.             minifyEnabled false
  17.             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
  18.         }
  19.         ...
  20.     }
  21.     
  22.     ...
  23. }
  24.  
  25. dependencies {
  26.     implementation fileTree(dir: 'libs', include: ['*.jar'])
  27.     ...
  28. }
  29. 复制代码

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

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

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

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

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

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

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

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

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

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

  1. defaultConfig {
  2.     ...
  3.     minSdkVersion 15
  4.     ...
  5. }
  6.  
  7. 等价于
  8. defaultConfig {
  9.     ...
  10.     minSdkVersion(15)
  11.     ...
  12. }
  13. 复制代码

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

如build.gradle中配置如下：

  1. android {
  2.     compileSdkVersion 28
  3.  
  4.     defaultConfig {
  5.         applicationId "com.happycorn"
  6.         minSdkVersion 15
  7.         targetSdkVersion 28
  8.         versionCode 1
  9.         versionName "1.0"
  10.     }
  11.  
  12.  
  13.     buildTypes {
  14.         release {
  15.             minifyEnabled false
  16.             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
  17.         }
  18.  
  19.         debug {
  20.  
  21.         }
  22.     }
  23.  
  24.  
  25.     flavorDimensions "default"
  26.  
  27.     productFlavors {
  28.         demo {
  29.             applicationIdSuffix "demo"
  30.         }
  31.  
  32.         full {
  33.             applicationIdSuffix "full"
  34.         }
  35.     }
  36.  
  37. }
  38. 复制代码

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

如其中的buildType为debug对应的BuildConfig文件内容为：

  1. /**
  2.  * Automatically generated file. DO NOT MODIFY
  3.  */
  4. package com.happycorn;
  5.  
  6. public final class BuildConfig {
  7.   public static final boolean DEBUG = Boolean.parseBoolean("true");
  8.   public static final String APPLICATION_ID = "com.happycorn.full";
  9.   public static final String BUILD_TYPE = "debug";
  10.   public static final String FLAVOR = "full";
  11.   public static final int VERSION_CODE = 1;
  12.   public static final String VERSION_NAME = "1.0";
  13. }
  14. 复制代码

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

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

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

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

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

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

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

  1. public final class BuildConfig {
  2.   ...
  3.   // Fields from default config.
  4.   public static final boolean INNER_TEST = false;
  5.   public static final String MODULE_NAME = "app";
  6. }
  7. 复制代码

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

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

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

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

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

  1. allprojects {
  2.     ...
  3.     afterEvaluate { project ->
  4.         def android = project.extensions.findByName("android")
  5.         if(android != null){
  6.             def defaultConfig =  android["defaultConfig"]
  7.             defaultConfig.buildConfigField("String", "MODULE_NAME", "\"${project.name}\"")
  8.         }
  9.     }
  10. }
  11. 复制代码

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

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

如：在buildType为debug中新增资源：

  1. buildTypes {
  2.     release {
  3.         minifyEnabled false
  4.         proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
  5.     }
  6.  
  7.     debug {
  8.         resValue("string", "app_name_debug", "HappyCornDebug")
  9.         resValue("integer", "token", "365")
  10.     }
  11. }
  12. 复制代码

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

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

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

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

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

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/weixin_40725706/article/detail/288490
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号