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

史上最全的Android build.gradle 配置介绍_pseudolocalesenabled

作者：小小林熬夜学编程 | 2024-03-18 20:13:21

赞

踩

pseudolocalesenabled

Android Studio是采用gradle来构建项目的，gradle是基于groovy语言的，如果只是用它构建普通Android项目的话，是可以不去学groovy的。当我们创建一个Android项目时会包含两个Android build.gradle配置详解文件，如下图：

build.gradle位置.png

一、Project的build.gradle文件：

对应的build.gradle代码如下：

  1. // Top-level build file where you can add configuration options common to all sub-projects/modules.
  2.  
  3. buildscript {//这里是gradle脚本执行所需依赖，分别是对应的maven库和插件
  4.     
  5.     repositories {
  6.         google()//从Android Studio3.0后新增了google()配置，可以引用google上的开源项目
  7.         jcenter()//是一个类似于github的代码托管仓库，声明了jcenter()配置，可以轻松引用 jcenter上的开源项目
  8.     }
  9.     dependencies {
  10.         classpath 'com.android.tools.build:gradle:3.0.0'此处是android的插件gradle，gradle是一个强大的项目构建工具
  11.         
  12.  
  13.         // NOTE: Do not place your application dependencies here; they belong
  14.         // in the individual module build.gradle files
  15.     }
  16. }
  17.  
  18. allprojects {//这里是项目本身需要的依赖，比如项目所需的maven库
  19.     repositories {
  20.         google()
  21.         jcenter()
  22.     }
  23. }
  24.  
  25. // 运行gradle clean时，执行此处定义的task任务。
  26. // 该任务继承自Delete，删除根目录中的build目录。
  27. // 相当于执行Delete.delete(rootProject.buildDir)。
  28. // gradle使用groovy语言，调用method时可以不用加（）。
  29. task clean(type: Delete) {
  30.     delete rootProject.buildDir
  31. }
  • buildscript{}闭包里是gradle脚本执行所需依赖，分别是对应的maven库和插件。
  • allprojects{}闭包里是项目本身需要的依赖，比如项目所需的maven库。
  • task clean(type: Delete){}是运行gradle clean时，执行此处定义的task任务，该任务继承自Delete，删除根目录中的build目录。其中buildscript包含repositories闭包和dependencies闭包。

repositories{}闭包：配置远程仓库

该闭包中声明了jcenter()和google()的配置，其中jcenter是一个代码托管仓库，上面托管了很多Android开源项目，在这里配置了jcenter后我们可以在项目中方便引用jcenter上的开源项目，从Android Studio3.0后新增了google()配置，可以引用google上的开源项目。

dependencies{}闭包：配置构建工具

该闭包使用classpath声明了一个Gradle插件，由于Gradle并不只是用来构建Android项目，因此此处引入相关插件来构建Android项目，其中'3.0.0'为该插件的版本号，可以根据最新的版本号来调整。

二、Module的build.gradle文件：

从文件内容可以看出，主要分为三大部分，如下图所示：

 

Module的build.gradle.png

1、apply plugin：

  1. // 声明是Android程序，
  2. //com.android.application 表示这是一个应用程序模块
  3. //com.android.library 标识这是一个库模块
  4. //而这区别：前者可以直接运行，后着是依附别的应用程序运行
  5. apply plugin: 'com.android.application'

文件中第一行使用apply plugin表示应用了一个插件，该插件一般有两种值可选：

  • 'com.android.application'，表示该模块为应用程序模块，可以直接运行，打包得到的是.apk文件
  • 'com.android.library'，表示该模块为库模块，只能作为代码库依附于别的应用程序模块来运行，打包得到的是.aar文件

2、android{}闭包：

这个闭包主要为了配置项目构建的各种属性：

