Android Studio Gradle配置详解

Gradle文件体系

Android工程通过gradle文件管理各项配置，gradle文件利用DSL（Domain Specific Language）语言描述配置，
并使用Groovy语言处理编译逻辑。一个典型的Android工程结构如下：

在这里gradle文件分布在几个不同的层级，Project层级以及Module层级。

Project层级

settings.gradle

这个文件是描述Project所依赖的Module

include ":"
include ":CordovaLib"
include ":app"

build.gradle

buildscript {       //配置gradle的

    repositories {  //repositories闭包
        google()
        jcenter() //代码托管库：设置之后可以在项目中轻松引用jcenter上的开源项目
    }
    dependencies {  //dependencies闭包
        classpath 'com.android.tools.build:gradle:3.0.0' ////声明gradle插件，插件版本号为3.0.0
        //gradle是一个强大的项目构建工具，不仅可以构建Android，还可以构建java，C++等
        //此处引用android的插件
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

allprojects {       //配置所有子工程
    repositories {
        google()
        jcenter() //代码托管库：设置之后可以在项目中轻松引用jcenter上的开源项目
    }
}
 // 该任务继承自Delete，删除根目录中的build目录。
task clean(type: Delete) {
    delete rootProject.buildDir
}

• allprojects
  allprojects块的repositories用于多项目构建，为所有项目提供共同所需依赖包。

• buildscript和allprojects的作用和区别
  buildscript中的声明是gradle脚本自身需要使用的资源，而allprojects声明的却是你所有module所需要使用的资源

Module层级

build.gradle

Module层级的build.gradle的主要用于配置Module的，下面看看它的一些配置
1. apply plugin 声明是Android应用程序还是库模块
2. android 闭包：配置项目构建的各种属性
1. compileSdkVersion用于指定项目的编译SDK版本
2. buildToolsVersion用于指定项目构建工具的版本。
3. defaultConfig闭包：默认配置，应用程序包名，最小 sdk 版本，目标 sdk 版本，版本号，版本名
4. buildTypes闭包：指定生成安装文件的配置，是否对代码进行混淆
5. signingConfigs 闭包：签名信息配置
6. sourceSets 闭包：源文件路径配置
7. lintOptions 闭包：lint 配置
3. dependencies 闭包，指定当前项目的所有依赖关系，本地依赖，库依赖以及远程依赖
4. repositories闭包，仓库配置

// 声明是Android程序，
//com.android.application 表示这是一个应用程序模块,可直接运行
//com.android.library 标识这是一个库模块，是依附别的应用程序运行
apply plugin: 'com.android.application'

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

    //编译sdk的版本，也就是API Level，例如API-19、API-20、API-21等等。
    compileSdkVersion 26
    //build tools的版本，其中包括了打包工具aapt、dx等等。
    //这个工具的目录位于你的sdk目录/build-tools/下
    buildToolsVersion '26.0.2'

    //关闭Android Studio的PNG合法性检查
    aaptOptions.cruncherEnabled = false
    aaptOptions.useNewCruncher = false

    defaultConfig {  //默认配置
        applicationId "com.hebbe.espressotest" //应用程序的包名
        minSdkVersion 22  //最小sdk版本，如果设备小于这个版本或者大于maxSdkVersion将无法安装这个应用
        targetSdkVersion 26 //目标sdk版本，充分测试过的版本（建议版本）
        versionCode 1  //版本号，第一版是1，之后每更新一次加1
        versionName "1.0" //版本名，显示给用户看到的版本号

        archivesBaseName = "weshare-$versionName" //指定打包成Jar文件时候的文件名称
        ndk {
            moduleName "hebbewifisafe"                   //设置库(so)文件名称
            ldLibs "log", "z", "m", "jnigraphics", "android"
            //引入库，比如要用到的__android_log_print
            abiFilters "armeabi", "x86", "armeabi-v7a"      //, "x86"  显示指定支持的ABIs
            cFlags "-std=c++11 -fexceptions"                // C++11
            stl "gnustl_static"
        }

        //当方法数超过65535(方法的索引使用的是一个short值，
        //而short最大值是65535)的时候允许打包成多个dex文件，动态加载dex。这里面坑很深啊
        multiDexEnabled true

        //Instrumentation单元测试
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
    }

    //默认的一些文件路径的配置
    sourceSets {
        main {
            manifest.srcFile 'AndroidManifest.xml'//指定清单文件
            res.srcDirs = ['res']//指定res资源目录
            assets.srcDirs = ['assets']    //asset资源目录
            jni.srcDirs 'src/main/jni'     //jni代码目录
            jniLibs.srcDir 'src/main/jniLibs' //jni库目录
            java.srcDirs = ['src']//指定java源代码目录
            resources.srcDirs = ['src']//指定resource目录
            aidl.srcDirs = ['src']//指定aidl目录
            renderscript.srcDirs = ['src']//指定source目录
        }
        debug.setRoot('build-types/debug')//指定debug模式的路径
        release.setRoot('build-types/release')//指定release模式的路径
    }

    //multiDex的一些相关配置，这样配置可以让你的编译速度更快
    dexOptions {
        //让它不要对Lib做preDexing
        preDexLibraries = false
        //开启incremental dexing,优化编译效率，这个功能android studio默认是关闭的。
        incremental true
        javaMaxHeapSize "4g"     //增加java堆内存大小
    }

    signingConfigs {//签名配置
        release {//发布版签名配置
            storeFile file("fk.keystore")//**文件路径
            storePassword "123456"//**文件密码
            keyAlias "fk"//key别名
            keyPassword "123456"//key密码
        }
        debug {//debug版签名配置
            storeFile file("fk.keystore")
            storePassword "123456"
            keyAlias "fk"
            keyPassword "123456"
        }
    }
    //指定生成安装文件的配置，常有两个子包:release,debug，注：直接运行的都是debug安装文件
    buildTypes {
        //release版本的配置，即生成正式版安装文件的配置
        release {
            zipAlignEnabled true  //是否支持zip
            shrinkResources true  // 移除无用的resource文件
            minifyEnabled false //是否对代码进行混淆，true表示混淆
            //指定混淆时使用的规则文件；
            // proguard-android.txt指所有项目通用的混淆规则，proguard-rules.pro当前项目特有的混淆规则
            //release的Proguard默认为Module下的proguard-rules.pro文件
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            debuggable false  //是否支持调试
            //ndk的一些配置
            ndk {
                // cFlags "-std=c++11 -fexceptions -O3 -D__RELEASE__" // C++11
                // platformVersion  = "19"
                moduleName "hebbewifisafe" //设置库(so)文件名称
                ldLibs "log", "z", "m", "jnigraphics", "android"
                //引入库，比如要用到的__android_log_print
                abiFilters "armeabi", "x86", "armeabi-v7a"//, "x86"
                cFlags "-std=c++11 -fexceptions" // C++11
                stl "gnustl_static"
            }
            //采用动态替换字符串的方式生成不同的release.apk
            applicationVariants.all { variant ->
                variant.outputs.each { output ->
                    def outputFile = output.outputFile
                    if (outputFile != null && outputFile.name.endsWith('release.apk')) {
                        def timeStamp = new Date().format('yyyyMMddHH');
                        def fileName = "WeShare-${defaultConfig.versionName}" + "-" + timeStamp + "-lj-" + ".apk";
                        output.outputFile = file("${outputFile.parent}/${fileName}")
                    }
                }
            }
            jniDebuggable false  //关闭jni调试
        }
        debug {//debug版本的配置
            minifyEnabled false
            zipAlignEnabled true
            shrinkResources true // 移除无用的resource文件
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            debuggable true
//          jniDebuggable true
            ndk {
                cFlags "-std=c++11 -fexceptions -g -D __DEBUG__" // C++11
            }
            jniDebuggable true
        }
    }

    packagingOptions
        {
            exclude 'META-INF/ASL2.0'
            exclude 'META-INF/LICENSE'
            exclude 'META-INF/NOTICE'
            exclude 'META-INF/MANIFEST.MF'
        }

    compileOptions {
        //在这里你可以进行 Java 的版本配置，
        //以便使用对应版本的一些新特性
    }
    productFlavors {
        //在这里你可以设置你的产品发布的一些东西，
        //比如你现在一共软件需要发布到不同渠道，
        //且不同渠道中的包名不同，那么可以在此进行配置；
        //甚至可以设置不同的 AndroidManifest.xml 文件。
        hebbe {
        }
        googlePlay {
        }
        solo {
        }
    }
    productFlavors.all {
        flavor -> flavor.manifestPlaceholders = [UMENG_CHANNEL_VALUE: name]
    }
    //所谓ProductFlavors其实就是可定义的产品特性，
    //配合 manifest merger 使用的时候就可以达成在一次编译
    //过程中产生多个具有自己特性配置的版本。

    //上面这个配置的作用就是，为每个渠道包产生不同的 UMENG_CHANNEL_VALUE 的值。
}

//指定当前项目的所有依赖关系：本地依赖、库依赖、远程依赖
//本地依赖：可以对本地Jar包或目录添加依赖关系
//库依赖：可以对项目中的库模块添加依赖关系
//远程依赖：可以对jcenter库上的开源项目添加依赖
//标准的远程依赖格式是 域名:组织名:版本号
dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar']) //本地依赖
    //远程依赖，com.android.support是域名部分，appcompat-v7是组名称，26.1.0是版本号
    implementation 'com.android.support:appcompat-v7:26.1.0'
    implementation 'com.android.support.constraint:constraint-layout:1.0.2'
    implementation project(':hello')//库依赖
    testImplementation 'junit:junit:4.12' //声明测试用列库
    androidTestImplementation 'com.android.support.test:runner:1.0.1'
    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.1'
}
//声明是要使用谷歌服务框架
apply plugin: 'com.google.gms.google-services'
//第三方依赖库的本地缓存路径
task showMeCache << {
    configurations.compile.each { println it }
}
//使用maven仓库。android有两个标准的library文件服务器，一个jcenter一个maven。两者毫无关系。
//jcenter有的maven可能没有，反之亦然。
//如果要使用jcenter的话就把mavenCentral()替换成jcenter()
repositories {
    mavenCentral()
}

