文档章节

理解Gradle

KingBoxing123
 KingBoxing123
发布于 2017/04/24 15:13
字数 2638
阅读 8
收藏 0

一、什么是Gradle

 

简单的说,Gradle是一个构建工具,它是用来帮助我们构建app的,构建包括编译、打包等过程。我们可以为Gradle指定构建规则,然后它就会根据我们的“命令”自动为我们构建app。Android Studio中默认就使用Gradle来完成应用的构建。有些同学可能会有疑问:”我用AS不记得给Gradle指定过什么构建规则呀,最后不还是能搞出来个apk。“ 实际上,app的构建过程是大同小异的,有一些过程是”通用“的,也就是每个app的构建都要经历一些公共步骤。因此,在我们在创建工程时,Android Studio自动帮我们生成了一些通用构建规则,很多时候我们甚至完全不用修改这些规则就能完成我们app的构建。

有些时候,我们会有一些个性化的构建需求,比如我们引入了第三方库,或者我们想要在通用构建过程中做一些其他的事情,这时我们就要自己在系统默认构建规则上做一些修改。这时候我们就要自己向Gradle”下命令“了,这时候我们就需要用Gradle能听懂的话了,也就是Groovy。Groovy是一种基于JVM的动态语言,关于它的具体介绍,感兴趣的同学可以文末参考”延伸阅读“部分给出的链接。

 

我们在开头处提到“Gradle是一种构建工具”。实际上,当我们想要更灵活的构建过程时,Gradle就成为了一个编程框架——我们可以通过编程让构建过程按我们的意愿进行。也就是说,当我们把Gradle作为构建工具使用时,我们只需要掌握它的配置脚本的基本写法就OK了;而当我们需要对构建流程进行高度定制时,就务必要掌握Groovy等相关知识了。限于篇幅,本文只从构建工具使用者的角度来介绍Gradle的一些最佳实践,在文末“延伸阅读”部分给出了几篇高质量的深入介绍Gradle的文章,其中包含了Groovy等知识的介绍。

 

二、Gradle的基本组分

 

1. Project与Task

在Gradle中,每一个待构建的工程是一个Project,构建一个Project需要执行一系列Task,比如编译、打包这些构建过程的子过程都对应着一个Task。具体来说,一个apk文件的构建包含以下Task:Java源码编译、资源文件编译、Lint检查、打包以生成最终的apk文件等等。

 

2. 插件

插件的核心工作有两个:一是定义Task;二是执行Task。也就是说,我们想让Gradle能正常工作,完成整个构建流程中的一系列Task的执行,必须导入合适的插件,这些插件中定义了构建Project中的一系列Task,并且负责执行相应的Task。

在新建工程的app模块的build.gradle文件的第一行,往往都是如下这句:

apply plugin: 'com.android.application'

这句话的意思就是应用“com.android.application“这个插件来构建app模块,app模块就是Gradle中的一个Project。也就是说,这个插件负责定义并执行Java源码编译、资源文件编译、打包等一系列Task。实际上"com.android.application"整个插件中定义了如下4个顶级任务:

  • assemble: 构建项目的输出(apk)

  • check: 进行校验工作

  • build: 执行assemble任务与check任务

  • clean: 清除项目的输出

当我们执行一个任务时,会自动执行它所依赖的任务。比如,执行assemble任务会执行assembleDebug任务和assembleRelease任务,这是因为一个Android项目至少要有debug和release这两个版本的输出。

 

3. Gradle配置文件

我们在Android Studio中新建一个工程,可以得到如下的工程结构图:

上面我们说过,Android Studio中的一个Module即为Gradle中的一个Project。上图的app目录下,存在一个build.gradle文件,代表了app Module的构建脚本,它定义了应用于本模块的构建规则。我们可以看到,工程根目录下也存在一个build.gradle文件,它代表了整个工程的构建,其中定义了适用于这个工程中所有模块的构建规则。

接下来我们介绍一下上图中其他几个Gradle配置文件:

  • gradle.properties: 从它的名字可以看出,这个文件中定义了一系列“属性”。实际上,这个文件中定义了一系列供build.gradle使用的常量,比如keystore的存储路径、keyalias等等。

  • gradlew与gradlew.bat: gradlew为Linux下的shell脚本,gradlew.bat是Windows下的批处理文件。gradlew是gradle wrapper的缩写,也就是说它对gradle的命令进行了包装,比如我们进入到指定Module目录并执行“gradlew.bat assemble”即可完成对当前Module的构建(Windows系统下)。

  • local.properties: 从名字就可以看出来,这个文件中定义了一些本地属性,比如SDK的路径。

  • settings.gradle: 假如我们的项目包含了不只一个Module时,我们想要一次性构建所有Module以完成整个项目的构建,这时我们需要用到这个文件。比如我们的项目包含了ModuleA和ModuleB这两个模块,则这个文件中会包含这样的语句:include ':ModuleA', ':ModuleB'。

 

