Android项目中的build.gradle文件

文 | 莫若吻

---

一、gradle简介

gradle是基于groovy语言的。

Android Studio是采用Gradle来构建项目的。Gradle是一个非常先进的项目构建工具，使用了一种基于Groovy的领域特定语言（DSL）来声明项目设置，摒弃了XML（如Ant和Maven）的各种烦琐配置。

Note：若只是用它构建普通的工程，可以不去学groovy语言；若想深入的做一下自定义的构建插件，可以考虑学groovy，因为groovy语言是基于java语言的，所以有java基础的同学学习groovy语言不会很难。

二、build.gradle文件

1.Android项目中的gradle文件位置：

在一个android项目中一般会出现至少2个build.gradle文件，一个是project的gradle文件，一个是module的gradle文件。
Note：如果项目目录结构切换到Android模式下则全部gradle在Gradle Scripts下。

2.gradle文件内的常用代码释义：

1）jcenter()：
代码托管库，设置后可以在项目中引用jcenter上的开源项目。声明在repositories闭包中。
很多的Android开源项目都会选择将代码托管到jcenter上，声明了此行配置后，就可以在项目中轻松使用jcenter上的任何开源项目。
2）声明gradle插件及版本号

classpath 'com.android.tools.build:gradle:2.3.3'

3）apply plugin:
代表着应用一个插件。
eg：

//表示一个应用程序模块。
apply plugin: 'com.android.application'
// 表示是一个库模块
apply plugin: 'com.android.library'

Note:
com.android.application 是代表可以直接运行的应用程序；
com.android.library 是只能作为代码依附在别的应用程序模块来运行。所以在引入一些Model为自己的应用程序所用时，build.gradle文件的第一行就是apply plugin:'com.android.library'。

4）android闭包:
compileSdkVersion： 用于指定项目的编译版本。
buildToolsVersion： 用于指定项目的构建工具的版本。

applicationId: 用于指定项目的包名，在创建项目的时候已经指定了包名，当要修改整个项目的包名时可以在此更改。
minSdkVersion: 项目最低的兼容版本。后面的数字（eg：15）表示兼容到API 15
targetSdkVersion:
表示你在该目标版本上已经做过了充分的测试，系统将为你的应用开启一些最新的功能和特性。
假如targetSdkVersion 为23或者更高，那么在Android6.0中运行这个应用时会开启新的功能和特性；若设置成了22，只能说明你的应用程序在Android5.1系统上做过了充分的测试，Android6.0的新功能就不会启用。
versionCode： 项目的版本号。
versionName： 项目版本号的版本名。

Note：
在以前eclipse开发中设置上述代码都是在AndroidManifest.xml文件中设置的。

<uses-sdk
    android:minSdkVersion="15"
    android:targetSdkVersion="23" />

而在使用Android Studio开发时，即使在AndroidManifest.xml设置也无作用，运行时只对build.gradle下的设置有效。

5）android闭包中的buildTypes闭包:
一般其中会有两个闭包，一个是debug，一个release；当然也可以有其他闭包。用于安装文件的环境变量的配置。
debug闭包用于生成测试版安装文件的配置，release闭包用于生成正式版安装文件的配置。可以只设置一个release闭包。

minifyEnabled：用于设置是否对项目的代码进行混淆。true代表开启，false代表关闭。
proguardFiles:指定混淆时使用的文件。
proguard-android.txt：在Android SDK 目录下的，里面是所有项目通用的混淆规则。
proguard-rules.pro：是在当前项目根目录下的，里面编写当前项目特有的混淆规则。

6）dependencies闭包：
可以在其中指定当前项目所有的依赖关系。
一般Android Studio 项目中一共有三种依赖方式：本地依赖、库依赖和远程依赖。
本地依赖可以对本地的Jar包或目录添加依赖关系
库依赖可以对项目中的库模块添加依赖关系。
远程依赖则可以对jcenter库上的开源项目添加依赖关系。

库依赖的基本格式为 compile project，后面加上依赖库的库名称。
远程依赖的基本格式为 compile ，后面加上远程依赖库的库名称；Gradle在构建项目的时候会检查一下本地仓库是否已经缓存了指定内容，若没有会自动联网下载，然后再添加到项目的构建路径中去。
远程依赖时每次都要检查是否有这个缓存，所以使编译变的很慢。可以设置成离线的Gradle模式。

