史上最全Android build.gradle配置详解

时间 2019-12-07

标签史上 android build.gradle build gradle 配置详解栏目 Android 繁體版

原文原文链接

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

1、Project的build.gradle文件：

对应的build.gradle代码以下：php

// Top-level build file where you can add configuration options common to all sub-projects/modules.

buildscript {//这里是gradle脚本执行所需依赖，分别是对应的maven库和插件

    repositories {
        google()//从Android Studio3.0后新增了google()配置，能够引用google上的开源项目
        jcenter()//是一个相似于github的代码托管仓库，声明了jcenter()配置，能够轻松引用 jcenter上的开源项目
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.0.0'////此处是android的插件gradle，gradle是一个强大的项目构建工具

        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

allprojects {//这里是项目自己须要的依赖，好比项目所需的maven库
    repositories {
        google()
        jcenter()
    }
}

// 运行gradle clean时，执行此处定义的task任务。
// 该任务继承自Delete，删除根目录中的build目录。
// 至关于执行Delete.delete(rootProject.buildDir)。
// gradle使用groovy语言，调用method时能够不用加（）。
task clean(type: Delete) {
    delete rootProject.buildDir
}

复制代码

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上的开源项目。java

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

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

2、Module的build.gradle文件：

从文件内容能够看出，主要分为三大部分，以下图所示：c++

一、apply plugin：

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

复制代码

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

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

二、android{}闭包：

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

2.一、添加signingConfigs{}闭包：

signingConfigs {// 自动化打包配置
        release {// 线上环境
            keyAlias 'test'
            keyPassword '123456'
            storeFile file('test.keystore')
            storePassword '123456'
        }
        debug {// 开发环境
            keyAlias 'test'
            keyPassword '123456'
            storeFile file('test.keystore')
            storePassword '123456'
        }
    }

复制代码

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

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

2.二、compileSdkVersion：设置编译时用的Android版本

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

2.四、defaultConfig{}闭包：

compileSdkVersion 27//设置编译时用的Android版本
    defaultConfig {
        applicationId "com.billy.myapplication"//项目的包名
        minSdkVersion 16//项目最低兼容的版本
        targetSdkVersion 27//项目的目标版本
        versionCode 1//版本号
        versionName "1.0"//版本名称
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"//代表要使用AndroidJUnitRunner进行单元测试
    }
复制代码

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.五、 buildTypes{}闭包：

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

buildTypes {// 生产/测试环境配置
        release {// 生产环境
            buildConfigField("boolean", "LOG_DEBUG", "false")//配置Log日志
            buildConfigField("String", "URL_PERFIX", "\"https://release.cn/\"")// 配置URL前缀
            minifyEnabled false//是否对代码进行混淆
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'//指定混淆的规则文件
            signingConfig signingConfigs.release//设置签名信息
            pseudoLocalesEnabled false//是否在APK中生成伪语言环境，帮助国际化的东西，通常使用的很少
            zipAlignEnabled true//是否对APK包执行ZIP对齐优化，减少zip体积，增长运行效率
            applicationIdSuffix 'test'//在applicationId 中添加了一个后缀，通常使用的很少
            versionNameSuffix 'test'//在applicationId 中添加了一个后缀，通常使用的很少
        }
        debug {// 测试环境
            buildConfigField("boolean", "LOG_DEBUG", "true")//配置Log日志
            buildConfigField("String", "URL_PERFIX", "\"https://test.com/\"")// 配置URL前缀
            minifyEnabled false//是否对代码进行混淆
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'//指定混淆的规则文件
            signingConfig signingConfigs.debug//设置签名信息
            debuggable false//是否支持断点调试
            jniDebuggable false//是否能够调试NDK代码
            renderscriptDebuggable false//是否开启渲染脚本就是一些c写的渲染方法
            zipAlignEnabled true//是否对APK包执行ZIP对齐优化，减少zip体积，增长运行效率
            pseudoLocalesEnabled false//是否在APK中生成伪语言环境，帮助国际化的东西，通常使用的很少
            applicationIdSuffix 'test'//在applicationId 中添加了一个后缀，通常使用的很少
            versionNameSuffix 'test'//在applicationId 中添加了一个后缀，通常使用的很少
        }
    }
复制代码

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.六、sourceSets{}闭包：配置目录指向

sourceSets {//目录指向配置
        main {
            jniLibs.srcDirs = ['libs']//指定lib库目录
        }
    }
复制代码

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

2.七、packagingOptions{}闭包：打包时的相关配置

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

packagingOptions{
        //pickFirsts作用是 当有重复文件时 打包会报错 这样配置会使用第一个匹配的文件打包进入apk
        // 表示当apk中有重复的META-INF目录下有重复的LICENSE文件时 只用第一个 这样打包就不会报错
        pickFirsts = ['META-INF/LICENSE']

        //merges何须 当出现重复文件时 合并重复的文件 而后打包入apk
        //这个是有默认值得 merges = [] 这样会把默默认值去掉 因此咱们用下面这种方式 在默认值后添加
        merge 'META-INF/LICENSE'

        //这个是在同时使用butterknife、dagger2作的一个处理。同理，遇到相似的问题，只要根据gradle的提示，作相似处理便可。
        exclude 'META-INF/services/javax.annotation.processing.Processor'
    }
复制代码

2.八、productFlavors{}闭包：多个渠道配置

这个配置是常常会使用到的，一般在适配多个渠道的时候，须要为特定的渠道作部分特殊的处理，好比设置不一样的包名、应用名等。场景：当咱们使用友盟统计时，一般须要设置一个渠道ID，那么咱们就能够利用productFlavors来生成对应渠道信息的包，如：

android {  
    productFlavors {
        wandoujia {
            //豌豆荚渠道包配置
            manifestPlaceholders = [UMENG_CHANNEL_VALUE: "wandoujia"]
            //manifestPlaceholders的使用在后续章节（AndroidManifest里的占位符）中介绍
        }
        xiaomi {
            manifestPlaceholders = [UMENG_CHANNEL_VALUE: "xiaomi"]
            applicationId "com.wiky.gradle.xiaomi" //配置包名

        }
        _360 {
            manifestPlaceholders = [UMENG_CHANNEL_VALUE: "_360"]
        }
        //...
    }  
}
复制代码

固然也有更简洁的方式：

android {  
    productFlavors {
        wandoujia {}
        xiaomi {}
        _360 {}
       //...
    }  

    productFlavors.all { 
        //批量修改，相似一个循序遍历
        flavor -> flavor.manifestPlaceholders = [UMENG_CHANNEL_VALUE: name] 
    }
}
复制代码

配置完以后，在命令行窗口中（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.九、lintOptions{}闭包：代码扫描分析

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

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

//程序在编译的时候会检查lint，有任何错误提示会中止build，咱们能够关闭这个开关
    lintOptions {
        abortOnError false //即便报错也不会中止打包
        checkReleaseBuilds false  //打包release版本的时候进行检测
    }
复制代码

三、dependencies{}闭包：

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

dependencies {//项目的依赖关系
    implementation fileTree(include: ['*.jar'], dir: 'libs')//本地jar包依赖
    implementation 'com.android.support:appcompat-v7:27.1.1'//远程依赖
    implementation 'com.android.support.constraint:constraint-layout:1.1.2'
    testImplementation 'junit:junit:4.12'//声明测试用例库
    androidTestImplementation 'com.android.support.test:runner:1.0.2'
    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
}

复制代码

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配置以下：

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

android {
    signingConfigs {// 自动化打包配置
        release {// 线上环境
            keyAlias 'test'
            keyPassword '123456'
            storeFile file('test.jks')
            storePassword '123456'
        }
        debug {// 开发环境
            keyAlias 'test'
            keyPassword '123456'
            storeFile file('test.jks')
            storePassword '123456'
        }
    }
    compileSdkVersion 27//设置编译时用的Android版本
    defaultConfig {
        applicationId "com.billy.myapplication"//项目的包名
        minSdkVersion 16//项目最低兼容的版本
        targetSdkVersion 27//项目的目标版本
        versionCode 1//版本号
        versionName "1.0"//版本名称
        flavorDimensions "versionCode"
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"//代表要使用AndroidJUnitRunner进行单元测试
    }
    buildTypes {// 生产/测试环境配置
        release {// 生产环境
            buildConfigField("boolean", "LOG_DEBUG", "false")//配置Log日志
            buildConfigField("String", "URL_PERFIX", "\"https://release.cn/\"")// 配置URL前缀
            minifyEnabled false//是否对代码进行混淆
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'//指定混淆的规则文件
            signingConfig signingConfigs.release//设置签名信息
            pseudoLocalesEnabled false//是否在APK中生成伪语言环境，帮助国际化的东西，通常使用的很少
            zipAlignEnabled true//是否对APK包执行ZIP对齐优化，减少zip体积，增长运行效率
            applicationIdSuffix 'test'//在applicationId 中添加了一个后缀，通常使用的很少
            versionNameSuffix 'test'//在applicationId 中添加了一个后缀，通常使用的很少
        }
        debug {// 测试环境
            buildConfigField("boolean", "LOG_DEBUG", "true")//配置Log日志
            buildConfigField("String", "URL_PERFIX", "\"https://test.com/\"")// 配置URL前缀
            minifyEnabled false//是否对代码进行混淆
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'//指定混淆的规则文件
            signingConfig signingConfigs.debug//设置签名信息
            debuggable false//是否支持断点调试
            jniDebuggable false//是否能够调试NDK代码
            renderscriptDebuggable false//是否开启渲染脚本就是一些c写的渲染方法
            zipAlignEnabled true//是否对APK包执行ZIP对齐优化，减少zip体积，增长运行效率
            pseudoLocalesEnabled false//是否在APK中生成伪语言环境，帮助国际化的东西，通常使用的很少
            applicationIdSuffix 'test'//在applicationId 中添加了一个后缀，通常使用的很少
            versionNameSuffix 'test'//在applicationId 中添加了一个后缀，通常使用的很少
        }
    }

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

    packagingOptions{//打包时的相关配置
        //pickFirsts作用是 当有重复文件时 打包会报错 这样配置会使用第一个匹配的文件打包进入apk
        // 表示当apk中有重复的META-INF目录下有重复的LICENSE文件时 只用第一个 这样打包就不会报错
        pickFirsts = ['META-INF/LICENSE']

        //merges何须 当出现重复文件时 合并重复的文件 而后打包入apk
        //这个是有默认值得 merges = [] 这样会把默默认值去掉 因此咱们用下面这种方式 在默认值后添加
        merge 'META-INF/LICENSE'

        //这个是在同时使用butterknife、dagger2作的一个处理。同理，遇到相似的问题，只要根据gradle的提示，作相似处理便可。
        exclude 'META-INF/services/javax.annotation.processing.Processor'
    }

    productFlavors {
        wandoujia {}
        xiaomi {}
        _360 {}
    }

    productFlavors.all {
            //批量修改，相似一个循序遍历
        flavor -> flavor.manifestPlaceholders = [IFLYTEK_CHANNEL: name]
    }

    //程序在编译的时候会检查lint，有任何错误提示会中止build，咱们能够关闭这个开关
    lintOptions {
        abortOnError false
        //即便报错也不会中止打包
        checkReleaseBuilds false
        //打包release版本的时候进行检测
    }

}

dependencies {
    //项目的依赖关系
    implementation fileTree(include: ['*.jar'], dir: 'libs')
    //本地jar包依赖
    implementation 'com.android.support:appcompat-v7:27.1.1'
    //远程依赖
    implementation 'com.android.support.constraint:constraint-layout:1.1.2'
    testImplementation 'junit:junit:4.12'
    //声明测试用例库
    androidTestImplementation 'com.android.support.test:runner:1.0.2'
    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
}
复制代码