使用 Gradle 构建 Spring-Boot 的 Docker 镜像

通常我们使用 Dockerfile 来构建项目的Docker 镜像,但是也有需求希望使用 gralde 在编译项目的时候一起把镜像给构建并上传,所以该教程讲解了使用 gradle 编写配置 Dockerfile 并生成镜像的过程。

1. 添加依赖

教程使用gradle-docker插件来实现,在 Gradle 的脚本里配置 dockerfile 的构建镜像功能。

gradle-docker插件已经包含在 jCenterMavenCentral中。所以只需要在dependencies添加依赖就能使用 docker 插件。

build.gradle中的配置如下,其他配置省略:

buildscript {
   ...
    dependencies {
        //添加gradle-docker 依赖,版本1.2
        classpath 'se.transmode.gradle:gradle-docker:1.2'
    }
}
2. 应用插件

添加以下代码到 build.gradle

apply plugin: 'application' //可选配置
apply plugin: 'docker'

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

3. 配置镜像构建信息
  • 配置 group:
group = 'my-group'
  • 配置镜像名字和版本号:
jar {
    baseName = 'spring-boot-docker'
    version = '1.2.3'
}

配置了以上信息之后,构建的 Docker 镜像名就是:my-group/spring-boot-docker:1.2.3,可以根据实际需要进行修改。

  • 配置 docker 构建基础信息:
docker {
    baseImage 'frolvlad/alpine-oraclejdk8:slim'
    maintainer 'mcjiffy mcjiffy@mcjiffy'
    registry 'localhost:5000'
}

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

4. 添加task 任务

完成了配置,我们还需要添加一个task 用来在gradle 编译的时候能够执行镜像的构建。
插件提供了一些转换方法,用来指代Dockerfile中的关键词语法,如下表,可以按照需求对照着来:

Dockerfile 关键词 gradle task 方法
ADD addFile(Closure copySpec)
addFile(String source, String dest)
addFile(File source, String dest)
CMD defaultCommand(List cmd)
ENTRYPOINT entryPoint(List entryPoint)
ENV setEnvironment(String key, String val)
EXPOSE exposePort(Integer port)
exposePort(String port)
RUN runCommand(String cmd)
USER switchUser(String userNameOrUid)
VOLUME volume(String... paths)
WORKDIR workingDir(String dir)
  • 构建 spring-boot 项目 task 示例:
task dockerBuilder(type: Docker) {
    applicationName = jar.baseName
    tagVersion = jar.version
    volume('/tmp')
    addFile("${jar.baseName}-${jar.version}.jar","app.jar")
    entryPoint(["java","-Djava.security.egd=file:/dev/./urandom","-jar",'app.jar'])
    exposePort(8022)
    doFirst {
        copy {
            from jar
            into stageDir
        }
    }
}

其中 applicationName和 tagVersion配置了插件生成镜像名称和 tag 的信息,默认插件配置为tag = "${project.group}/${applicationName}:${tagVersion}",也可以自己指定固定值。

以上的 task 等同于Dockerfile

FROM frolvlad/alpine-oraclejdk8:slim
VOLUME /tmp
ADD spring-boot-docker-1.2.3.jar app.jar
ENTRYPOINT [ "java", "-Djava.security.egd=file:/dev/./urandom","-jar","app.jar" ]
EXPOSE 8022

一个基础的 Spring-Boot 生成 docker 镜像的配置。

  • 在 task 中使用已有的 Dockerfile
    如果觉的在 task 中编写Dockerfile替换脚本非常别扭,也可以直接在 task中指定Dockfile的文件路径,直接使用已有的文件来生成镜像:
task buildDocker(type: Docker) {
    applicationName = jar.baseName
    tagVersion = jar.version
    dockerfile = file('Dockerfile')
    doFirst {
        copy {
            from jar
            into stageDir
        }
    }
}

指定task 使用位于项目根目录的Dockerfile来生产镜像。

5.编译并构建 Spring-Boot 项目的 Docker 镜像

控制台中执行命令:./gradlew clean build dockerBuilder --info
等待出现BUILD SUCCESSFUL就证明编译成功了。
使用docker images命令可以看到新生成了一个名为my-group/spring-boot-docker,tag 是1.2.3的镜像。

6. 其他用法

gradle-docker插件还提供了配置仓库地址、配置使用 Docker Remote Api 和 Docker Hub等用法,可以参考该项目的 GitHub 地址来进行配置使用:
https://github.com/Transmode/gradle-docker

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,377评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,390评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,967评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,344评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,441评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,492评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,497评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,274评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,732评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,008评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,184评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,837评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,520评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,156评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,407评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,056评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,074评论 2 352

推荐阅读更多精彩内容