【Gradle深入浅出】——Gradle配置（一）

Posted 2023-02-19

参考技术A

1.【Gradle深入浅出】——初识Gradle
2.【Gradle深入浅出】——Gradle基础概念
3.【Gradle深入浅出】——android Gradle Plugin 基础概念
4.【Gradle深入浅出】——Gradle配置（一）
5.【Gradle深入浅出】——Gralde配置（二）

前面三篇博客讲解了Gradle的基础概念，看完前面三篇博客我们应该对于Gradle都有了一个基础的认知，知道了文件的作用，Gradle的基本构成，本篇博客开始就开始进入Gradle的学习，首先讲解的是Gradle的配置，Gradle配置应该是我们日常开发中必不可少的技能，平时的打包，编译等等都需要熟悉Gradle的配置。

我们知道Gradle都关于属性配置有两个文件， local.properties 和 gradle.properties ，这两个文件的实质都是生成Java的 Properties 对象，所以要属性这两个文件的作用，首先要属性下 Properties 类。
我们首先来看下这个类的基本上结构。

看完这个我们应该就有一个大体的认识了， Properties 本质就是一个HashTable，支持设置默认属性，其他的没啥区别，哪我们看下 Properties 如何读取文件呢

可以看到 Properites 给我们提供了三个加载文件的方式，所以这里我们也可以得出一个结论， 使用 Properties 不是必须使用 .properties 格式的文件。
哪可能有人要问了，为啥这里的配置都使用properties格式的文件呢？
我猜测可能是复用Spring Boot中的支持的配置文件，Spring Boot中支持三种格式的配置文件 YAML,XML,Properties ，具体的差异这里就不展开讲解了。
我们可以理解为 .properties 就是类似于json的一套配置文件格式，IDE对于这类文件有特殊的支持，比如注释等语法，做了统一的规范
Properties文件的格式规范

有了对于Properties类的理解，我们在来看local.properties文件，理解起来就方便类许多，前面几篇博客已经提到了 local.properties 是Studio自动生成的一个本地配置文件，并且不会提交到远端，是我们自己本地的配置文件，常见的配置如下：

既然是配置文件，那么如何在 local.properites 中定义全局变量，然后在build.gradle中读取呢？比如我们的maven上传需要用户的姓名密码，每个人的都不一样，所以可以放到local.propertiest文件中

和前面介绍的一样，我们只需要在local.properties中定义变量，然后在gradle中读取变量只需要生成Properties类来进行读取文件。

同样的这也是一个Properties类型的文件，但这个文件主要是配置和Gradle自身相关的配置内容的，接下来聊聊他的几个作用：

这里主要是配置本项目在使用Gradle进行编译时的配置，比如虚拟机堆栈配置(常见的编译速度优化就在这里配置)

所以看到上面的定义后，我们就可以理解常见的“编译速度优化”的配置的大概意思

除了刚才说的这个文件用于配置gradle属性，这个文件还可以用于配置系统属性和android属性
并且可以区分配置不同的项目的配置
1、单项目gradle使用代理：gradle/wrapper/gradle-wrapper.properties
2、全局gradle使用代理：userdir/.gradle/gradle.properties

其他的系统变量这里就不列举了，具体看我们遇到具体场景来设置

接着来看下在gradle.properties文件中如何定义变量，gradle.properties就是官方定义的用来定义变量的文件的地方，所以定义和获取就不需要像local.properties那么麻烦了。

获取变量，就不需要通过文件流读取文件流，gralde内部自身已经做了这个，我们可以直接引用变量即可。

setting.gradle前面的博客介绍了，是用于配置项目的组成和模块的，所以一半我们的setting.gradle文件都是这样的

前面有讲过setting.gradle的实质是生成一个Setting对象，我们按住ctrl点击include就进入了Setting.gradle类，其实就可以知道我们可以调用的api，这里还是介绍我们常用的几个方法吧。首先来看下最常用的 include 方法。

这里特意把注释也放了进来，不得不说老外对于注释真的写的非常详细，往往我们忽视了这么冗长的注释，但当发现问题，从搜索引擎上搜相关资料都时候就会发现，其实大部分就是对于注释都翻译。
所以这里我下面介绍都内容，就会发现和上面注释都大同小异。
首次看下这里的引入方式，一般都是 include \':app\' ，这里的语法是这样的

