使用Maven外掛構建SpringBoot專案,生成Docker映象push到DockerHub上

搜雲庫技術團隊發表於2019-03-01

MavenSpring BootDocker

一個用於構建和推送Docker映象的Maven外掛。

使用Maven外掛構建Docker映象，將Docker映象push到DockerHub上，或者私有倉庫，上一篇文章是手寫Dockerfile，這篇文章藉助開源外掛docker-maven-plugin 進行操作

以下操作。預設你已經閱讀過我上一篇文章：

Docker 部署 SpringBoot 專案整合 Redis 映象做訪問計數Demo

www.ymq.io/2018/01/11/…

最終效果

環境準備

系統：Ubuntu 17.04 x64
Docker 17.12.0-ce

Ubuntu 17.04 x64 安裝 Docker CE

www.ymq.io/2018/01/11/…

外掛地址

docker-maven-plugin

GitHub 地址:github.com/spotify/doc…

一、簡單使用

1.修改POM

在pom.xml中新增下面這段，

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>

        <!-- docker的maven外掛，官網：https://github.com/spotify/docker-maven-plugin -->
        <plugin>
            <groupId>com.spotify</groupId>
            <artifactId>docker-maven-plugin</artifactId>
            <version>0.4.12</version>
            <configuration>
                <!-- 注意imageName一定要是符合正則[a-z0-9-_.]的，否則構建不會成功 -->
                <!-- 詳見：https://github.com/spotify/docker-maven-plugin    Invalid repository name ... only [a-z0-9-_.] are allowed-->
                <imageName>microservice-discovery-eureka</imageName>
                <baseImage>java</baseImage>
                <entryPoint>["java", "-jar", "/${project.build.finalName}.jar"]</entryPoint>
                <resources>
                    <resource>
                        <targetPath>/</targetPath>
                        <directory>${project.build.directory}</directory>
                        <include>${project.build.finalName}.jar</include>
                    </resource>
                </resources>
            </configuration>
        </plugin>

    </plugins>
</build>
複製程式碼

2.構建映象

使用 maven 命令： mvn clean package docker:build

& cd /opt/other-projects/docker-spring-boot-demo-maven-plugin
& mvn clean package docker:build
複製程式碼

我們會發現控制檯有類似如下內容：

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

[INFO] 
[INFO] --- maven-jar-plugin:2.6:jar (default-jar) @ docker-spring-boot-demo-maven-plugin ---
[INFO] Building jar: /opt/other-projects/docker-spring-boot-demo-maven-plugin/target/docker-spring-boot-demo-maven-plugin-0.0.1-SNAPSHOT.jar
[INFO] 
[INFO] --- spring-boot-maven-plugin:1.5.9.RELEASE:repackage (default) @ docker-spring-boot-demo-maven-plugin ---
[INFO] 
[INFO] --- docker-maven-plugin:0.4.12:build (default-cli) @ docker-spring-boot-demo-maven-plugin ---
[INFO] Copying /opt/other-projects/docker-spring-boot-demo-maven-plugin/target/docker-spring-boot-demo-maven-plugin-0.0.1-SNAPSHOT.jar -> /opt/other-projects/docker-spring-boot-demo-maven-plugin/target/docker/docker-spring-boot-demo-maven-plugin-0.0.1-SNAPSHOT.jar
[INFO] Building image docker-spring-boot-demo-maven-plugin
Step 1/3 : FROM java

 ---> d23bdf5b1b1b
Step 2/3 : ADD /docker-spring-boot-demo-maven-plugin-0.0.1-SNAPSHOT.jar //

 ---> b5d8f92756f2
Step 3/3 : ENTRYPOINT ["java", "-jar", "/docker-spring-boot-demo-maven-plugin-0.0.1-SNAPSHOT.jar"]

 ---> Running in 6867f460b40c
Removing intermediate container 6867f460b40c
 ---> 378fd82432e0
ProgressMessage{id=null, status=null, stream=null, error=null, progress=null, progressDetail=null}
Successfully built 378fd82432e0
Successfully tagged docker-spring-boot-demo-maven-plugin:latest
[INFO] Built docker-spring-boot-demo-maven-plugin
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 20.568 s
[INFO] Finished at: 2018-01-15T09:21:39+00:00
[INFO] Final Memory: 37M/89M
[INFO] ------------------------------------------------------------------------
root@souyunku:/opt/other-projects/docker-spring-boot-demo-maven-plugin#
複製程式碼