2.1、添加signingConfigs{}闭包：

  1.     signingConfigs {// 自动化打包配置
  2.         release {// 线上环境
  3.             keyAlias 'test'
  4.             keyPassword '123456'
  5.             storeFile file('test.keystore')
  6.             storePassword '123456'
  7.         }
  8.         debug {// 开发环境
  9.             keyAlias 'test'
  10.             keyPassword '123456'
  11.             storeFile file('test.keystore')
  12.             storePassword '123456'
  13.         }
  14.     }

可以手动添加签名配置，也可以通过Project Structure 选中app，点击Singing添加，具体步骤如下图所示：

 

配置Singing.png

 

签名配置完成后可以方便带签名打包，在module的Build Variants中有两个Type，分别是debug和release，可以选择任意一个类型进行打包，并且他们会利用各自配置的Key进行打包，执行 Run app或者Build->Build apk就会自动在module name/app/build/outputs/apk路径下生成Apk文件。另一种打包方式是Build->Generate Signed APK填写签名信息生成Apk。

2.2、compileSdkVersion：设置编译时用的Android版本

2.3、buildToolsVersion：设置编译时使用的构建工具的版本，Android Studio3.0后去除此项配置

2.4、defaultConfig{}闭包：

  1.     compileSdkVersion 27//设置编译时用的Android版本
  2.     defaultConfig {
  3.         applicationId "com.billy.myapplication"//项目的包名
  4.         minSdkVersion 16//项目最低兼容的版本
  5.         targetSdkVersion 27//项目的目标版本
  6.         versionCode 1//版本号
  7.         versionName "1.0"//版本名称
  8.         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"//表明要使用AndroidJUnitRunner进行单元测试
  9.     }
  • applicationId：指定了项目的包名。
  • minSdkVersion：指定项目最低兼容的版本，如果设备小于这个版本或者大于maxSdkVersion(一般不用)将无法安装这个应用，这里指定为16，表示最低兼容到Android 4.1系统。
  • targetSdkVersion：指定项目的目标版本，表示在该目标版本上已经做过充分测试，系统会为该应用启动一些对应该目标系统的最新功能特性，Android系统平台的行为变更，只有targetSdkVersion的属性值被设置为大于或等于该系统平台的API版本时，才会生效。例如，若指定targetSdkVersion值为22，则表示该程序最高只在Android5.1版本上做过充分测试，在Android6.0系统上（对应targetSdkVersion为23）拥有的新特性如系统运行时权限等功能就不会被启用。
  • versionCode：表示版本号，一般每次打包上线时该值只能增加，打包后看不见。
  • versionName：表示版本名称，展示在应用市场上。
  • testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"表明要使用AndroidJUnitRunner进行单元测试。

2.5、 buildTypes{}闭包：

这个闭包主要指定生成安装文件的主要配置，一般包含两个子闭包，一个是debug闭包，用于指定生成测试版安装文件的配置，可以忽略不写；另一个是release闭包，用于指定生成正式版安装文件的配置。两者能配置的参数相同，最大的区别默认属性配置不一样，两种模式支持的属性配置如下图：

 

buildTypes配置.png

  1.     buildTypes {// 生产/测试环境配置
  2.         release {// 生产环境
  3.             buildConfigField("boolean", "LOG_DEBUG", "false")//配置Log日志
  4.             buildConfigField("String", "URL_PERFIX", "\"https://release.cn/\"")// 配置URL前缀
  5.             minifyEnabled false//是否对代码进行混淆
  6.             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'//指定混淆的规则文件
  7.             signingConfig signingConfigs.release//设置签名信息
  8.             pseudoLocalesEnabled false//是否在APK中生成伪语言环境，帮助国际化的东西，一般使用的不多
  9.             zipAlignEnabled true//是否对APK包执行ZIP对齐优化，减小zip体积，增加运行效率
  10.             applicationIdSuffix 'test'//在applicationId 中添加了一个后缀，一般使用的不多
  11.             versionNameSuffix 'test'//在applicationId 中添加了一个后缀，一般使用的不多
  12.         }
  13.         debug {// 测试环境
  14.             buildConfigField("boolean", "LOG_DEBUG", "true")//配置Log日志
  15.             buildConfigField("String", "URL_PERFIX", "\"https://test.com/\"")// 配置URL前缀
  16.             minifyEnabled false//是否对代码进行混淆
  17.             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'//指定混淆的规则文件
  18.             signingConfig signingConfigs.debug//设置签名信息
  19.             debuggable false//是否支持断点调试
  20.             jniDebuggable false//是否可以调试NDK代码
  21.             renderscriptDebuggable false//是否开启渲染脚本就是一些c写的渲染方法
  22.             zipAlignEnabled true//是否对APK包执行ZIP对齐优化，减小zip体积，增加运行效率
  23.             pseudoLocalesEnabled false//是否在APK中生成伪语言环境，帮助国际化的东西，一般使用的不多
  24.             applicationIdSuffix 'test'//在applicationId 中添加了一个后缀，一般使用的不多
  25.             versionNameSuffix 'test'//在applicationId 中添加了一个后缀，一般使用的不多
  26.         }
  27.     }

