Gradle配置SpringBoot多环境打包

Gradle Task

实现使用Gradle配置SpringBoot多环境打包，首先要搞清楚Gradle的Task。本文中仅介绍用需要注意的点。具体的可以查看其他博主的文章或者查看官方文档。

首先是第一个问题：task中的代码一定是在task执行时运行的吗？

来看下面两个任务

task t1 {
    println "t1"
}

task t2 {
    println "t2"
}

无论我们调用 gradle t1 还是 gradle t2 这两个 println 都会打印。如下：

这是因为其实task中的代码是配置代码。在任务启动时，gradle会全部执行一遍。

如果一定要在任务调用时才执行，应该使用doFirst 包裹要执行的代码。

task t1 {
    println "t1"
    doFirst {
        println "do t1"
    }
}

task t2 {
    println "t2"
    doFirst {
        println "do t2"
    }
}

在执行 t1 的是时候只打印了 t1 中 doFirst 的代码，而没有执行t2中的。

ReplaceTokens

还需要了解的一点是，我们要替换配置文件中的变量。用到的就是 org.apache.tools.ant.filters.ReplaceTokens。这个过滤器会将用 @var@ 包裹的变量，替换为指定的值。

如 application.yaml 中有如下配置

spring:
  profiles:
    active: @activeProfile@

使用下面的gradle配置，可以将变量替换为 dev

processResources {
    doFirst {
        filter ReplaceTokens, tokens: [activeProfile: "dev"]
    }
}

而spring无论是启动还是打包都是会先执行这个任务的。如下SpringBoot的bootRun 执行时的任务链。

> Task :compileJava UP-TO-DATE
> Task :processResources
> Task :classes
> Task :bootRunMainClassName

> Task :bootRun

所以我们要实现多环境打包，必须要借助 processResources 任务。

实现多环境打包配置

我们这里实现在开发工具中启动SpringBoot时用 dev 环境，同时配置一个测试环境的打包任务和一个生产环境的打包任务。

task bootJarTest {
    dependsOn 'clean'
    doFirst {
        System.setProperty("profile", "test")
    }
    finalizedBy("bootJar")
}

task bootJarProduction {
    dependsOn 'clean'
    doFirst {
        System.setProperty("profile", "prod")
    }
    finalizedBy("bootJar")
}

processResources {
    doFirst {
        filter ReplaceTokens, tokens: [activeProfile: System.getProperty("profile", "dev")]
    }
}

System.getProperty("profile", "dev") 表示获取系统变量 profile 的值，如果没有就用 dev。

dependsOn 'clean' 表示打包时依赖 clean 任务，打包时如果不先清理原来已经编译好的代码，可能会出现变量无法被正确替换的问题。

bootJar 是SpringBoot的打包任务。finalizedBy("bootJar") 表示在最后调用 bootJar。如果要打成war包，则此处调用 bootWar，具体的可参考官方文档。

filter ReplaceTokens, tokens: [activeProfile: System.getProperty("profile", "dev")] 一定要写到 processResources 中的 doFirst 中。

如果写成下面的配置

processResources {
    filter ReplaceTokens, tokens: [activeProfile: System.getProperty("profile", "dev")]
}

则在打包的时候不会替换变量，这是因为在任务启动时，过滤器就已经执行，及过滤器在配置阶段就执行了。而变量的设置是在任务的执行阶段，所以如果要是写成上面的代码，则配置文件中永远只会被替换为 dev

很多博文中要么直说打包的配置，要么只说启动的配置。无法兼容两者，本文中的方法可以使两者兼容。如果有更好的方法，欢迎指教。