gradle中的增量构建浅析

简介

在我们使用的各种工具中，为了提升工作效率，总会使用到各种各样的缓存技术，比如说docker中的layer就是缓存了之前构建的image。在gradle中这种以task组合起来的构建工具也不例外，在gradle中，这种技术叫做增量构建。

增量构建

gradle为了提升构建的效率，提出了增量构建的概念，为了实现增量构建，gradle将每一个task都分成了三部分，分别是input输入，任务本身和output输出。下图是一个典型的java编译的task。

以上图为例，input就是目标jdk的版本，源代码等，output就是编译出来的class文件。

增量构建的原理就是监控input的变化，只有input发送变化了，才重新执行task任务，否则gradle认为可以重用之前的执行结果。

所以在编写gradle的task的时候，需要指定task的输入和输出。

并且要注意只有会对输出结果产生变化的才能被称为输入，如果你定义了对初始结果完全无关的变量作为输入，则这些变量的变化会导致gradle重新执行task，导致了不必要的性能的损耗。

还要注意不确定执行结果的任务，比如说同样的输入可能会得到不同的输出结果，那么这样的任务将不能够被配置为增量构建任务。

自定义inputs和outputs

既然task中的input和output在增量编译中这么重要，本章将会给大家讲解一下怎么才能够在task中定义input和output。

如果我们自定义一个task类型，那么满足下面两点就可以使用上增量构建了：

第一点，需要为task中的inputs和outputs添加必要的getter方法。

第二点，为getter方法添加对应的注解。

gradle支持三种主要的inputs和outputs类型：

1. 简单类型：简单类型就是所有实现了Serializable接口的类型，比如说string和数字。
2. 文件类型：文件类型就是 File 或者 FileCollection 的衍生类型，或者其他可以作为参数传递给 Project.file(java.lang.Object) 和 Project.files(java.lang.Object…) 的类型。
3. 嵌套类型：有些自定义类型，本身不属于前面的1，2两种类型，但是它内部含有嵌套的inputs和outputs属性，这样的类型叫做嵌套类型。

接下来，我们来举个例子，假如我们有一个类似于FreeMarker和Velocity这样的模板引擎，负责将模板源文件，要传递的数据最后生成对应的填充文件，我们考虑一下他的输入和输出是什么。

输入：模板源文件，模型数据和模板引擎。

输出：要输出的文件。

如果我们要编写一个适用于模板转换的task，我们可以这样写：

1. import java.io.File;
2. import java.util.HashMap;
3. import org.gradle.api.*;
4. import org.gradle.api.file.*;
5. import org.gradle.api.tasks.*;
6.  
7. public class ProcessTemplates extends DefaultTask {
8. private TemplateEngineType templateEngine;
9. private FileCollection sourceFiles;
10. private TemplateData templateData;
11. private File outputDir;
12.  
13. @Input
14. public TemplateEngineType getTemplateEngine() {
15. return this.templateEngine;
16. }
17.  
18. @InputFiles
19. public FileCollection getSourceFiles() {
20. return this.sourceFiles;
21. }
22.  
23. @Nested
24. public TemplateData getTemplateData() {
25. return this.templateData;
26. }
27.  
28. @OutputDirectory
29. public File getOutputDir() { return this.outputDir; }
30.  
31. // 上面四个属性的setter方法
32.  
33. @TaskAction
34. public void processTemplates() {
35. // ...
36. }
37. }

上面的例子中，我们定义了4个属性，分别是TemplateEngineType，FileCollection，TemplateData和File。前面三个属性是输入，后面一个属性是输出。

除了getter和setter方法之外，我们还需要在getter方法中添加相应的注释： @Input , @InputFiles ,@Nested 和 @OutputDirectory, 除此之外，我们还定义了一个 @TaskAction 表示这个task要做的工作。

TemplateEngineType表示的是模板引擎的类型，比如FreeMarker或者Velocity等。我们也可以用String来表示模板引擎的名字。但是为了安全起见，这里我们自定义了一个枚举类型，在枚举类型内部我们可以安全的定义各种支持的模板引擎类型。

因为enum默认是实现Serializable的，所以这里可以作为@Input使用。

sourceFiles使用的是FileCollection，表示的是一系列文件的集合，所以可以使用@InputFiles。

为什么TemplateData是@Nested类型的呢？TemplateData表示的是我们要填充的数据，我们看下它的实现：

1. import java.util.HashMap;
2. import java.util.Map;
3. import org.gradle.api.tasks.Input;
4.  
5. public class TemplateData {
6. private String name;
7. private Map<String, String> variables;
8.  
9. public TemplateData(String name, Map<String, String> variables) {
10. this.name = name;
11. this.variables = new HashMap<>(variables);
12. }
13.  
14. @Input
15. public String getName() { return this.name; }
16.  
17. @Input
18. public Map<String, String> getVariables() {
19. return this.variables;
20. }
21. }