release{}闭包和debug{}闭包两者能配置的参数相同，最大的区别默认属性配置不一样：

  • minifyEnabled：表明是否对代码进行混淆，true表示对代码进行混淆，false表示对代码不进行混淆，默认的是false。
  • proguardFiles：指定混淆的规则文件，这里指定了proguard-android.txt文件和proguard-rules.pro文件两个文件，proguard-android.txt文件为默认的混淆文件，里面定义了一些通用的混淆规则。proguard-rules.pro文件位于当前项目的根目录下，可以在该文件中定义一些项目特有的混淆规则。
  • buildConfigField：用于解决Beta版本服务和Release版本服务地址不同或者一些Log打印需求控制的。例如：配置buildConfigField("boolean", "LOG_DEBUG", "true")，这个方法接收三个非空的参数，第一个：确定值的类型，第二个：指定key的名字，第三个：传值，调用的时候BuildConfig.LOG_DEBUG即可调用。
  • debuggable：表示是否支持断点调试，release默认为false，debug默认为true。
  • jniDebuggable：表示是否可以调试NDK代码，使用lldb进行c和c++代码调试，release默认为false
  • signingConfig：设置签名信息，通过signingConfigs.release或者signingConfigs.debug，配置相应的签名，但是添加此配置前必须先添加signingConfigs闭包，添加相应的签名信息。
  • renderscriptDebuggable：表示是否开启渲染脚本就是一些c写的渲染方法，默认为false。
  • renderscriptOptimLevel：表示渲染等级，默认是3。
  • pseudoLocalesEnabled：是否在APK中生成伪语言环境，帮助国际化的东西，一般使用的不多。
  • applicationIdSuffix：和defaultConfig中配置是一的，这里是在applicationId 中添加了一个后缀，一般使用的不多。
  • versionNameSuffix：表示添加版本名称的后缀，一般使用的不多。
  • zipAlignEnabled：表示是否对APK包执行ZIP对齐优化，减小zip体积，增加运行效率，release和debug默认都为true。

2.6、sourceSets{}闭包：配置目录指向

  1.     sourceSets {//目录指向配置
  2.         main {
  3.             jniLibs.srcDirs = ['libs']//指定lib库目录
  4.         }
  5.     }

 

 

配置 jniLibs.srcDirs = ['libs']，可以在Android studio的Android视图下生成jniLibs文件夹，可以方便我们存放jar包和库文件，其中Android视图下的jniLibs和project视图下的libs指向同一文件夹（app→libs），如下图所示：

jniLibs.png

2.7、packagingOptions{}闭包：打包时的相关配置