在这里 : 表示的路径的分隔符，也就是 \\ 的意思，所以这里都需要使用 : ，其次这里都路径是相当于根目录的路径。然后我们可以看到其实这个方法是可变参数，所以这里支持多个项目引入。

所以我们如果有一个这样的目录结构的项目

那么这时的setting.gradle就是这样

这时我们可能有个问题：我们如果引入的不是根目录下的项目怎么办？也就是引入其他路径下的项目作为我们的子module，因为这里一直是相对与根目录的路径

这样我们就可以引入不在这个项目中的Lib作为我们这个项目的Lib，组件化的工程经常就会这样使用。
最后我们看下还有一个小知识点，我们如果想改变这个Lib在Studio的显示的名称，该如何操作？

这个方法的作用就是我们这样的，可以改变Lib在IDE中的名称。

接着来看下在setting.gradle怎么定义全局变量呢？这时候就是利用gradle的拓展属性的特性了。

然后在build.gradle中使用变量的时候，就还是使用gradle.ext使用即可。

关于ext属性我们后面专门再讲下，我们前面也讲到了我们全局就只会有一个gradle对象，所以这里可以理解是一个全局的map对象，这样就好理解了很多。

至此，本篇博客对于 gradle.properties 、 local.properties 、 setting.gradle 都配置都有了一个较为详细都讲解，我们后面在使用过程中，对于这三个文件的配置都不会那么陌生，并且对于三个文件的差异都有了一个基本都认知，知道我们在定义本地变量，不同人都环境有差异都地方都应该在local.properties配置，大家共同的配置和变量定义可以放到gradle.properties这个专职用于存放配置的文件，最后就是专门用于配置我们项目的目录结构的setting.gradle，当然这个文件也可以用于配置一些变量，这时候我们就要把我单一职责的原则，也就是高内聚，低耦合那一套，按照文件职责进行划分，下一篇博客准备对build.gradle的配置进行讲解。

深入浅出Android Gradle构建系统：项目结构

来源：大头鬼Bruce（@hi大头鬼hi）

链接：http://blog.csdn.net/lzyzsd/article/details/42131637

本系列：

这篇主要介绍使用Gradle的Android项目的目录结构，以及在Gradle中的配置。

Gradle采用约定优于配置的原则，最简单方式是使用一个默认的目录结构。当然目录结构是可以自己修改的。

默认情况下，android gradle项目的代码都在src目录下，src下会有两个目录main和androidTest，其中main目录下是项目代码，androidTest目录下是测试代码。

src/main/

src/androidTest/

在main和androidTest目录下面，针对不同类型的code，又不会不同的目录。

对于Java和Android的Gradle插件，Java代码和Java资源分别对应了java目录和resources目录。Android插件还需要一些其他的目录和文件，比如

AndroidManifest.xml

res/

assets/

aidl/

rs/

jni/

下面我们来看一下如何更改这些默认的配置。

Android工程，默认情况下，java文件和resource文件分别在src/main/java和src/main/res目录下，在build.gradle文件，andorid{}里面添加下面的代码，便可以将java文件和resource文件放到src/java和src/resources目录下。（注意，如果你在gradle文件中修改了，只需要重新sync一下，gradle会自动创建新的目录，并将对应的文件移动到新的目录下）

sourceSets {

main {

java {

srcDir 'src/java'

}

resources {

srcDir 'src/resources'

}

}

}

更简便的写法是

sourceSets {

main.java.srcDirs = ['src/java']

main.resources.srcDirs = ['src/resources']

}

数组里其实是可以指定多个目录，这样就可以将代码和资源放置到多个目录下。

在看一个Android项目的例子：

android {

sourceSets {

main {

manifest.srcFile 'AndroidManifest.xml'

java.srcDirs = ['src']

resources.srcDirs = ['src']

aidl.srcDirs = ['src']

renderscript.srcDirs = ['src']

res.srcDirs = ['res']

assets.srcDirs = ['assets']

}

androidTest.setRoot('tests')

}

}

这里的main code其实使用的就是Android Gradle的默认值，而androidTest不再使用默认的androidTest目录，而是使用tests目录。

这篇先讲到这里，下一篇我会简单的介绍一个gradle的task

---

安卓应用频道

--------------------------------------

商务合作QQ：2302462408

投稿网址：top.jobbole.com