4. 构建脚本

首先我们来看一下工程目录下的build.gradle,它指定了整个项目的构建规则,它的内容如下:

 

buildscript {
    repositories {
        jcenter() //构建脚本中所依赖的库都在jcenter仓库下载
    }
    dependencies {
        //指定了gradle插件的版本
        classpath 'com.android.tools.build:gradle:1.5.0'
    }
}

allprojects {
    repositories {
        //当前项目所有模块所依赖的库都在jcenter仓库下载
        jcenter()
    }
}

 

我们再来简单介绍下app模块的build.gradle的内容:

 

//加载用于构建Android项目的插件
apply plugin: 'com.android.application'

android { //构建Android项目使用的配置
    compileSdkVersion 23 //指定编译项目时使用的SDK版本
    buildToolsVersion "23.0.1" //指定构建工具的版本

    defaultConfig {
        applicationId "com.absfree.debugframwork" //包名
        minSdkVersion 15  //指定支持的最小SDK版本
        targetSdkVersion 23 //针对的目标SDK版本
        versionCode 1 
        versionName "1.0"
    }
    buildTypes { //针对不同的构建版本进行一些设置
        release { //对release版本进行的设置
            minifyEnabled false //是否开启混淆
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'  //指定混淆文件的位置
        }
    }
}

dependencies { //指定当前模块的依赖
    compile fileTree(dir: 'libs', include: ['*.jar'])
    testCompile 'junit:junit:4.12'
    compile 'com.android.support:appcompat-v7:23.1.1'
    compile 'com.android.support:design:23.1.1'
}

 

 

三、常见配置

整个工程的build.gradle通常不需我们改动,这里我们介绍下一些对模块目录下build.gradle文件的常见配置。

 

1. 依赖第三方库

当我们的项目中用到了了一些第三方库时,我们就需要进行一些配置,以保证能正确导入相关依赖。设置方法很简单,比如我们在app模块中中用到了Fresco,只需要在build.gradle文件中的dependencies块添加如下语句:

 

dependencies {
    ...
    compile 'com.facebook.fresco:fresco:0.11.0'
}

 

这样一来,Gradle会自动从jcenter仓库下载我们所需的第三方库并导入到项目中。

 

2. 导入本地jar包

在使用第三方库时,除了像上面那样从jcenter仓库下载,我们还可以导入本地的jar包。配置方法也很简单,只需要先把jar文件添加到app\libs目录下,然后在相应jar文件上单击右键,选择“Ad As Library”。然后在build.gradle的dependencies块下添加如下语句:

 

compile files('libs/xxx.jar')

实际上我们可以看到,系统为我们创建的build.gradle中就已经包含了如下语句:

compile fileTree(dir: 'libs', include: ['*.jar'])

 

这句话的意思是,将libs目录下的所有jar包都导入。所以实际上我们只需要把jar包添加到libs目录下并“Ad As Library"即可。


 

3. 依赖其它模块

假设我们的项目包含了多个模块,并且app模块依赖other模块,那么我们只需app\build.gradle的denpendencies块下添加如下语句:

 

compile project(':other')

 

4. 构建输出为aar文件

通常我们构建的输出目标都是apk文件,但如果我们的当前项目时Android Library,我们的目标输出就是aar文件。要想达到这个目的也很容易,只需要把build.gradle的第一句改为如下:

apply plugin:'com.android.library'

这话表示我们使用的插件不再是构建Android应用的插件,而是构建Android Library的插件,这个插件定义并执行用于构建Android Library的一系列Task。

 

5. 自动移除不再使用的资源

只需进行如下配置:

 

android {
    ...
    }
    buildTypes {
        release {
            ...
            shrinkResources true
            ...
        }
    }
}

 

6. 忽略Lint错误

在我们构建Android项目的过程中,有时候会由于Lint错误而终止。当这些错误来自第三方库中时,我们往往想要忽略这些错误从而继续构建进程。这时候,我们可以只需进行如下配置:

android {
    ...
    lintOptions {
        abortOnError false
    }
}

 

7. 集成签名配置

在构建release版本的Android项目时,每次都手动导入签名文件,键入密码、keyalias等信息十分麻烦。通过将签名配置集成到构建脚本中,我们就不必每次构建发行版本时都手动设置了。具体配置如下:

 

signingConfigs {
    myConfig { //将"xx"替换为自己的签名文件信息
        storeFile file("xx.jks")
        storePassword "xx"
        keyAlias "xx"
        keyPassword "xx"
    }
}
android {
    buildTypes {
        release {
            signingConfig  signingConfigs.myConfig //在release块中加入这行
            ...
        }
    }
    ...
}

 