当项目中依赖的第三方库越来越多时，有可能会出现两个依赖库中存在同一个（名称）文件。如果这样，Gradle在打包时就会提示错误（警告）。那么就可以根据提示，然后使用以下方法将重复的文件剔除，比较常用的是通过exclude去除重复的文件，例如：

  1.     packagingOptions{
  2.         //pickFirsts做用是 当有重复文件时 打包会报错 这样配置会使用第一个匹配的文件打包进入apk
  3.         // 表示当apk中有重复的META-INF目录下有重复的LICENSE文件时  只用第一个 这样打包就不会报错
  4.         pickFirsts = ['META-INF/LICENSE']
  5.  
  6.         //merges何必 当出现重复文件时 合并重复的文件 然后打包入apk
  7.         //这个是有默认值得 merges = [] 这样会把默默认值去掉  所以我们用下面这种方式 在默认值后添加
  8.         merge 'META-INF/LICENSE'
  9.  
  10.         //这个是在同时使用butterknife、dagger2做的一个处理。同理，遇到类似的问题，只要根据gradle的提示，做类似处理即可。
  11.         exclude 'META-INF/services/javax.annotation.processing.Processor'
  12.     }

2.8、productFlavors{}闭包：多个渠道配置

这个配置是经常会使用到的，通常在适配多个渠道的时候，需要为特定的渠道做部分特殊的处理，比如设置不同的包名、应用名等。场景：当我们使用友盟统计时，通常需要设置一个渠道ID，那么我们就可以利用productFlavors来生成对应渠道信息的包，如：

  1. android {  
  2.     productFlavors {
  3.         wandoujia {
  4.             //豌豆荚渠道包配置
  5.             manifestPlaceholders = [UMENG_CHANNEL_VALUE: "wandoujia"]
  6.             //manifestPlaceholders的使用在后续章节（AndroidManifest里的占位符）中介绍
  7.         }
  8.         xiaomi {
  9.             manifestPlaceholders = [UMENG_CHANNEL_VALUE: "xiaomi"]
  10.             applicationId "com.wiky.gradle.xiaomi" //配置包名
  11.  
  12.         }
  13.         _360 {
  14.             manifestPlaceholders = [UMENG_CHANNEL_VALUE: "_360"]
  15.         }
  16.         //...
  17.     }  
  18. }

当然也有更简洁的方式：

  1. android {  
  2.     productFlavors {
  3.         wandoujia {}
  4.         xiaomi {}
  5.         _360 {}
  6.        //...
  7.     }  
  8.  
  9.     productFlavors.all { 
  10.         //批量修改，类似一个循序遍历
  11.         flavor -> flavor.manifestPlaceholders = [UMENG_CHANNEL_VALUE: name] 
  12.     }
  13. }

配置完之后，在命令行窗口中（Terminal）中输入gradlew assembleRelease（windows）即可开始打包，在Mac系统中对应指令应该是./gradlew assembleRelease。当然，如果想要debug版本的包，将指令中assembleRelease改为assembleDebug即可。最后生成的包还是在app/build/outputs/apk中，默认命名格式如app-wandoujia-release-unsigned.apk，在module的Build Variants中可以选择相应的渠道。
注：Android Studio3.0需在主app的build.gradle里面的
defaultConfig {
targetSdkVersion：***
minSdkVersion ：***
versionCode：***
versionName ：***
//版本名后面添加一句话，意思就是flavor dimension 它的维度就是该版本号，这样维度就是都是统一的了
flavorDimensions "versionCode"
}

2.9、lintOptions{}闭包：代码扫描分析

Lint 是Android Studio 提供的 代码扫描分析工具，它可以帮助我们发现代码结构/质量问题，同时提供一些解决方案，而且这个过程不需要我们手写测试用例。

Lint 发现的每个问题都有描述信息和等级（和测试发现 bug 很相似），我们可以很方便地定位问题，同时按照严重程度进行解决。

  1.     //程序在编译的时候会检查lint，有任何错误提示会停止build，我们可以关闭这个开关
  2.     lintOptions {
  3.         abortOnError false //即使报错也不会停止打包
  4.         checkReleaseBuilds false  //打包release版本的时候进行检测
  5.     }

3、dependencies{}闭包：