Product Flavors

顾名思义就是描述产品的特性，可以实现一套代码创建不同的产品
Module层级的gradle文件，productFlavors段。productFlavors的设置会自动使用defaultConfig配置。如果设置了几个不同的productFlavors，它们会共用defaultConfig配置，以及自己各自的配置，如applicationId。注意，不同的productFlavors都是通过manifest文件里的package属性定义的名字来引用R文件，而不是使用各自的applicationId，所以applicationId其实是可以随意取名的。

android {    
    ...    
    defaultConfig {
        applicationId "com.magic.wdl.simpledaggerdemo"
        minSdkVersion 15
        targetSdkVersion 23
        versionCode 1
        versionName "1.0"
    }    
    buildTypes {...}    
    productFlavors {        
        demo {            
            applicationId "com.magic.wdl.simpledaggerdemo.demo"            
            versionName "1.0-demo"        
        }        

        full {            
            applicationId "com.magic.wdl.simpledaggerdemo.full"            
            versionName "1.0-full"        
        }    
    }
}

通过 Build > Select Build Variant可以选择要生成的apk类型。

上面的方式在BuildConfig中生成了定义的HOST，也可以使用在Manifest中：

demo{
            manifestPlaceholders = ["APP_NAME":"测试哈哈"]
        }

使用：
android:label="${APP_NAME}"

在res中使用：

demo{
            resValue "string", "appName", '"柳州数字质监移动办公"'
        }

使用：

<resources>
    <string name="app_name">@string/appName</string>`
</resource>

当然如果存放一些公共的变量可以存在defaultConfig中：

defaultConfig{
        //存放公共变量
        buildConfigField 'String', 'COMMON', '"admin"'
    }

关于task

一个项目通常对应多个module，每一个mudule都有一个build.gradle，一个build.gradle对应着一个project，执行一些列task。一个task相当于一个任务，通常我们在编译工程的时候会用到一个build的task，清理工程会用到clean，比如下面都是一系列的task：

也可以自定义task

task haha {
    println("afhkjjhf")
}

到工程目录下执行，可以看到打印出来了执行了haha这个task