恭喜，構建成功了。

-我們執行docker images 會發現該映象已經被構建成功：

& root@souyunku:# docker images docker-spring-boot-demo-maven-plugin
REPOSITORY                             TAG                 IMAGE ID            CREATED             SIZE
docker-spring-boot-demo-maven-plugin   latest              378fd82432e0        3 minutes ago       659MB
複製程式碼

3.啟動映象

root@souyunku:# docker run --name MySpringBootMavenPlugin -d -p 8080:80 docker-spring-boot-demo-maven-plugin
84ebb2ebb8c002d3935e6e31c6d2aab05c32c075036368228e84f818d20ded4a
複製程式碼

4.檢視容器

& root@souyunku:# docker container ps -a
CONTAINER ID        IMAGE                                  COMMAND                  CREATED             STATUS              PORTS                    NAMES
84ebb2ebb8c0        docker-spring-boot-demo-maven-plugin   "java -jar /docker-s…"   About an hour ago   Up About an hour    0.0.0.0:8080->80/tcp     MySpringBootMavenPlugin
複製程式碼

5.訪問服務

瀏覽器輸入：http://Docker宿主機IP:8080能夠正常看到介面,文章開頭的最終效果頁面。

二、使用Dockerfile

1.新建Dockerfile

使用Dockerfile進行構建Docker映象

上文講述的方式是最簡單的方式，很多時候，我們還是要藉助Dockerfile進行構建的，
首先我們在/docker-spring-boot-demo-maven-plugin/src/main/resources目錄下，建立檔案Dockerfile

FROM java:8
VOLUME /tmp
ADD docker-spring-boot-demo-maven-plugin-0.0.1-SNAPSHOT.jar app.jar
RUN bash -c `touch /app.jar`
EXPOSE 9000
ENTRYPOINT ["java","-Djava.security.egd=file:/dev/./urandom","-jar","/app.jar"]
複製程式碼

2.修改POM

專案pom.xml修改為如下：指定Dockerfile所在的路徑

<build>
	<plugins>
		<!-- docker的maven外掛，官網：https://github.com/spotify/docker-maven-plugin -->
		<plugin>
			<groupId>com.spotify</groupId>
			<artifactId>docker-maven-plugin</artifactId>
			<version>0.4.12</version>
			<configuration>
				<!-- 注意imageName一定要是符合正則[a-z0-9-_.]的，否則構建不會成功 -->
				<!-- 詳見：https://github.com/spotify/docker-maven-plugin    Invalid repository name ... only [a-z0-9-_.] are allowed-->
				<imageName>docker-spring-boot-demo-maven-plugin</imageName>
				<!-- 指定Dockerfile所在的路徑 -->
				<dockerDirectory>${basedir}/src/main/resources</dockerDirectory>
				<resources>
					<resource>
						<targetPath>/</targetPath>
						<directory>${project.build.directory}</directory>
						<include>${project.build.finalName}.jar</include>
					</resource>
				</resources>
			</configuration>
		</plugin>
	</plugins>
</build>
複製程式碼

3.構建映象

使用 maven 命令： mvn clean package docker:build

& cd /opt/other-projects/docker-spring-boot-demo-maven-plugin
& mvn clean package docker:build
複製程式碼

4.啟動映象

root@souyunku:# docker run --name MySpringBootMavenPlugin -d -p 8080:80 docker-spring-boot-demo-maven-plugin
84ebb2ebb8c002d3935e6e31c6d2aab05c32c075036368228e84f818d20ded4a
複製程式碼

其他步驟和上面一樣。這樣即可使用Dockerfile進行構建Docker映象啦。

5.訪問服務

瀏覽器輸入：http://Docker宿主機IP:8080能夠正常看到介面,文章開頭的最終效果頁面。

三、push 映象

將Docker映象push到DockerHub上

1.修改Maven配置

首先修改Maven的全域性配置檔案settings.xml，

檢視settings.xml 所在位置

root@souyunku:# find / -name settings.xml
/etc/maven/settings.xml
複製程式碼

新增以下段落

vi /etc/maven/settings.xml
複製程式碼

<servers>
    <server>
        <id>docker-hub</id>
        <username>DockerHub 的賬號</username>
        <password>DockerHub 的密碼</password>
        <configuration>
            <email>admin@souyunku.com</email>
        </configuration>
    </server>
</servers>
複製程式碼

2.建立Repository

