### 欢迎访问我的GitHub
> 这里分类和汇总了欣宸的全部原创(含配套源码)：[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos)

### 问题简述
- 通过Jib插件将SpringBoot工程制作成Docker镜像成功，但是运行镜像的时候报错 **(Could not find or load main class ${start-class})** ，今天来一起分析这个问题，希望能帮读者跳过小坑。
### 关于Jib插件
- 在Maven工程中可以使用Jib插件将当前Java工程构建成Docker镜像，详情请参考：
1. [《Docker与Jib(maven插件版)实战》](https://blog.csdn.net/boling_cavalry/article/details/94355659);
2. [《Jib使用小结(Maven插件版)》](https://blog.csdn.net/boling_cavalry/article/details/100179709);
### 环境信息
1. 操作系统：macOS Mojave 10.14.6 (18G103)
2. JDK：10.14.6 (18G103)
3. Docker：10.14.6 (18G103)
4. SpringBoot：2.1.8.RELEASE
5. Jib插件版本：1.6.1
### 源码下载
- 为了重现问题，我将出现问题的SpringBoot工程上传到GitHub，地址和链接信息如下表所示：

| 名称      |   链接 |   备注|
| :-------- | :----| :----|
| 项目主页| https://github.com/zq2599/blog_demos | 该项目在GitHub上的主页 |
| git仓库地址(https)| https://github.com/zq2599/blog_demos.git | 该项目源码的仓库地址，https协议 |
| git仓库地址(ssh)| git@github.com:zq2599/blog_demos.git | 该项目源码的仓库地址，ssh协议 |

- 这个git项目中有多个文件夹，本章的应用在jib-error-demo文件夹下，如下图红框所示：
![在这里插入图片描述](https://img-blog.csdnimg.cn/20190929000351485.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)
### 问题：
- 在pom.xml文件所在目录执行命令 **mvn clean compile -U** ，镜像可以构建成功，但是控制台输出了警告信息，如下图：
![在这里插入图片描述](https://img-blog.csdnimg.cn/20190928215342191.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)
- 尝试用此镜像创建容器，行命令 **docker run --name=test bolingcavalry/hellojib:0.0.1-SNAPSHOT** ，报错如下：
```shell
CN0014005932:~ zhaoqin$ docker run --name=test bolingcavalry/hellojib:0.0.1-SNAPSHOT
Error: Could not find or load main class ${start-class}
```
-  **docker ps -a** 查看容器信息如下，只能看到状态是"退出"，别的没啥了：
```shell
CN0014005932:~ zhaoqin$ docker ps -a
CONTAINER ID        IMAGE                                   COMMAND                  CREATED             STATUS                     PORTS               NAMES
d618f6588821        bolingcavalry/hellojib:0.0.1-SNAPSHOT   "java -Xms4g -Xmx4g …"   4 minutes ago       Exited (1) 4 minutes ago                       test
```
- 不甘心，用命令 **docker ps -a --no-trunc** 查看未截断的容器信息：
```shell
CN0014005932:~ zhaoqin$ docker ps -a --no-trunc
CONTAINER ID                                                       IMAGE                                   COMMAND                                                                           CREATED             STATUS                     PORTS               NAMES
d618f6588821f00d3bd0b67a85ff92988b90dfff710370c9d340d5c544c550af   bolingcavalry/hellojib:0.0.1-SNAPSHOT   "java -Xms4g -Xmx4g -cp /app/resources:/app/classes:/app/libs/* ${start-class}"   7 minutes ago       Exited (1) 7 minutes ago                       test
```
- 这次有新发现，容器启动时执行命令是 **java -Xms4g -Xmx4g -cp /app/resources:/app/classes:/app/libs/* ${start-class}** ，怪哉！这个 **\${start-class}** 是什么？我们来看一个正常镜像的启动命令：
```shell
java -Xms4g -Xmx4g -cp /app/resources:/app/classes:/app/libs/* com.bolingcavalry.jiberrordemo.JibErrorDemoApplication
```
- 如上所示， **com.bolingcavalry.jiberrordemo.JibErrorDemoApplication** 是main方法所在类，此命令可以正常运行JibErrorDemoApplication类的main方法；
- 小结问题：容器启动时执行java命令，把 **\${start-class}** 作为参数传给java，导致java无法处理此参数，所以进程报错，导致容器退出；

### 问题原因
- 此问题的原因很简单： **java工程中带有main方法的类不止一个** ，去查看jib-error-demo工程的代码，发现Utils.java中果然有个main方法：
```java
public class Utils {

public static String time(){
      return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()).toString();
    }

public static void main(String[] args){
        System.out.println(time());
    }
}
```
- 将上述main方法删除掉，再构建镜像并运行容器，证实问题已经解决。
### 另一种解决问题的方法
- 如果不想动Utils类的代码(也许jar包中某个类带有main方法)，请打开pom.xml文件，在jib插件的配置中增加 **mainClass** 节点，节点内容是指定的class类，如下图红框所示：
![在这里插入图片描述](https://img-blog.csdnimg.cn/20190928220510777.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)
- 经过上面的设置，问题也可以解决。

- 接下来，如果您有兴趣了解更深层次的原因，咱们一起来深度探险吧。
### 查找问题
- 这个问题在Jib的官方GitHub上是有记录的，先看第一条，地址是：https://github.com/GoogleContainerTools/jib/issues/1601 ，如下图红框所示，同样的问题，最后issue的发起人自己关闭了这个issue，因为他发现这自己的项目中有两个带有main方法的类：
![在这里插入图片描述](https://img-blog.csdnimg.cn/20190928201751756.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)
- 再来看看这个issue， https://github.com/GoogleContainerTools/jib/issues/170 ，Jib的作者Q Chen推测是Spring将 **\${start-class}** 这个字符串设置为Main-Class属性的值(个人感觉，这里说的Spring应该是spring boot的mave插件吧)，于是Jib插件在使用Main-Class的值得时候，拿到的就是 **\${start-class}** 这个字符串了：
![在这里插入图片描述](https://img-blog.csdnimg.cn/20190928202958532.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)
- 170这个issue的后续情节很有意思，Jib作者Q Chen对这个问题也很纠结，如果Java工程中发现了多个带有main方法的类，Jib究竟该如何处理呢？Q Chen最后决定输出警告，如下图：
![在这里插入图片描述](https://img-blog.csdnimg.cn/20190928214016699.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)
- 一起来看看这段代码吧，也就是上图中#288，地址是：https://github.com/GoogleContainerTools/jib/pull/228/files/c8757e1f9ea47edd78df18142de7836a68f22034 ，如果mainClass不像一个class类的名称，就输出警告，这个逻辑在Gradle和Maven插件中都写入了：
![在这里插入图片描述](https://img-blog.csdnimg.cn/20190928214341998.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)
- 最后一个问题：上面代码中的mainClass从哪来的？打开上图的源码，地址是：https://github.com/GoogleContainerTools/jib/blob/c8757e1f9ea47edd78df18142de7836a68f22034/jib-maven-plugin/src/main/java/com/google/cloud/tools/jib/maven/BuildImageMojo.java ，如下图红框，从方法名可以推测，该值来自构建SpringBoot工程的maven插件，所以前面Q Chen提到main-class变量的值是Spring修改的，应该是来自这段代码：
![在这里插入图片描述](https://img-blog.csdnimg.cn/20190928214641595.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)
- 此时的您，如果依然意犹未尽，咱们再来巩固一下SpringBoot的start-class
### 关于start-class
- 熟悉SpringBoot的同学其实对 **\${start-class}** 并不陌生，当工程中多个类中都有 **main** 方法时，使用该参数来指定SpringBoot的启动类；
- 先看SpringBoot官方文档熟悉一下 **start-class** ，地址是：https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/ ，下图内容比较关键：我们设置的启动类被指定到 **Start-Class** 属性中，而 **Main-Class** 属性变成了 **org.springframework.boot.loader.JarLauncher** ，这才是SpringBoot真正的启动类：
![在这里插入图片描述](https://img-blog.csdnimg.cn/20190928193456502.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)
- 如下图，这是个补充说明， **Main-Class** 属性的值被转移到 **Start-Class** 属性这个动作，是maven插件在构建jar的时候做的：
![在这里插入图片描述](https://img-blog.csdnimg.cn/20190928192155318.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)
- 所以start-class的值是来自main-class，再看main-class的值从哪里来，如下图红框所示，maven插件会去查找带有 **public static void main(String[] args)** 的类：
![在这里插入图片描述](https://img-blog.csdnimg.cn/2019092819085617.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)
- 至此，Jib构建的镜像问题分析完毕，一个小小的问题引发了这么多学习和探索，虽然有点费时间，但是可以让人再次感受到"技术是相通的"感觉，不知道您有没有这种感觉呢？

### 欢迎关注ITpub：程序员欣宸
> [学习路上，你不孤单，欣宸原创一路相伴...](http://blog.itpub.net/70017844/)

ITPub博客

Jib构建镜像问题从定位到深入分析

最新文章