可以看到，虽然TemplateData本身不是File或者简单类型，但是它内部的属性是简单类型的，所以TemplateData本身可以看做是@Nested的。

outputDir表示的是一个输出文件目录，所以使用的是@OutputDirectory。

使用了这些注解之后，gradle在构建的时候就会检测和上一次构建相比，这些属性有没有发送变化，如果没有发送变化，那么gradle将会直接使用上一次构建生成的缓存。

注意，上面的例子中我们使用了FileCollection作为输入的文件集合，考虑一种情况，假如只有文件集合中的某一个文件发送变化，那么gradle是会重新构建所有的文件，还是只重构这个被修改的文件呢？
留给大家讨论

除了上讲到的4个注解之外，gradle还提供了其他的几个有用的注解：

@InputFile： 相当于File，表示单个input文件。

@InputDirectory： 相当于File，表示单个input目录。

@Classpath： 相当于Iterable，表示的是类路径上的文件，对于类路径上的文件需要考虑文件的顺序。如果类路径上的文件是jar的话，jar中的文件创建时间戳的修改，并不会影响input。

@CompileClasspath：相当于Iterable，表示的是类路径上的java文件，会忽略类路径上的非java文件。

@OutputFile： 相当于File，表示输出文件。

@OutputFiles： 相当于Map<String, File> 或者 Iterable，表示输出文件。

@OutputDirectories： 相当于Map<String, File> 或者 Iterable，表示输出文件。

@Destroys： 相当于File 或者 Iterable，表示这个task将会删除的文件。

@LocalState： 相当于File 或者 Iterable，表示task的本地状态。

@Console： 表示属性不是input也不是output，但是会影响console的输出。

@Internal： 内部属性，不是input也不是output。

@ReplacedBy： 属性被其他的属性替换了，不能算在input和output中。

@SkipWhenEmpty： 和@InputFiles 跟 @InputDirectory一起使用，如果相应的文件或者目录为空的话，将会跳过task的执行。

@Incremental： 和@InputFiles 跟 @InputDirectory一起使用，用来跟踪文件的变化。

@Optional： 忽略属性的验证。

@PathSensitive： 表示需要考虑paths中的哪一部分作为增量的依据。

运行时API

自定义task当然是一个非常好的办法来使用增量构建。但是自定义task类型需要我们编写新的class文件。有没有什么办法可以不用修改task的源代码，就可以使用增量构建呢？

答案是使用Runtime API。

gradle提供了三个API，用来对input，output和Destroyables进行获取：

• Task.getInputs() of type TaskInputs
• Task.getOutputs() of type TaskOutputs
• Task.getDestroyables() of type TaskDestroyables

获取到input和output之后，我们就是可以其进行操作了，我们看下怎么用runtime API来实现之前的自定义task：

1. task processTemplatesAdHoc {
2. inputs.property("engine", TemplateEngineType.FREEMARKER)
3. inputs.files(fileTree("src/templates"))
4. .withPropertyName("sourceFiles")
5. .withPathSensitivity(PathSensitivity.RELATIVE)
6. inputs.property("templateData.name", "docs")
7. inputs.property("templateData.variables", [year: 2013])
8. outputs.dir("$buildDir/genOutput2")
9. .withPropertyName("outputDir")
10.  
11. doLast {
12. // Process the templates here
13. }
14. }

上面例子中，inputs.property() 相当于 @Input ，而outputs.dir() 相当于@OutputDirectory。

Runtime API还可以和自定义类型一起使用：

1. task processTemplatesWithExtraInputs(type: ProcessTemplates) {
2. // ...
3.  
4. inputs.file("src/headers/headers.txt")
5. .withPropertyName("headers")
6. .withPathSensitivity(PathSensitivity.NONE)
7. }

上面的例子为ProcessTemplates添加了一个input。

隐式依赖

除了直接使用dependsOn之外，我们还可以使用隐式依赖：

1. task packageFiles(type: Zip) {
2. from processTemplates.outputs
3. }

上面的例子中，packageFiles 使用了from，隐式依赖了processTemplates的outputs。

gradle足够智能，可以检测到这种依赖关系。

上面的例子还可以简写为：

1. task packageFiles2(type: Zip) {
2. from processTemplates
3. }

我们看一个错误的隐式依赖的例子：

1. plugins {
2. id 'java'
3. }
4.  
5. task badInstrumentClasses(type: Instrument) {
6. classFiles = fileTree(compileJava.destinationDir)
7. destinationDir = file("$buildDir/instrumented")
8. }

