gradle 对应 spring boot版本 spring boot gradle docker

前言

通常我们使用 Dockerfile 来构建项目的 Docker 镜像。但是也有使用 gradle 在编译项目的时候一起把镜像给 构建 并 上传 的需求。本文将会讲解如何使用 gradle 编写并配置 Dockerfile 并生成 镜像。

正文

1. 创建项目

利用 Spring Initializer 创建一个 gradle 项目 spring-boot-gradle-for-docker，创建时添加一个 web 依赖。得到的初始 build.gradle 如下：

buildscript {
 ext {
 springBootVersion = '2.0.2.RELEASE'
 }
 repositories {
 mavenCentral()
 }
 dependencies {
 classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
 }
}
apply plugin: 'java'
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'
group = 'io.ostenant.springboot.sample'
version = '1.0'
sourceCompatibility = 1.8
repositories {
 mavenCentral()
 jcenter()
}
dependencies {
 compile('org.springframework.boot:spring-boot-starter-web')
 testCompile('org.springframework.boot:spring-boot-starter-test')
}

2. 配置入口类

为了方便容器部署的测试，在 Spring Boot 启动类上配置一个控制器，响应当前的系统时间。

@RestController
@SpringBootApplication
public class Application {
 private ThreadLocal threadLocal = ThreadLocal.withInitial(() -> new SimpleDateFormat("yyyy/MM/dd hh:mm:ss"));
 public static void main(String[] args) {
 SpringApplication.run(Application.class, args);
 }
 @GetMapping("/")
 public String retrieveTime() {
 return threadLocal.get().format(new Date());
 }
}

3. 添加插件

这里使用 gradle-docker 插件 来实现 docker 镜像构建。这样，我们就可以直接在 Gradle 的脚本里配置 Dockerfile 达到 构建镜像 功能的目的。

gradle-docker 插件已经被上传到 jCenter 和 MavenCentral 上。所以只需要在 dependencies 添加依赖 se.transmode.gradle:gradle-docker:1.2 就能使用 docker 插件。

buildscript {
 ext {
 springBootVersion = '2.0.2.RELEASE'
 }
 repositories {
 mavenCentral()
 }
 dependencies {
 classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
 classpath("se.transmode.gradle:gradle-docker:1.2")
 }
}

4. 应用插件

添加以下代码到 build.gradle中

apply plugin: 'application'

apply plugin: 'docker'

如果添加了 application 插件的话，默认 gradle-docker 插件会添加一个 distDocker 的 gradle task，用来构建一个 包含所有程序文件 的 docker 镜像。

5. 配置镜像构建信息

5.1. 配置group

group = 'io.ostenant.springboot.sample'

5.2. 配置镜像名称和版本号

jar {
 baseName = "spring-boot-gradle-for-docker"
 version = 1.0
}

其中镜像的 tag 默认的构成为：项目组/应用名称:版本号

tag = "${project.group}/${applicationName}:${tagVersion}"

• project.group：标准的 gradle 属性，如果不进行定义，插件默认会 省略 ${project.group} 这个属性。
• applicationName：应用被容器化时的 名称。
• tagVersion：可选属性，会作为镜像的 标签。默认值为 project.version，如果未指定 project.version，则使用 latest 作为标记。

5.3. 配置docker构建基础信息

distDocker {
 baseImage = "openjdk"
 maintainer = "harrison"
}

其中，baseImage 相当于 Dockerfile 中声明的 FROM。声明了在 构建镜像 是基于的 Image，maintainer 相当于 MAINTAINER ，声明了 镜像作者。如果声明了 registry 地址，插件在 镜像射生成后 可以自动 push 到该地址。其他的配置还包括 docker hub 的 地址、用户名 和 密码。

更详细的配置案例如下：

docker {
 baseImage 'openjdk'
 maintainer 'harrison'
 useApi true
 hostUrl 'http://myserver:4243'
 apiUsername 'user'
 apiPassword 'password'
 apiEmail '[e-mail]'
}

6. 添加task任务

完成了基本的配置，我们还需要添加一个 task 用来在 gradle 编译的时候 执行镜像构建。

插件提供了一些 转换方法，用来指代 Dockerfile 中的 关键词语法，如下表，可以按照需求对照着来：

下面是本项目的 taskBuilder 的任务配置

task dockerBuilder(type: Docker) {
 applicationName = jar.baseName
 tagVersion = jar.version
 volume('/tmp')
 addFile("${jar.baseName}-${jar.version}.jar