本教程将引导你通过建立一个Docker镜像来运行Spring Boot应用。
你将构建什么
Docker是一个具有社區性的Linux容器管理工具集,它允許用户发布镜像或者使用其他开发者发布的镜像。Docker镜像本質上是一个進程的运行環境。在這篇guide中,我們将构建一个運行Spring Boot应用程序的鏡像。
构建之前你要准备的东西
- 大约十五分钟的时间
- 一个你最喜欢的文本编辑器或者IDE
- JDK1.8+
- Gradle2.3+或者Maven3.0+
- 你也可以直接将代码导入你的IDE
- Spring Tool Suite (STS)
- IntelliJ IDEA
如果你当前使用的系统不是Linux,那么你需要一个虚拟机。通过安装VirtualBox或者像mac的boot2docker等其他工具都可以满足你的使用。
访问VirtualBox下载地址选择你的系统版本来下载VirtualBox,并且安装运行起来。
当然你也需要安装Docker(只能在64位机器上运行),有关详细信息请参阅https://docs.docker.com/installation/#installation来安装Docker到你的系统上。开始下一步之前,你要确认在你的shell上是否可以运行docker
命令,如果你使用的是boot2docker,在运行docker
命令之前你需要先启动boot2docker。
如何完成这篇教程
像大多数的Spring系列教程 Getting Started guides,你可以从头开始,完成每一步,也可以跳过已经熟悉的基本構建步骤。 无论哪种方式,你都可以成功。
使用maven构建
首先你得安装构建脚本. 你可以使用你喜欢的构建系统去构建Spring应用,你可以前往Maven官网来指导你安装。 如果你对Maven不熟悉,请参阅使用Maven构建Java项目.
创建目录结构
在你当前项目工作目录中,创建如下子目录:
1
2
3
4
|
└── src
└── main
└── java
└── hello
|
如在Linux系统下使用mkdir -p src/main/java/hello
来创建。
pom.xml
4.0.0
org.springframework
gs-spring-boot-docker
0.1.0
org.springframework.boot
spring-boot-starter-parent
1.5.4.RELEASE
1.8
org.springframework.boot
spring-boot-starter-web
org.springframework.boot
spring-boot-starter-test
test
org.springframework.boot
spring-boot-maven-plugin
Spring Boot maven插件 提供了很多便捷的功能:
- 它集中了
classpath
下的所有jar,并构建一个可运行的“uber-jar”,这样可以更方便地执行和发布服务。
- 它查找
public static void main()
方法并标记该类为可执行类。
- 它提供了一个内置的依赖解析器,将应用与Spring Boot依赖的版本号进行匹配。你可以修改(override)成你希望的版本,但它默认为Spring Boot选择的版本。
使用你的IDE构建
- 参阅Spring Tool Suite如何直接导入到你的IDE。
- 参阅IntelliJ IDEA如何来构建。
创建一个Spring Boot应用程序
现在你可以创建一个简单的Spring Boot应用程序。
src/main/java/hello/Application.java
package hello;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@SpringBootApplication
@RestController
public class Application {
@RequestMapping("/")
public String home() {
return "Hello Docker World";
}
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
这个类使用@SpringBootApplication
注解和@RestController
注解标记,表示这个类已经准备好使用Spring MVC来处理web请求。@RequestMapping
映射/
在home()
方法上,這個方法返回Hello Docker World
的响应。main()
方法调SpringApplication.run()
方法来启动应用程序。
现在你可以在没有Docker的情况下运行该应用程序。
如果你使用gradle构建的Spring Boot应用程序,执行:
./gradlew build && java -jar build/libs/gs-spring-boot-docker-0.1.0.jar
如果你使用maven构建的,执行:
./mvnw package && java -jar target/gs-spring-boot-docker-0.1.0.jar
然后访问localhost:8080就可以看见Hello Docker World
字样。
使你的应用程序容器化
Docker有一个Dockerfile文件格式的文件,并且使用指定的镜像作为基础镜像。接下来我们去创建一个Dockerfile在Spring Boot应用程序中。
Dockerfile
1
2
3
4
5
|
FROM openjdk:
8-jdk-alpine
VOLUME /tmp
ADD target/gs-spring-boot-docker-0.1.0.jar app.jar
ENV JAVA_OPTS=""
ENTRYPOINT exec java $JAVA_OPTS -Djava.security.egd=file:/dev/./urandom -jar /app.jar
|
这个Dockerfile很简单,但是已经包含了你运行这个Spring Boot应用程序的所有东西并且没有多余的东西:仅仅只有Java和一个Jar文件。应用程序的jar文件(文件名为app.jar)被添加到容器中,执行 ENTRYPOINT
我们增加了一个VOLUME
指向”/tmp”,因为那是Spring Boot应用程序为Tomcat创建的默认工作目录。作用是在你的主机”/var/lib/docker”目录下创建一个临时的文件,并且链接到容器中的”/tmp”目录。对于简单程序这一步是可选的,但是对于其他想要真实写入文件系统的Spring Boot应用程序又是必选的。
我们增加了一个指向”/dev/urandom”的Tomcat系统属性来缩小Tomcat的启动时间。
如果你使用的是boot2docker,在你使用Docker命令或者使用构建工具构建(它运行在守护进程,在虚拟机上为你工作)之前,你必须先启动它。
构建Docker镜像,你可以使用一些诸如Gradle或Maven的工具或者借助社区(强烈感谢Transmode和Spotify提供这些工具)。
使用Maven构建Docker镜像
在Maven的pom.xml
中,你应该增加一个插件,如下。(参阅the plugin documentation获取更多信息)。
pom.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
<properties>
<docker.image.prefix>springio
docker.image.prefix>
properties>
<build>
<plugins>
<plugin>
<groupId>com.spotify
groupId>
<artifactId>dockerfile-maven-plugin
artifactId>
<version>1.3.4
version>
<configuration>
<repository>${docker.image.prefix}/${project.artifactId}
repository>
configuration>
plugin>
plugins>
build>
|
配置指定了两个东西:
- 镜像名字,最终会在
springio/gs-spring-boot-docker
- 可选,镜像的标签,未指定默认为
latest
,如果有需要的话,也可以指定artifact id
。
继续下面的步骤之前(使用Docker CLI工具),输入docker ps
确保正常运行,如果有错误信息,大概因为没有设置其他什么信息。如果使用的Mac,在.bash_profile
(或者是类似env-setting配置文件)最后增加$(boot2docker shellinit 2> /dev/null)
并刷新你的shell,确保更改生效。
你可以使用下面的命令来构建Docker的镜像:
1
|
$ ./mvnw install dockerfile:build
|
你可以使用./mvnw dockerfile:push
命令发布镜像到Docker
镜像中心去。
你不用着急发布你刚刚制作的镜像,如果你不是”springio”组织的成员push
命令会失败。改变构建的配置和命令行中的用户名为自己的而不是”springio”就可以正常工作。
你可以让dockerfile:push
自动运行在安装或部署生命周期阶段,通过将其添加到插件配置中。
pom.xml
1
2
3
4
5
6
7
8
9
10
|
<executions>
<execution>
<id>default
id>
<phase>install
phase>
<goals>
<goal>build
goal>
<goal>push
goal>
goals>
execution>
executions>
|
发布之后
对你来说”Docker镜像发布”会失败(除非你在Dockerhub中是”springio”组织的一员),但是如果你修改配置符合你自己的docker ID之后同样会成功,你会有一个新的标签,并且部署镜像。
如果你没有注册docker,或者没有发布任何docker镜像。但是你有一个本地的镜像,你可以像这样让它运行起来:
1
2
3
4
|
$ docker run -p 8080:8080 -t springio/gs-spring-boot-docker
....
2015-03-31 13:25:48.035 INFO 1 --- [ main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http)
2015-03-31 13:25:48.037 INFO 1 --- [ main] hello.Application : Started Application in 5.613 seconds (JVM running for 7.293)
|
然后应用程序可以在http://localhost:8080/访问(访问可以看到”Hello Docker World”)。确保它是真的在工作,把”springio”前缀改成其他(比如${env.USER}
并且重新构建运行)。
如果你使用mac的boot2docker,你通常在启动时可以看到这样的事情:
1
2
3
4
|
Docker client to the Docker daemon, please
set:
export DOCKER_CERT_PATH=/Users/gturnquist/.boot2docker/certs/boot2docker-vm
export DOCKER_TLS_VERIFY=1
export DOCKER_HOST=tcp://192.168.59.103:2376
|
查看应用程序,你必须访问Docker主机而不是本地主机的ip(localhost),在这种情况下,http://192.168.59.103:8080/,对于VM来说就是开发的ip。
当它正在运行,你可以在容器列表中看到:
1
2
3
|
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
81c723d22865 springio/gs-spring-boot-docker:latest
"java -jar /app.jar" 34 seconds ago Up 33 seconds 0.0.0.0:8080->8080/tcp goofy_brown
|
你可以使用docker stop
加上容器的id来关闭它。
1
2
|
$ docker stop 81c723d22865
81c723d22865
|
当然你喜欢你也可以删除容器(它们都保存在/var/lib/docker
文件目录下)。
1
|
$ docker rm 81c723d22865
|
使用Spring Profiles
运行你新制作的镜像使用Spring Profiles,和运行docker命令传入一个环境变量一样简单。
1
|
$ docker run -e
"SPRING_PROFILES_ACTIVE=prod" -p 8080:8080 -t springio/gs-spring-boot-docker
|
或
1
|
$ docker run -e
"SPRING_PROFILES_ACTIVE=dev" -p 8080:8080 -t springio/gs-spring-boot-docker
|
在Docker容器中调试应用程序
使用JPDA Transport可以调试应用程序,所以我们可以视容器为一个服务器,启用此功能通过java设置JAVA_OPTS变量和代理的端口映射到本地主机在一个容器中运行。对于Docker for Mac由于有限制,我们不能通过IP访问容器因为没有black magic usage.。
1
|
$ docker run -e
"JAVA_OPTS=-agentlib:jdwp=transport=dt_socket,address=5005,server=y,suspend=n" -p 8080:8080 -p 5005:5005 -t springio/gs-spring-boot-docker
|
总结
恭喜你!刚刚为Spring Boot应用程序创建了Docker容器!Spring Boot应用程序在容器中运行默认端口8080映射到相同的宿主机端口使用”-p”参数。
另请参阅
以下教程也可能是有用的:
- Serving Web Content with Spring MVC
- Building an Application with Spring Boot
本文由spring4all.com翻译小分队创作,采用知识共享-署名-非商业性使用-相同方式共享 4.0 国际 许可协议进行许可。
原文作者: spring4all翻译小分队
原文链接: http://www.spring4all.com/spring-guildes/spring-boot-with-docker.html
许可协议: 知识共享署名-非商业性使用 4.0 国际许可协议