如何使用 Gradle 并减少构建时间加速构建速度

发布于 2022-04-19 12:46:41 字数 9205 浏览 1125 评论 0

对于一款构建工具来说，首要的使命便是将项目构建起来，然后才是考虑如何加快构建的速度。毕竟在持续集成的开发理念之下，跑ci就是程序员日常最经常要做的事情，而等待的过程往往是非常漫长的，甚至于有童鞋专门去买了本字帖，以便于在每次等ci的时候打发时间。

这篇文章首先会从如何使用 Gradle 插件开始，毕竟要先干活，然后进阶到如何写一个自定义 Task，以及 Incremental Task 的原理。当然，最后总结几个可以直接用于加快 Gradle 构建速度的优化技巧，简单粗暴，立马生效！

如何使用 Gradle 插件

我们在 Java 项目根目录下会有一个 build.gradle 文件，Gradle 的所有配置都可以放在这个文件里面。首先从最基本的 Java 插件说起，大部分的项目构建流程都是：编译 Java 源文件，运行单元测试，最终生成一个包含所有 class 文件的 JAR 包，而 Gradle 使用插件的形式来使整个过程自动化，只需要使用 apply plugin: 'java'，然后就可以通过命令行使用与之相关的 Task 了：

Task 名称	依赖于	Task 类型	描述
assemble	所有用于项目归档打包的包括 jar 在内的 Task，一些插件可以提供额外的 Task。	Task	装配项目中所有已归档的文件。
check	项目中包括 test 在内的所有验证任务，也有一些插件可以提供额外的 Task。	Task	执行所有验证任务。
build	check（验证检查）和 assemble（装配打包）	Task	执行完整的项目构建任务。

上面的生命周期 Tasks 都会依赖于其他的基本 Task：

然后只需要运行 gradle clean build 就会自动执行，当然这里还有很多其他的官方插件或者第三方插件，比如 checkstyle 和 pact-jvm。

最后来一个完整的 build.gradle 示例：

apply plugin: 'java'

group = 'org.gradle.example'
version = '1.0.0'
sourceCompatibility = targetCompatibility = 1.7

repositories {
    mavenCentral()
}

dependencies {
    compile 'org.slf4j:slf4j-api:1.7.10'
    runtime 'org.slf4j:slf4j-simple:1.7.10'
    testCompile 'junit:junit:4.12'
}

jar {
    manifest {
        attributes 'Main-Class': "${project.group}.App"
    }
}

task sourceJar(type: Jar) {
    classifier = 'sources'
    from sourceSets.main.allSource
}

自定义 Task

Gradle 的一大亮点就是 FULLY PROGRAMMABLE BUILDS，你可以将以往的配置和重复动作都使用 Groovy 脚本自动化管理起来，无限制定制化：

Conventions derive powerful build logic from a single line of configuration. The build language makes way for unlimited customization, allowing you to adapt Gradle to concisely fit the needs of your organization.

Hello World!

按照国际惯例先来一个 HelloWorld:

task hello << {
    println 'Hello world!'
}

> gradle -q hello
Hello world!

另外一个常用的语法就是定义 Task 之间的依赖关系，所依赖的 Task 会按顺序依次运行：

task intro(dependsOn: [hello, foo, bar]) << {
    println "I'm Gradle"
}

> gradle -q intro
Hello world!
I'm Gradle

而与此同时通过命令行还可以排除所依赖的 Task，通过gradle -q tasks可以显示已经定义的所有 Task，当然 Task 还可以直接使用缩写形式：compileTest -> cT。

> gradle intro -x foo bar
Hello world!
I'm Gradle

更多关于 Task 的内容戳这里，当构建任务复杂度上升之后，你可以像编程一样分文件来组织不同的任务，以便于管理和设置各自 Task 的内容属性等，而if-else、class以及注解都不在话下，它就是一种 Groovy DSL 语言。

Incremental Task

首先在 Task 里面有一个up-to-date的概念，可以自动跳过没有任何更新的 Task 从而加快构建速度。使用 TaskInputs 和 TaskOutputs 属性定义好 Task 的输入输出文件之后，在第一次运行 Task 的时候，Gradle 会记录 input 文件内容的 Hash 值快照，也会记录下 Task 运行成功之后的 output 快照。而在这之后，每当 Task 被执行之前 Gradle 就会以前所保存的快照进行对比，只有在有差异的情况才会重新执行该 Task。

task generator {
    def fileCount = 10
    inputs.property "fileCount", fileCount
    def generatedFileDir = file("$buildDir/generated")
    outputs.dir generatedFileDir
    doLast {
        println "generating file."
        generatedFileDir.mkdirs()
        for (int i=0; i<fileCount; i++) {
            new File(generatedFileDir, "${i}.txt").text = i
        }
    }
}

> gradle generator
:generator
generating file.
# Run again!
> gradle generator  –info
Skipping task ‘:generator’ as it is up-to-date (took 0.007 secs).
:generator UP-TO-DATE

