Android Gradle 3.1常用属性

迷南。 2022-05-26 04:35 373阅读 0赞

对于gradle的属性，大家可以自行查看文档，我主要从文档中总结一些常用的。  
文档：[http://google.github.io/android-gradle-dsl/][http_google.github.io_android-gradle-dsl]  
现在的Android Studio 3.0版本以上已经使用了3.0以上的gradle插件，所以直接看最新的文档。注意：本文的属性不管是application还是library都是android\{｝下的。只有极少数的属性是只在library有效的。

##### 一 aaptOptions #####

<table> 
 <thead> 
  <tr> 
   <th>property</th> 
   <th align="center">Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>additionalParameters</td> 
   <td align="center">指定aapt的参数，具体可通过aapt –help查看</td> 
  </tr> 
  <tr> 
   <td>cruncherEnabled</td> 
   <td align="center">3.1已经遗弃，由 BuildType.isCrunchPngs() 代替</td> 
  </tr> 
  <tr> 
   <td>cruncherProcesses</td> 
   <td align="center">指定压缩图片的进程数</td> 
  </tr> 
  <tr> 
   <td>failOnMissingConfigEntry</td> 
   <td align="center">不明觉厉，应该是找apk的config的入口如果报错会返回，知道大神麻烦评论告知一下</td> 
  </tr> 
  <tr> 
   <td>ignoreAssets/ignoreAssets</td> 
   <td align="center">这两个调用的是同一个方法，没有区别，忽略assets的文件，可以用通配符</td> 
  </tr> 
  <tr> 
   <td>noCompress</td> 
   <td align="center">指定不压缩的文件，指定为”“将会尝试关闭所有文件压缩</td> 
  </tr> 
 </tbody> 
</table>

##### 二、adbExecutable #####

一个返回File的方法，具体是adb.exe的路径，感觉没什么卵用。

##### 三、adbOptions #####

<table> 
 <thead> 
  <tr> 
   <th>property</th> 
   <th align="center">Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>installOptions</td> 
   <td align="center">安装apk时的参数，可通过adb –help查看</td> 
  </tr> 
  <tr> 
   <td>timeOutInMs</td> 
   <td align="center">adb操作的超时时间</td> 
  </tr> 
 </tbody> 
</table>

##### 四、applicationVariants #####

项目的所有构建变体，简单查看

applicationVariants.all{
            println it.name
        }

##### 五、buildToolsVersion #####

SDK构建工具的版本，3.1可以不用指定，默认使用的是27.0.3，不知道是不是我的电脑的最新版本是27.0.3.

##### 六、buildTypes #####

关于构建变体，官网上的文档写的十分详细，我就不解释了，直接上车[https://developer.android.com/studio/build/build-variants.html\#build-types][https_developer.android.com_studio_build_build-variants.html_build-types]，只说一下其他属性。

<table> 
 <thead> 
  <tr> 
   <th>property</th> 
   <th align="center">Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>applicationIdSuffix</td> 
   <td align="center">applicationId添加的后缀</td> 
  </tr> 
  <tr> 
   <td>consumerProguardFiles</td> 
   <td align="center">添加混淆文件</td> 
  </tr> 
  <tr> 
   <td>crunchPngs</td> 
   <td align="center">是否压缩图片</td> 
  </tr> 
  <tr> 
   <td>debuggable</td> 
   <td align="center">是否允许调试</td> 
  </tr> 
  <tr> 
   <td>jniDebuggable</td> 
   <td align="center">是否允许调试jni代码</td> 
  </tr> 
  <tr> 
   <td>manifestPlaceholders</td> 
   <td align="center">清单文件占位符</td> 
  </tr> 
  <tr> 
   <td>matchingFallbacks</td> 
   <td align="center">这是3.0.0之后才有的属性，指定对应的buildType。例如：app模块有一个stage的buildType，然后library没有stage的buildType，就会报错。Unable to resolve dependency for ‘:app@stage/compileClasspath’: Could not resolve project :library.这时候可以通过这个属性来指定。</td> 
  </tr> 
  <tr> 
   <td>minifyEnabled</td> 
   <td align="center">开启混淆优化</td> 
  </tr> 
  <tr> 
   <td>multiDexEnabled/multiDexKeepFile/multiDexKeepProguard</td> 
   <td align="center">多dex的属性指定，参考官网： <a href="https://developer.android.com/studio/build/multidex" rel="nofollow">https://developer.android.com/studio/build/multidex</a></td> 
  </tr> 
  <tr> 
   <td>postprocessing</td> 
   <td align="center">文档没说，直说以后可能会改变，不管</td> 
  </tr> 
  <tr> 
   <td>proguardFiles</td> 
   <td align="center">指定混淆文件，默认这两个proguard-android.txt proguard-android-optimize.txt</td> 
  </tr> 
  <tr> 
   <td>postprocessing</td> 
   <td align="center">文档没说，直说以后可能会改变，不管</td> 
  </tr> 
  <tr> 
   <td>pseudoLocalesEnabled</td> 
   <td align="center">可以为本地化的语言文字对应调整UI，比如文字左对齐或者右对齐</td> 
  </tr> 
  <tr> 
   <td>renderscriptDebuggable/renderscriptOptimLevel</td> 
   <td align="center">渲染脚本相关，反正没用过</td> 
  </tr> 
  <tr> 
   <td>shrinkResources</td> 
   <td align="center">压缩资源，必须开启minifyEnabled才有用</td> 
  </tr> 
  <tr> 
   <td>signingConfig</td> 
   <td align="center">签名配置</td> 
  </tr> 
  <tr> 
   <td>testCoverageEnabled</td> 
   <td align="center">测试覆盖率</td> 
  </tr> 
  <tr> 
   <td>useProguard</td> 
   <td align="center">使用instant run的时候可以用此变量关闭混淆</td> 
  </tr> 
  <tr> 
   <td>versionNameSuffix</td> 
   <td align="center">版本名后缀</td> 
  </tr> 
  <tr> 
   <td>zipAlignEnabled</td> 
   <td align="center">优化对齐，可以减少apk内存使用</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
  <tr> 
   <th>method</th> 
   <th align="center">usage</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>void buildConfigField(String type, String name, String value)</td> 
   <td align="center">为生成的BuildConfig类添加属性，一般来说一个module都会生成一个BuildConfig类，可以参考<a href="https://blog.csdn.net/a568478312/article/details/74989722" rel="nofollow">https://blog.csdn.net/a568478312/article/details/74989722</a></td> 
  </tr> 
  <tr> 
   <td>BuildType consumerProguardFiles(Object… proguardFiles)</td> 
   <td align="center">往application project传递proguard文件，该属性只在library project有效</td> 
  </tr> 
  <tr> 
   <td>ExternalNativeBuildOptions externalNativeBuild(Action action)</td> 
   <td align="center">native参数配置，后面说</td> 
  </tr> 
  <tr> 
   <td>DefaultBuildType initWith(BuildType that)</td> 
   <td align="center">复制传递的buildType所有属性</td> 
  </tr> 
  <tr> 
   <td>BuildType proguardFiles(Object… files)</td> 
   <td align="center">添加新的proguard文件</td> 
  </tr> 
  <tr> 
   <td>void resValue(String type, String name, String value)</td> 
   <td align="center">添加新的生成资源</td> 
  </tr> 
  <tr> 
   <td>BuildType setProguardFiles(Iterable proguardFileIterable)</td> 
   <td align="center">设置混淆文件</td> 
  </tr> 
 </tbody> 
</table>

##### 1、externalNativeBuild #####

注意这里是buildType下面的属性，通过文档看这个和android\{\}下的有区别。

<table> 
 <thead> 
  <tr> 
   <th>property</th> 
   <th align="center">Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>cmake</td> 
   <td align="center">cmake配置参数</td> 
  </tr> 
  <tr> 
   <td>ndkBuild</td> 
   <td align="center">ndk-build配置参数</td> 
  </tr> 
 </tbody> 
</table>

这两个的属性都是下面几个

*  abiFilters 指定cpu架构
 *  arguments 指定对应的参数
 *  cFlags c编译的flags
 *  cppFlags c++编译的flags
 *  targets 指定需要编译的可执行文件

##### 七、 compileOptions #####

<table> 
 <thead> 
  <tr> 
   <th>property</th> 
   <th align="center">usage</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>encoding</td> 
   <td align="center">java的编码</td> 
  </tr> 
  <tr> 
   <td>incremental</td> 
   <td align="center">java编译是否使用gradle的增量模型</td> 
  </tr> 
  <tr> 
   <td>sourceCompatibility</td> 
   <td align="center">java原文件的语言版本</td> 
  </tr> 
  <tr> 
   <td>targetCompatibility</td> 
   <td align="center">java字节码的语言版本</td> 
  </tr> 
 </tbody> 
</table>

##### 八、compileSdkVersion #####

指定编译的api 版本

##### 九、dataBinding #####

一个xml绑定数据的库，参考[https://developer.android.com/topic/libraries/data-binding/][https_developer.android.com_topic_libraries_data-binding]

##### (十) defaultConfig #####

这里有部分和buildType想同，所以只列出特有的部分。

<table> 
 <thead> 
  <tr> 
   <th>property</th> 
   <th align="center">Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>applicationId</td> 
   <td align="center">应用的id</td> 
  </tr> 
  <tr> 
   <td>dimension</td> 
   <td align="center">风味维度，这个参考上面的构建变体结合使用</td> 
  </tr> 
  <tr> 
   <td>javaCompileOptions</td> 
   <td align="center">这里只能配置annotationProcessorOptions 注解处理器的参数，然而文档里直接什么都没有写，不明所以</td> 
  </tr> 
  <tr> 
   <td>ndk</td> 
   <td align="center">只能指定abifilter</td> 
  </tr> 
  <tr> 
   <td>testApplicationId/testApplicationId/testApplicationId/testApplicationId/testInstrumentationRunnerArguments</td> 
   <td align="center">几个测试的，没有怎么用过，不了解</td> 
  </tr> 
  <tr> 
   <td>vectorDrawables</td> 
   <td align="center">构建vectorDrawalbe的支持，有两个属性。generatedDensities：指定生成PNG的屏幕密度；useSupportLibrary：使用运行时的库对vectorDrawable的支持。</td> 
  </tr> 
  <tr> 
   <td>versionCode</td> 
   <td align="center">版本号</td> 
  </tr> 
  <tr> 
   <td>versionName</td> 
   <td align="center">版本名</td> 
  </tr> 
  <tr> 
   <td>versionNameSuffix</td> 
   <td align="center">版本名后缀</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
  <tr> 
   <th>method</th> 
   <th align="center">usage</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>versionCode</td> 
   <td align="center">版本号</td> 
  </tr> 
  <tr> 
   <td>versionName</td> 
   <td align="center">版本名</td> 
  </tr> 
  <tr> 
   <td>versionNameSuffix</td> 
   <td align="center">版本名后缀</td> 
  </tr> 
  <tr> 
   <td>void maxSdkVersion(int maxSdkVersion)</td> 
   <td align="center">最大支持的api版本</td> 
  </tr> 
  <tr> 
   <td>void minSdkVersion(int minSdkVersion)</td> 
   <td align="center">最小支持的api版本</td> 
  </tr> 
  <tr> 
   <td>void missingDimensionStrategy(String dimension, String requestedValue)</td> 
   <td align="center">gradle3.0.0以上版本才有，指定维度缺失策略，也就是说app有的Dimension而library里没有找到对应的时候，就靠这个来指定策略，可以在productFlavors设置来单独覆盖</td> 
  </tr> 
  <tr> 
   <td>void resConfig(String config)</td> 
   <td align="center">指定可选的资源来进行保留，用来排除某些不需要的语言资源等</td> 
  </tr> 
  <tr> 
   <td>void targetSdkVersion(int targetSdkVersion)</td> 
   <td align="center">指定target的api版本，比如如果设置小于23，那么动态申请权限将不会应用</td> 
  </tr> 
 </tbody> 
</table>

##### 十一、defaultPublishConfig #####

指定发布到远程仓库的版本名，不指定默认发布release,如果设置了productFlavors，则需要明确指出。本地模块不需要指定此属性。

##### 十二、dexOptions #####

<table> 
 <thead> 
  <tr> 
   <th>property</th> 
   <th align="center">Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>additionalParameters</td> 
   <td align="center">dx命令的参数</td> 
  </tr> 
  <tr> 
   <td>javaMaxHeapSize</td> 
   <td align="center">指定虚拟机的-Xmx参数，例如 2048m</td> 
  </tr> 
  <tr> 
   <td>jumboMode</td> 
   <td align="center">该模式会将字符串数量由2^16增大到2^32</td> 
  </tr> 
  <tr> 
   <td>keepRuntimeAnnotatedClasses</td> 
   <td align="center">保留运行时的注解</td> 
  </tr> 
  <tr> 
   <td>maxProcessCount</td> 
   <td align="center">dex的最大进程数，默认4</td> 
  </tr> 
  <tr> 
   <td>preDexLibraries</td> 
   <td align="center">预编译库</td> 
  </tr> 
  <tr> 
   <td>threadCount</td> 
   <td align="center">dx的线程数，默认4</td> 
  </tr> 
 </tbody> 
</table>

##### 十三、externalNativeBuild #####

注意这个快是在android\{\}下面的，属性如下：

##### 1.cmake #####

*  buildStagingDirectory 指定native编译输出目录
 *  path 　　　　　　　 指定cmakeLists.txt的相对路径
 *  version 　　　　　　指定使用CMake的版本呢

##### 2.ndkBuild #####

*  buildStagingDirectory 指定native编译输出目录
 *  path 　　　　　　　 指定Android.mk的相对路径

##### 十四、flavorDimensionList #####

通过使用flavorDimensions指定维度列表，参考buildType的变体构建，结合使用。

##### 十五、lintOptions #####

<table> 
 <thead> 
  <tr> 
   <th>property</th> 
   <th align="center">Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>abortOnError</td> 
   <td align="center">发现错误是否停止</td> 
  </tr> 
  <tr> 
   <td>absolutePaths</td> 
   <td align="center">错误输出是否显示完整路径</td> 
  </tr> 
  <tr> 
   <td>check</td> 
   <td align="center">指定需要检查的id，可以通过lint –list查看所有支持的id</td> 
  </tr> 
  <tr> 
   <td>checkAllWarnings</td> 
   <td align="center">是否检查所有警告</td> 
  </tr> 
  <tr> 
   <td>checkReleaseBuilds</td> 
   <td align="center">是否检查releast的构建</td> 
  </tr> 
  <tr> 
   <td>disable</td> 
   <td align="center">禁止对应id的检查</td> 
  </tr> 
  <tr> 
   <td>enable</td> 
   <td align="center">使能对应id的检查</td> 
  </tr> 
  <tr> 
   <td>explainIssues</td> 
   <td align="center">是否需要错误解释，注意html和xml报告是无条件有解释的，忽略这个设置的。</td> 
  </tr> 
  <tr> 
   <td>htmlOutput</td> 
   <td align="center">html报告的输出路径</td> 
  </tr> 
  <tr> 
   <td>htmlReport</td> 
   <td align="center">是否需要html报告</td> 
  </tr> 
  <tr> 
   <td>ignoreWarnings</td> 
   <td align="center">是否忽略警告</td> 
  </tr> 
  <tr> 
   <td>lintConfig</td> 
   <td align="center">配置默认lint配置文件，可以参考<a href="https://developer.android.com/studio/write/lint#pref" rel="nofollow">https://developer.android.com/studio/write/lint#pref</a></td> 
  </tr> 
  <tr> 
   <td>noLines</td> 
   <td align="center">是否包含资源行号</td> 
  </tr> 
  <tr> 
   <td>quiet</td> 
   <td align="center">是否使用安静模式，例如不输出路径或者报告文件等</td> 
  </tr> 
  <tr> 
   <td>severityOverrides</td> 
   <td align="center">覆盖默写id的等级，比如原本资源id为error的覆盖成fatal</td> 
  </tr> 
  <tr> 
   <td>showAll</td> 
   <td align="center">是否需要包含所有输出</td> 
  </tr> 
  <tr> 
   <td>textOutput</td> 
   <td align="center">text报告输出路径</td> 
  </tr> 
  <tr> 
   <td>textReport</td> 
   <td align="center">是否需要text报告</td> 
  </tr> 
  <tr> 
   <td>warningsAsErrors</td> 
   <td align="center">是否将警告置为错误来处理</td> 
  </tr> 
  <tr> 
   <td>xmlOutput</td> 
   <td align="center">xml报告路径</td> 
  </tr> 
  <tr> 
   <td>xmlReport</td> 
   <td align="center">是否需要xml报告</td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
  <tr> 
   <th>Methods</th> 
   <th align="center">Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>check</td> 
   <td align="center">添加需要检查的id</td> 
  </tr> 
  <tr> 
   <td>disable</td> 
   <td align="center">添加禁用的id</td> 
  </tr> 
  <tr> 
   <td>enable</td> 
   <td align="center">添加使能id</td> 
  </tr> 
  <tr> 
   <td>error</td> 
   <td align="center">将指定id的等级改为error</td> 
  </tr> 
  <tr> 
   <td>fatal</td> 
   <td align="center">将指定id的等级改为fatal</td> 
  </tr> 
  <tr> 
   <td>ignore</td> 
   <td align="center">将指定id的等级改为ignore</td> 
  </tr> 
  <tr> 
   <td>warning</td> 
   <td align="center">将指定id的等级改为warning</td> 
  </tr> 
 </tbody> 
</table>

##### 十六、ndkDirectory #####

配置gradle使用的ndk目录

##### 十七、packagingOptions #####

这个主要是处理打包时候的一些文件冲突。

<table> 
 <thead> 
  <tr> 
   <th>property</th> 
   <th align="center">Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>excludes</td> 
   <td align="center">排除文件</td> 
  </tr> 
  <tr> 
   <td>merges</td> 
   <td align="center">合并发现的冲突文件</td> 
  </tr> 
  <tr> 
   <td>pickFirsts</td> 
   <td align="center">发现冲突首选第一次找到的文件</td> 
  </tr> 
 </tbody> 
</table>

##### 十八、productFlavors #####

同样参考构建变体。

##### 十九、resourcePrefix #####

指定资源前缀，主要是用来防止library的资源和其他module产生冲突的时候使用。

##### 二十、sdkDirectory #####

配置Gradle使用的SDK目录。

##### 二十一、signingConfigs #####

配置签名，这个就不展开说了，搜一下一堆。

##### 二十二、sourceSets #####

配置各种文件的目录，平时用到都是默认目录，可以使用gradlew sourceSet查看默认目录。这个看需求来定是否需要配置，也不展开说了，直接百度一堆。

##### 二十三、splits #####

配置apk拆分选项，可以通过区分api,density，language等来减少apk大小。具体使用可以参考  
[https://developer.android.com/studio/build/configure-apk-splits][https_developer.android.com_studio_build_configure-apk-splits]  
[https://developer.android.com/topic/instant-apps/guides/config-splits][https_developer.android.com_topic_instant-apps_guides_config-splits]

##### 二十四、variantFilter #####

配置Android插件需要保留或者排除的变体。其实就是过滤变体罢了。

android {
        ...
        variantFilter { variant ->
    
            def buildTypeName = variant.buildType*.name
            def flavorName = variant.flavors*.name
    
            if (flavorName.contains("dev") && buildTypeName.contains("release")) {
                // Tells Gradle to ignore each variant that satisfies the conditions above.
                setIgnore(true)
            }
        }
    }

##### 二十五、useLibrary #####

在classpath指定library，基本上没什么卵用。

android {
        // Adds a platform library that ships with the Android SDK.
        useLibrary 'org.apache.http.legacy'
    }

[http_google.github.io_android-gradle-dsl]: http://google.github.io/android-gradle-dsl/
[https_developer.android.com_studio_build_build-variants.html_build-types]: https://developer.android.com/studio/build/build-variants.html#build-types
[https_developer.android.com_topic_libraries_data-binding]: https://developer.android.com/topic/libraries/data-binding/
[https_developer.android.com_studio_build_configure-apk-splits]: https://developer.android.com/studio/build/configure-apk-splits
[https_developer.android.com_topic_instant-apps_guides_config-splits]: https://developer.android.com/topic/instant-apps/guides/config-splits