该闭包定义了项目的依赖关系，一般项目都有三种依赖方式：本地依赖、库依赖和远程依赖。本地依赖可以对本地的jar包或目录添加依赖关系，库依赖可以对项目中的库模块添加依赖关系，远程依赖可以对jcener库上的开源项目添加依赖关系。从Android Studio3.0后compile引入库不在使用，而是通过api和implementation，api完全等同于以前的compile，用api引入的库整个项目都可以使用，用implementation引入的库只有对应的Module能使用，其他Module不能使用，由于之前的项目统一用compile依赖，导致的情况就是模块耦合性太高，不利于项目拆解，使用implementation之后虽然使用起来复杂了但是做到降低偶合兴提高安全性。

  1. dependencies {//项目的依赖关系
  2.     implementation fileTree(include: ['*.jar'], dir: 'libs')//本地jar包依赖
  3.     implementation 'com.android.support:appcompat-v7:27.1.1'//远程依赖
  4.     implementation 'com.android.support.constraint:constraint-layout:1.1.2'
  5.     testImplementation 'junit:junit:4.12'//声明测试用例库
  6.     androidTestImplementation 'com.android.support.test:runner:1.0.2'
  7.     androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
  8. }
  • implementation fileTree(include: ['*.jar'], dir: 'libs')：implementation fileTree是一个本地依赖声明，表示将libs目录下所有.jar后缀的文件都添加到项目的构建路径当中。
  • implementation 'com.android.support:appcompat-v7:27.1.1'：implementation语句为 远程依赖声明，'com.android.support:appcompat-v7:27.1.1'为一个标准的远程依赖库格式，其中com.android.support为域名部分，用于区分不同公司的库；appcompat-v7为组件名称，用于区分同一个公司的不同库；27.1.1为版本号，用于区分同一个库的不同版本。加上这句声明后，Gradle在构建项目时会先检查一下本地是否已经缓存过该库，若没有缓存则自动联网下载，下载后自动添加到项目的构建路径中去。
  • testImplementation和androidTestImplementation：表示声明测试用例库。