我们还可以定义 Task 的类型，除了输入和输出之后需要一个带有@TaskAction 注解的方法，然后该任务就可以针对 out of date 的输入文件执行相应的操作，并且对于自上次操作已被删除的输入文件执行单独的动作，更多内容戳这里。

class IncrementalReverseTask extends DefaultTask {
     @InputDirectory
     def File inputDir

     @OutputDirectory
     def File outputDir

     @TaskAction
     void execute(IncrementalTaskInputs inputs) {
         if (!inputs.incremental)
             project.delete(outputDir.listFiles())

         inputs.outOfDate { change ->
             def targetFile = project.file("$outputDir/${change.file.name}")
             targetFile.text = change.file.text.reverse()
         }

         inputs.removed { change ->
             def targetFile = project.file("$outputDir/${change.file.name}")
             if (targetFile.exists()) {
                 targetFile.delete()
             }
         }
     }
 }

比如说像JavaCompile这样 Gradle 内置的一些插件都使用 Incremental Task 的原理，已经定义好了 inputs (Java source files)以及 outputs (class files)，从而我们就可以在配置使用增量编译这样的功能了：

apply plugin: 'java'
    compileJava {
        //enable incremental compilation
        options.incremental = true
    }

加快 Gradle 构建速度

0x00. 升级 Gradle 版本并且使用 Wrapper

Gradle Wrapper 是由 Windows batch 脚本以及 OS X 和 Linux 的 shell 脚本共同组成，这就允许你在没有安装 Gradle 的任意操作系统上都能马上构建自己的项目。在build.gradle文件中加入 wrapper 任务并指定最新的版本，然后运行gradle wrapper就可以快速升级了：

task wrapper(type: Wrapper) {
    gradleVersion = '2.8'
}

0x01. 分析构建报告

「知己知彼方能百战百胜」。首先在执行任务的时候加上gradle --profile，就可以记录一些有用的信息并且在build/reports/profile目录下生成相应的报告，然后分析到底在哪部分花费了过多的时间，可以细分到具体的 Task 然后才可以进行优化。

0x02. 开始增量编译

上面已经提到了，在 Java Compile 任务中加入以下配置已进入使用增量编译模式：

apply plugin: 'java'
compileJava {
    //enable compilation in a separate daemon process
    options.fork = true

    //enable incremental compilation
    options.incremental = true
}

0x03. 开启并行化和后台进程

org.gradle.parallel=true
org.gradle.daemon=true
org.gradle.jvmargs=-Xms256m -Xmx1024m

与此同时还可以通过命令行参数--parallel-threads=4指定并行线程的个数，而在开启过后可以使用gradlew --stop停止所有 Gradle 进程，这也包括了非 daemon 的进程，那什么是 daemon戳这里。还可以调整 Java 虚拟机的参数，这将加快构建本身，解释请看StackOverflow 的答案。

0x04. 使用 JCenter 而不是 Maven Central

请看 JCenter 的 slogn：Forget about Maven Central.

0x05. 使用 offline 模式

通过使用--profile生成的报告就可以发现，在构建过程中最大的耗时都在于 JavaCompile 这个 Task，而观察 log 就发现罪魁祸首就在于 resolving dependencies，也就是解析依赖的这一步。一般情况下，Gradle 都会将项目依赖缓存在本地中，所以使用--offline，就可以让它不再去联网检查更新，没必要。

0x06. 优化 Task 内容以及执行顺序

比如说在我们的项目当中有一个 asciidoctor 的任务是用于将 Swagger Test 所生成的内容转化为 HTML5 和 PDF 文件，这显然在开发的时候并不需要每次都去生成，所以就可以使用-x参数去跳过这个 Task。

gradlew build -x asciidoctor

与此同时，在跑ci（具体内容为gradlew clean build pactverify）的时候我们会执行一个 pactverify 的任务去做 Contact Testing，而这个 Task 需要启动我们真实的应用程序，然后再去验证实实在在的返回值，也就是说依赖于/等待于gradlew bootRun这个漫长的 Task，而gradlew bootRun又是依赖于graldew build这个 Task 的，更可怕的是graldew build又依赖于:compileJava，结果在没有使用 offline 模式的情况下，跑ci的时间就被整整拖成了将近十分钟，这岂不是等死个人。

所以在gradlew pactverify这个任务当中所执行的 bootRun 任务加上 offline 模式变成gradlew bootRun --offline -x build，因为在跑ci的时候早就已经解析过一遍依赖并且build过了，所以最终将整个跑ci的时间最短控制在一分钟左右。

当然需要注意的一个问题就是不要将ci脚本中的--offline参数提交到远程的 Jenkins 服务器上了，因为那台机子还是需要每次都去解析最新的项目依赖。一个技巧就是将ci脚本这个文件的修改放在 Intellij IDEA 的 Default 文件修改列表中，每次提交代码的时候不选中它就好了。