eg：

   //本地依赖声明
    compile fileTree(include: ['*.jar'], dir: 'libs')
   //库依赖声明
    compile project(':library_pulltorefresh')
    //远程依赖声明
    compile 'com.android.support:appcompat-v7:25.3.1'

Note:
Android Studio 3.0以上的开发工具版本，api 替代了 compile。
eg：

   //本地依赖声明
    api fileTree(include: ['*.jar'], dir: 'libs')
   //库依赖声明
    api project(':library_pulltorefresh')
    //远程依赖声明
    api 'com.android.support:appcompat-v7:25.3.1'

3.示例代码：

(注：下面的代码只是部分的示例代码，要根据项目开发实际情况选择性地使用代码)
project的build.gradle文件：
eg:

// Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {
    repositories {//闭包
        jcenter()//代码托管库，设置后可以在项目中引用jcenter上的开源项目
    }
    dependencies {
        //声明gradle插件及版本号
        classpath 'com.android.tools.build:gradle:2.3.3'

        //butterknife的新版插件必须在此处作配置
        classpath 'com.jakewharton:butterknife-gradle-plugin:8.8.1'

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

module的build.gradle文件：
eg:

apply plugin: 'com.android.application'//默认的应用程序模块（插件）
apply plugin: 'com.jakewharton.butterknife'//butterkinfe插件

android {
    compileSdkVersion cfg.compileVersion   //编译版本
    buildToolsVersion cfg.buildToolsVersion  //构建工具版本
    aaptOptions.cruncherEnabled = false
    aaptOptions.useNewCruncher = false


    defaultConfig {
        applicationId "com.zrmx.athenaapp"  //包名
        minSdkVersion cfg.minSdk   //最低兼容版本
        targetSdkVersion cfg.targetSdk  //（目标版本：充分测试过版本（建议版本））大于22需要考虑存储权限问题，由于默认权限是关闭的，启动时下载广告图片缓存不了
        versionCode project.VERSION_CODE as int    //版本号
        versionName project.VERSION_NAME   //版本名称

        jackOptions {
            enabled true
        }
    }
    lintOptions {//设置编译的lint开关，程序在buid的时候，会执行lint检查，有任何的错误或者警告提示，都会终止构建
        abortOnError false
    }
    
    buildTypes {
       
        release {
            minifyEnabled false   //是否混淆（true为混淆）
            
            //Android SDK通用的混淆规则； 后面的为开发者编写的项目混淆规则
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'

            buildConfigField("int", "SERVICE_TYPE", "4")//线上环境
            signingConfig signingConfigs.release
        }
    }
    applicationVariants.all { variant ->
        variant.outputs.each { output ->
            def outputFile = output.outputFile
            if (outputFile != null && outputFile.name.endsWith('.apk') && !outputFile.name.contains("debug")) {
                output.outputFile = new File(APK_OUT_PATH + "/${variant.buildType.name}", "${releaseTime()}_v${defaultConfig.versionName}_c${defaultConfig.versionCode}.apk")
            }
        }
    }

    sourceSets {
        main {
            jniLibs.srcDirs = ['libs']
        }
    }

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

dependencies {
    //本地依赖声明
    compile fileTree(include: ['*.jar'], dir: 'libs')

   //库依赖声明
    compile project(':library_pulltorefresh')

    //远程依赖声明
    compile 'com.android.support:appcompat-v7:25.3.1'
    testCompile 'junit:junit:4.12'
    compile 'com.squareup.okhttp3:okhttp:3.3.1'
    compile 'com.google.code.gson:gson:2.5'
    compile files('libs/universal-image-loader-1.9.2-SNAPSHOT-with-sources.jar')
    compile 'org.greenrobot:eventbus:3.0.0'

    compile 'com.jakewharton:butterknife:8.8.1'
    annotationProcessor 'com.jakewharton:butterknife-compiler:8.8.1'

    //android 6.0 新增加了运行时的动态添加权限
    compile 'com.lovedise:permissiongen:0.0.6'
}

三、Gradle 解析大全

具体Gradle 原理及相关语法详解请参考文章：
《Android：Gradle 解析》

---

版权声明：本文为博主原创文章，转载请注明出处，谢谢！