Module完整的build.gradle配置如下：

  1. // 声明是Android程序，
  2. //com.android.application 表示这是一个应用程序模块
  3. //com.android.library 标识这是一个库模块
  4. //而这区别：前者可以直接运行，后着是依附别的应用程序运行
  5. apply plugin: 'com.android.application'
  6.  
  7. android {
  8.     signingConfigs {// 自动化打包配置
  9.         release {// 线上环境
  10.             keyAlias 'test'
  11.             keyPassword '123456'
  12.             storeFile file('test.jks')
  13.             storePassword '123456'
  14.         }
  15.         debug {// 开发环境
  16.             keyAlias 'test'
  17.             keyPassword '123456'
  18.             storeFile file('test.jks')
  19.             storePassword '123456'
  20.         }
  21.     }
  22.     compileSdkVersion 27//设置编译时用的Android版本
  23.     defaultConfig {
  24.         applicationId "com.billy.myapplication"//项目的包名
  25.         minSdkVersion 16//项目最低兼容的版本
  26.         targetSdkVersion 27//项目的目标版本
  27.         versionCode 1//版本号
  28.         versionName "1.0"//版本名称
  29.         flavorDimensions "versionCode"
  30.         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"//表明要使用AndroidJUnitRunner进行单元测试
  31.     }
  32.     buildTypes {// 生产/测试环境配置
  33.         release {// 生产环境
  34.             buildConfigField("boolean", "LOG_DEBUG", "false")//配置Log日志
  35.             buildConfigField("String", "URL_PERFIX", "\"https://release.cn/\"")// 配置URL前缀
  36.             minifyEnabled false//是否对代码进行混淆
  37.             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'//指定混淆的规则文件
  38.             signingConfig signingConfigs.release//设置签名信息
  39.             pseudoLocalesEnabled false//是否在APK中生成伪语言环境，帮助国际化的东西，一般使用的不多
  40.             zipAlignEnabled true//是否对APK包执行ZIP对齐优化，减小zip体积，增加运行效率
  41.             applicationIdSuffix 'test'//在applicationId 中添加了一个后缀，一般使用的不多
  42.             versionNameSuffix 'test'//在applicationId 中添加了一个后缀，一般使用的不多
  43.         }
  44.         debug {// 测试环境
  45.             buildConfigField("boolean", "LOG_DEBUG", "true")//配置Log日志
  46.             buildConfigField("String", "URL_PERFIX", "\"https://test.com/\"")// 配置URL前缀
  47.             minifyEnabled false//是否对代码进行混淆
  48.             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'//指定混淆的规则文件
  49.             signingConfig signingConfigs.debug//设置签名信息
  50.             debuggable false//是否支持断点调试
  51.             jniDebuggable false//是否可以调试NDK代码
  52.             renderscriptDebuggable false//是否开启渲染脚本就是一些c写的渲染方法
  53.             zipAlignEnabled true//是否对APK包执行ZIP对齐优化，减小zip体积，增加运行效率
  54.             pseudoLocalesEnabled false//是否在APK中生成伪语言环境，帮助国际化的东西，一般使用的不多
  55.             applicationIdSuffix 'test'//在applicationId 中添加了一个后缀，一般使用的不多
  56.             versionNameSuffix 'test'//在applicationId 中添加了一个后缀，一般使用的不多
  57.         }
  58.     }
  59.  
  60.     sourceSets {//目录指向配置
  61.         main {
  62.             jniLibs.srcDirs = ['libs']//指定lib库目录
  63.         }
  64.     }
  65.  
  66.     packagingOptions{//打包时的相关配置
  67.         //pickFirsts做用是 当有重复文件时 打包会报错 这样配置会使用第一个匹配的文件打包进入apk
  68.         // 表示当apk中有重复的META-INF目录下有重复的LICENSE文件时  只用第一个 这样打包就不会报错
  69.         pickFirsts = ['META-INF/LICENSE']
  70.  
  71.         //merges何必 当出现重复文件时 合并重复的文件 然后打包入apk
  72.         //这个是有默认值得 merges = [] 这样会把默默认值去掉  所以我们用下面这种方式 在默认值后添加
  73.         merge 'META-INF/LICENSE'
  74.  
  75.         //这个是在同时使用butterknife、dagger2做的一个处理。同理，遇到类似的问题，只要根据gradle的提示，做类似处理即可。
  76.         exclude 'META-INF/services/javax.annotation.processing.Processor'
  77.     }
  78.  
  79.     productFlavors {
  80.         wandoujia {}
  81.         xiaomi {}
  82.         _360 {}
  83.     }
  84.  
  85.     productFlavors.all {
  86.             //批量修改，类似一个循序遍历
  87.         flavor -> flavor.manifestPlaceholders = [IFLYTEK_CHANNEL: name]
  88.     }
  89.  
  90.     //程序在编译的时候会检查lint，有任何错误提示会停止build，我们可以关闭这个开关
  91.     lintOptions {
  92.         abortOnError false
  93.         //即使报错也不会停止打包
  94.         checkReleaseBuilds false
  95.         //打包release版本的时候进行检测
  96.     }
  97.  
  98. }
  99.  
  100. dependencies {
  101.     //项目的依赖关系
  102.     implementation fileTree(include: ['*.jar'], dir: 'libs')
  103.     //本地jar包依赖
  104.     implementation 'com.android.support:appcompat-v7:27.1.1'
  105.     //远程依赖
  106.     implementation 'com.android.support.constraint:constraint-layout:1.1.2'
  107.     testImplementation 'junit:junit:4.12'
  108.     //声明测试用例库
  109.     androidTestImplementation 'com.android.support.test:runner:1.0.2'
  110.     androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
  111. }
  112.

小礼物走一走，来简书关注我



作者：BillyZuo
链接：https://www.jianshu.com/p/c11862136abf
来源：简书
简书著作权归作者所有，任何形式的转载都请联系作者获得授权并注明出处。

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

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

  

闽ICP备14008679号