註冊個賬號：hub.docker.com/

在DockerHub上建立Create Repository ,例如：docker-spring-boot-demo-maven-plugin，如下圖

3.修改POM

專案pom.xml修改為如下：注意imageName的路徑要和repo的路徑一致

映象名稱

<properties>
	<docker.image.prefix>souyunku</docker.image.prefix>
</properties>
複製程式碼

將Docker映象push到DockerHub上

<!--3：將Docker映象push到DockerHub上-->

<!-- docker的maven外掛，官網：https://github.com/spotify/docker-maven-plugin -->
<plugin>
	<groupId>com.spotify</groupId>
	<artifactId>docker-maven-plugin</artifactId>
	<version>0.4.12</version>
	<configuration>
		<!-- 注意imageName一定要是符合正則[a-z0-9-_.]的，否則構建不會成功 -->
		<!-- 詳見：https://github.com/spotify/docker-maven-plugin Invalid repository
			name ... only [a-z0-9-_.] are allowed -->
		<!-- 如果要將docker映象push到DockerHub上去的話，這邊的路徑要和repo路徑一致 -->
		<imageName>${docker.image.prefix}/${project.artifactId}</imageName>
		<!-- 指定Dockerfile所在的路徑 -->
		<dockerDirectory>${basedir}/src/main/resources</dockerDirectory>
		<resources>
			<resource>
				<targetPath>/</targetPath>
				<directory>${project.build.directory}</directory>
				<include>${project.build.finalName}.jar</include>
			</resource>
		</resources>
		<!-- 以下兩行是為了docker push到DockerHub使用的。 -->
		<serverId>docker-hub</serverId>
		<registryUrl>https://index.docker.io/v1/</registryUrl>
	</configuration>
</plugin>
複製程式碼

4.構建映象

使用 maven 命令： mvn clean package docker:build -DpushImage

& cd /opt/other-projects/docker-spring-boot-demo-maven-plugin
& mvn clean package docker:build  -DpushImage
複製程式碼

看到類似這樣的資料，就證明構建映象沒毛病

[INFO] Building image souyunku/docker-spring-boot-demo-maven-plugin
Step 1/6 : FROM java:8

 ---> d23bdf5b1b1b
Step 2/6 : VOLUME /tmp

 ---> Using cache
 ---> cb237cc84527
Step 3/6 : ADD docker-spring-boot-demo-maven-plugin-0.0.1-SNAPSHOT.jar app.jar

 ---> 7fb5e3363ed5
Step 4/6 : RUN bash -c `touch /app.jar`

 ---> Running in ab5d10dd64ad
Removing intermediate container ab5d10dd64ad
 ---> 05d96fe59da4
Step 5/6 : EXPOSE 9000

 ---> Running in d63e20122d8e
Removing intermediate container d63e20122d8e
 ---> 55ba378141fd
Step 6/6 : ENTRYPOINT ["java","-Djava.security.egd=file:/dev/./urandom","-jar","/app.jar"]

 ---> Running in 962d476363a3
Removing intermediate container 962d476363a3
 ---> 654b596fe91f
ProgressMessage{id=null, status=null, stream=null, error=null, progress=null, progressDetail=null}
Successfully built 654b596fe91f
Successfully tagged souyunku/docker-spring-boot-demo-maven-plugin:latest
[INFO] Built souyunku/docker-spring-boot-demo-maven-plugin
[INFO] Pushing souyunku/docker-spring-boot-demo-maven-plugin
The push refers to repository [docker.io/souyunku/docker-spring-boot-demo-maven-plugin]
464800d90790: Pushed 
d52b146f9147: Pushed 
35c20f26d188: Mounted from souyunku/docker-spring-boot-demo 
c3fe59dd9556: Mounted from souyunku/docker-spring-boot-demo 
6ed1a81ba5b6: Mounted from souyunku/docker-spring-boot-demo 
a3483ce177ce: Mounted from souyunku/docker-spring-boot-demo 
ce6c8756685b: Mounted from souyunku/docker-spring-boot-demo 
30339f20ced0: Mounted from souyunku/docker-spring-boot-demo 
0eb22bfb707d: Mounted from souyunku/docker-spring-boot-demo 
a2ae92ffcd29: Mounted from souyunku/docker-spring-boot-demo 
latest: digest: sha256:8d78ced0034f38be8086c8f812817ec4c12b178470b4cea668046906c825c9ee size: 2424
null: null 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 41.764 s
[INFO] Finished at: 2018-01-16T09:56:23+00:00
[INFO] Final Memory: 36M/88M
[INFO] ------------------------------------------------------------------------
root@souyunku:/opt/other-projects/docker-spring-boot-demo-maven-plugin# 
複製程式碼