这个例子的本意是执行compileJava任务，然后将其输出的destinationDir作为classFiles的值。

但是因为fileTree本身并不包含依赖关系，所以上面的执行的结果并不会执行compileJava任务。

我们可以这样改写：

1. task instrumentClasses(type: Instrument) {
2. classFiles = compileJava.outputs.files
3. destinationDir = file("$buildDir/instrumented")
4. }

或者使用layout：

1. task instrumentClasses2(type: Instrument) {
2. classFiles = layout.files(compileJava)
3. destinationDir = file("$buildDir/instrumented")
4. }

或者使用buildBy：

1. task instrumentClassesBuiltBy(type: Instrument) {
2. classFiles = fileTree(compileJava.destinationDir) {
3. builtBy compileJava
4. }
5. destinationDir = file("$buildDir/instrumented")
6. }

输入校验

gradle会默认对@InputFile ，@InputDirectory 和 @OutputDirectory 进行参数校验。

如果你觉得这些参数是可选的，那么可以使用@Optional。

自定义缓存方法

上面的例子中，我们使用from来进行增量构建，但是from并没有添加@InputFiles， 那么它的增量缓存是怎么实现的呢？

我们看一个例子：

1. public class ProcessTemplates extends DefaultTask {
2. // ...
3. private FileCollection sourceFiles = getProject().getLayout().files();
4.  
5. @SkipWhenEmpty
6. @InputFiles
7. @PathSensitive(PathSensitivity.NONE)
8. public FileCollection getSourceFiles() {
9. return this.sourceFiles;
10. }
11.  
12. public void sources(FileCollection sourceFiles) {
13. this.sourceFiles = this.sourceFiles.plus(sourceFiles);
14. }
15.  
16. // ...
17. }

上面的例子中，我们将sourceFiles定义为可缓存的input，然后又定义了一个sources方法，可以将新的文件加入到sourceFiles中，从而改变sourceFile input，也就达到了自定义修改input缓存的目的。

我们看下怎么使用：

1. task processTemplates(type: ProcessTemplates) {
2. templateEngine = TemplateEngineType.FREEMARKER
3. templateData = new TemplateData("test", [year: 2012])
4. outputDir = file("$buildDir/genOutput")
5.  
6. sources fileTree("src/templates")
7. }

我们还可以使用project.layout.files()将一个task的输出作为输入，可以这样做：

1. public void sources(Task inputTask) {
2. this.sourceFiles = this.sourceFiles.plus(getProject().getLayout().files(inputTask));
3. }

这个方法传入一个task，然后使用project.layout.files()将task的输出作为输入。

看下怎么使用：

1. task copyTemplates(type: Copy) {
2. into "$buildDir/tmp"
3. from "src/templates"
4. }
5.  
6. task processTemplates2(type: ProcessTemplates) {
7. // ...
8. sources copyTemplates
9. }

非常的方便。

如果你不想使用gradle的缓存功能，那么可以使用upToDateWhen()来手动控制：

1. task alwaysInstrumentClasses(type: Instrument) {
2. classFiles = layout.files(compileJava)
3. destinationDir = file("$buildDir/instrumented")
4. outputs.upToDateWhen { false }
5. }

上面使用false，表示alwaysInstrumentClasses这个task将会一直被执行，并不会使用到缓存。

输入归一化

要想比较gradle的输入是否是一样的，gradle需要对input进行归一化处理，然后才进行比较。

我们可以自定义gradle的runtime classpath 。

1. normalization {
2. runtimeClasspath {
3. ignore 'build-info.properties'
4. }
5. }

上面的例子中，我们忽略了classpath中的一个文件。

我们还可以忽略META-INF中的manifest文件的属性：

1. normalization {
2. runtimeClasspath {
3. metaInf {
4. ignoreAttribute("Implementation-Version")
5. }
6. }
7. }

忽略META-INF/MANIFEST.MF ：

1. normalization {
2. runtimeClasspath {
3. metaInf {
4. ignoreManifest()
5. }
6. }
7. }

忽略META-INF中所有的文件和目录：

1. normalization {
2. runtimeClasspath {
3. metaInf {
4. ignoreCompletely()
5. }
6. }
7. }

其他使用技巧

如果你的gradle因为某种原因暂停了，你可以送 --continuous 或者 -t 参数，来重用之前的缓存，继续构建gradle项目。

你还可以使用 --parallel 来并行执行task。

到此这篇关于gradle中的增量构建的文章就介绍到这了,更多相关gradle增量构建内容请搜索服务器之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持服务器之家！

原文链接：https://blog.csdn.net/superfjj/article/details/113836856