欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  移动技术

Android中的build.gradle文件深入讲解

程序员文章站 2023-02-16 14:54:01
一、什么是gradle gradle是一个项目构建工具,java开发中有两个大名鼎鼎的项目构建maven,ant,其中maven简单易控深受开发者喜爱。 项目构建...

一、什么是gradle

gradle是一个项目构建工具,java开发中有两个大名鼎鼎的项目构建maven,ant,其中maven简单易控深受开发者喜爱。
项目构建工具是什么?能干吗?

开发某些项目时,需要很多jar或者库的支持,还没开始开发就下载了n多个库,浪费了时间不说,这些库之间兼容性又无法保证。删了?白下载了。不删?又不兼容。此时就需要使用项目构建工具,简单的说就是一个可以根据简单的配置文件自动去下载相应包/库的软件。自动的还很简单,不用岂不亏了。多个项目构建工具各有特点,但是核心思想一样。

简单的说,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,它指定了真个整个项目的构建规则,它的内容如下:

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

buildscript {

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


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

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

task clean(type: delete) {
delete rootproject.builddir
}

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

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

android {//构建android项目使用的配置
compilesdkversion 28 //指定编译项目时使用的sdk版本
defaultconfig {
applicationid "com.example.ssts.myapplication"//包名
minsdkversion 15//指定支持的最小sdk版本
targetsdkversion 28//针对的目标sdk版本
versioncode 1
versionname "1.0"
testinstrumentationrunner "android.support.test.runner.androidjunitrunner"
}

buildtypes {//针对不同的构建版本进行一些设置
release {//对release版本进行的设置
minifyenabled false//是否开启混淆
proguardfiles getdefaultproguardfile('proguard-android.txt'), 'proguard-rules.pro'//指定混淆文件的位置 
}
}
}

dependencies {//指定当前模块的依赖
implementation filetree(dir: 'libs', include: ['*.jar'])
implementation 'com.android.support:appcompat-v7:28.0.0'
implementation 'com.android.support.constraint:constraint-layout:1.1.3'
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'
}

三、常见配置

整个工程的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 {
...
}
buildtypes {
release {
...
shrinkresources true
...
}
}
}

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 
}
}

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对的支持。