5.檢視映象

root@souyunku:# docker images souyunku/docker-spring-boot-demo-maven-plugin 
REPOSITORY                                      TAG                 IMAGE ID            CREATED             SIZE
souyunku/docker-spring-boot-demo-maven-plugin   latest              654b596fe91f        27 minutes ago      674MB
複製程式碼

root@souyunku:# docker images souyunku/docker-spring-boot-demo-maven-plugin 
REPOSITORY                                      TAG                 IMAGE ID            CREATED             SIZE
souyunku/docker-spring-boot-demo-maven-plugin   latest              654b596fe91f        27 minutes ago      674MB
複製程式碼

Docker Hub 檢視映象，看到已經上傳成功

6.啟動映象

root@souyunku:# docker run --name MySpringBootMavenPlugin -d -p 8080:80 docker-spring-boot-demo-maven-plugin
84ebb2ebb8c002d3935e6e31c6d2aab05c32c075036368228e84f818d20ded4a
複製程式碼

其他步驟和上面一樣。這樣即可使用Dockerfile進行構建Docker映象啦。

7.訪問服務

瀏覽器輸入：http://Docker宿主機IP:8080能夠正常看到介面,文章開頭的最終效果頁面。

四、繫結phase執行

將外掛繫結在某個phase執行

在很多場景下，我們有這樣的需求，例如執行mvn clean package 時，自動地為我們構建docker映象，可以嗎？答案是肯定的。我們只需要將外掛的goal 繫結在某個phase即可。

所謂的phase和goal，可以這樣理解：maven命令格式是：mvn phase:goal ，例如mvn package docker:build 那麼，package 和 docker 都是phase，build 則是goal 。

1.修改POM

下面是示例：

首先配置屬性：

<properties>
	<docker.image.prefix>souyunku</docker.image.prefix>
</properties>
複製程式碼

<plugin>
	<groupId>com.spotify</groupId>
	<artifactId>docker-maven-plugin</artifactId>
	<version>0.4.12</version>
	
	<executions>
		<execution>
			<id>build-image</id>
			<phase>package</phase>
			<goals>
				<goal>build</goal>
			</goals>
		</execution>
	</executions>
	
	<configuration>
		<!-- 注意imageName一定要是符合正則[a-z0-9-_.]的，否則構建不會成功 -->
		<!-- 詳見：https://github.com/spotify/docker-maven-plugin Invalid repository
			name ... only [a-z0-9-_.] are allowed -->
		<!-- 如果要將docker映象push到DockerHub上去的話，這邊的路徑要和repo路徑一致 -->
		<imageName>${docker.image.prefix}/${project.artifactId}</imageName>
		<!-- 指定Dockerfile所在的路徑 -->
		<dockerDirectory>${basedir}/src/main/resources</dockerDirectory>
		<resources>
			<resource>
				<targetPath>/</targetPath>
				<directory>${project.build.directory}</directory>
				<include>${project.build.finalName}.jar</include>
			</resource>
		</resources>
		<!-- 以下兩行是為了docker push到DockerHub使用的。 -->
		<serverId>docker-hub</serverId>
		<registryUrl>https://index.docker.io/v1/</registryUrl>
	</configuration>
</plugin>
複製程式碼

新加內容

<executions>
	<execution>
		<id>build-image</id>
		<phase>package</phase>
		<goals>
			<goal>build</goal>
		</goals>
	</execution>
</executions>
複製程式碼

本例指的是講docker的build目標，繫結在package這個phase上。
也就是說，使用者只需要執行mvn package ，就自動執行了mvn docker:build 。

2.構建映象

使用 maven 命令： mvn package

& cd /opt/other-projects/docker-spring-boot-demo-maven-plugin
& mvn package
複製程式碼

3.啟動映象

root@souyunku:# docker run --name MySpringBootMavenPlugin -d -p 8080:80 docker-spring-boot-demo-maven-plugin
84ebb2ebb8c002d3935e6e31c6d2aab05c32c075036368228e84f818d20ded4a
複製程式碼

4.訪問服務

瀏覽器輸入：http://Docker宿主機IP:8080能夠正常看到介面,文章開頭的最終效果頁面。