真实开发中,我们不应该把密码等信息直接写到build.gradle中,更好的做法是放在gradle.properties中设置:

RELEASE_STOREFILE=xxx.jks 
RELEASE_STORE_PASSWORD = xxx
RELEASE_KEY_ALIAS=xxx
RELEASE_KEY_PASSWORD=xxx

 

然后在build.gradle中直接引用即可:

 

 

signingConfigs {
    myConfig { 
        storeFilefile(RELEASE_STOREFILE)
        storePassword RELEASE_STORE_PASSWORD
        keyAlias RELEASE_KEY_ALIAS
        keyPassword RELEASE_KEY_PASSWORD 
    }
}

 

关于Gradle的其他配置方法大家可以参考“延伸阅读”部分的“Gradle最佳实践”。

 

 

 

四、延伸阅读

1. 深入理解Android之Gradle:http://blog.csdn.net/Innost/article/details/48228651

   邓凡平老师的一篇博文,从原理到使用非常深入细致地介绍了Gradle。而且重点介绍了怎样把Gradle当做一个编程框架来使用,介绍了Groovy语法基础、Gradle常用API,想要高度定制项目构建过程的小伙伴们一定不要错过这篇文章哦:)

 

2. Gradle构建最佳实践: http://www.figotan.org/2016/04/01/gradle-on-android-best-practise/

© 著作权归作者所有

共有 人打赏支持
KingBoxing123
粉丝 5
博文 95
码字总数 48684
作品 0
成都
私信 提问
史上最详细的Android Studio系列教程五--Gradle命令详解与导入第三方包

Android Studio + Gradle的组合用起来非常方便,很多第三方开源项目也早都迁移到了Studio,为此今天就来介绍下查看、编译并导入第三方开源项目的方法。 Sublime + Terminal编译并查看源码 首...

让代码飞一会
2015/07/05
0
1
怎么理解gradle的这句话和其中一个语法

最近在开始看gradle的知识。看到这样一句话"Gradle 是以 Groovy 语言为基础,基于DSL(领域特定语言)语法的自动化构建工具"。 不太理解这句话,我的质疑是:既然gradle以groovy语言为基础,...

蚂蚁的世界
2015/11/06
326
2
Gradle Tips#1-tasks

原文链接 以这篇博客开始,我将写一系列关于Gradle的文章,用来记录接触Gradle构建脚本以来我所理解的Gradle。 今天要讲的就是Gradle tasks以及task的配置和运行。可能有的读者还不了解Gradl...

一配
2015/09/20
46
0
如何理解Gradle?Grade在Android的构建过程中有什么作用?动态修改AndroidManifest.xml.

如何理解Gradle? 1、首先Gradle是什么? Gradle是一个基于Groovy的打包、编译的工具,主要面向java应用。 2、Gradle在Android构建过程中有什么作用? Gradle是Android里最方便也是最好的用来...

小鹿啊小鹿
2017/12/21
0
0
Gradle入门系列(1):简介 - 文章 - 伯乐在线

本文由伯乐在线 - JustinWu翻译。未经许可,禁止转载! 英文出处:Petri Kainulainen。欢迎加入翻译组。 Gradle是一种构建工具,它抛弃了基于XML的构建脚本,取而代之的是采用一种基于Groov...

低至一折起
2017/12/04
0
0

没有更多内容

加载失败,请刷新页面

加载更多

欧拉公式

欧拉公式表达式 欧拉公式的几何意 cosθ + j sinθ 是个复数,实数部分也就是实部为 cosθ ,虚数部分也就是虚部为 j sinθ ,对应复平面单位圆上的一个点。 根据欧拉公式和这个点可以用 复指...

sharelocked
21分钟前
1
0
burpsuite无法抓取https数据包

1.将浏览器和burpsuite的代理都设置好 2.在浏览器地址栏输入: http://burp 3.下载下面的证书,并将证书导入浏览器 cacert.der

Frost729
45分钟前
0
0
JeeSite4.x 消息管理、消息推送、消息提醒

实现统一的消息推送接口,包含PC消息、短信消息、邮件消息、微信消息等,无需让所有开发者了解消息是怎么发送出去的,只需了解消息发送接口即可。 所有推送消息均通过 MsgPushUtils 工具类发...

ThinkGem
今天
6
0
OpenML

https://www.openml.org/search?type=data

shengjuntu
今天
2
0
java强引用,软引用,弱引用和虚引用

先来简要说一下这四种引用的特性: 强引用:如果一个对象具有强引用,那垃圾回收器绝不会回收它 软引用:如果一个对象只具有软引用,则内存空间足够,垃圾回收器就不会回收它 弱引用:在垃圾...

woshixin
今天
1
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部