推薦閱讀：Docker Hub 倉庫使用，及搭建 Docker Registry

www.ymq.io/2017/12/31/…

GitHub :docker-spring-boot-demo-maven-plugin

github.com/souyunku/ot…

Contact

作者：鵬磊
出處：www.ymq.io/2018/01/15/…
Email：admin@souyunku.com
版權歸作者所有，轉載請註明出處
Wechat：關注公眾號，搜雲庫，專注於開發技術的研究與知識分享

使用maven外掛構建docker映象
2017-12-22
MavenDocker
Springboot專案Github Action生成Docker映象
2020-12-16
Spring BootGithubDocker
apisix閘道器-構建docker映象構建及外掛化開發
2020-09-19
APIDocker
如何使用jenkins自動生成springboot專案的docker映象
2018-02-09
JenkinsSpring BootDocker
使用Maven構建Java專案
2019-01-19
MavenJava
【Maven實戰技巧】「外掛使用專題」Maven-Archetype外掛建立自定義maven專案骨架
2021-12-08
Maven
Java(SpringBoot)專案打包(構建)成`Docker`映象的幾種方式
2023-01-11
JavaSpring BootDocker
docker製作自己的映象並上傳dockerhub
2021-11-24
Docker
docker 打包映象推送至dockerhub
2020-09-07
Docker
eclipse 使用 maven 構建專案
2017-09-28
EclipseMaven
maven 學習總結(三)——使用Maven構建專案
2015-09-22
Maven
Maven 構建 Java 專案
2022-07-27
MavenJava
Maven Web專案構建
2015-08-11
MavenWeb
nukkit maven 專案除錯外掛
2024-03-31
Maven除錯
JAVA專案映象構建
2024-03-28
Java
docker構建映象
2020-09-28
Docker
如何使用Docker構建前端專案
2022-05-09
Docker前端
首次使用ideal構建maven專案web
2018-09-29
IdeaMavenWeb
Azure Devops實踐（5）- 構建springboot專案打包docker映象及容器化部署
2021-10-13
devSpring BootDocker
Maven外掛生成myBatis逆向工程
2020-12-16
MavenMyBatis
Docker 構建 kubectl 映象
2021-01-04
Docker
Docker映象構建（五）
2018-07-10
Docker
SpringBoot 構建 Docker 映象的最佳 3 種方式
2020-11-17
Spring BootDocker
maven 學習總結(八)——使用Maven構建多模組專案
2015-09-22
Maven
Docker映象構建原理解析(不裝docker也能構建映象)
2021-03-01
Docker
使用gradle構建springboot專案
2019-03-03
GradleSpring Boot
基於jib-maven-plugin快速構建微服務docker映象
2023-02-22
MavenPlugin微服務Docker
從零構建Java專案（Maven+SpringBoot+Git） #02 奧斯丁專案
2021-12-07
JavaMavenSpring BootGit
【Maven實戰技巧】「外掛使用專題」Maven-Assembly外掛實現自定義打包
2021-08-03
Maven
微服務部署-基於DockerMaven外掛構建映象部署
2020-12-01
微服務DockerMaven
解決專案版本衝突——maven-shade外掛使用
2024-10-13
Maven
用dockerfile構建docker映象
2016-03-15
Docker
Docker 映象構建之 Dockerfile
2024-03-20
Docker
docker 構建自己的映象
2024-05-16
Docker
使用 Docker 開發 - 使用多階段構建映象
2020-07-04
Docker
Docker-映象釋出到Dockerhub和阿里雲
2020-12-16
Docker阿里
你竟然沒用 Maven 構建專案？
2019-07-03
Maven
構建dubbo分散式平臺-maven構建根專案
2018-08-29
分散式Maven

使用Maven外掛構建SpringBoot專案,生成Docker映象push到DockerHub上

最終效果

環境準備

外掛地址

一、簡單使用

1.修改POM

2.構建映象

3.啟動映象

4.檢視容器

5.訪問服務

二、使用Dockerfile

1.新建Dockerfile

2.修改POM

3.構建映象

4.啟動映象

5.訪問服務

三、push 映象

1.修改Maven配置

2.建立Repository

3.修改POM

4.構建映象

5.檢視映象

6.啟動映象

7.訪問服務

四、繫結phase執行

1.修改POM

2.構建映象

3.啟動映象

4.訪問服務

Contact

相關文章