欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Jib构建镜像的问题分析(Could not find or load main class ${start-class})

程序员文章站 2022-12-22 10:47:14
问题简述 通过Jib插件将SpringBoot工程制作成Docker镜像成功,但是运行镜像的时候报错(Could not find or load main class ${start class}),今天来一起分析这个问题,希望能帮读者跳过小坑。 关于Jib插件 在Maven工程中可以使用Jib插 ......

问题简述

通过jib插件将springboot工程制作成docker镜像成功,但是运行镜像的时候报错(could not find or load main class ${start-class}),今天来一起分析这个问题,希望能帮读者跳过小坑。

关于jib插件

在maven工程中可以使用jib插件将当前java工程构建成docker镜像,详情请参考:

  1. 《docker与jib(maven插件版)实战》;
  2. 《jib使用小结(maven插件版)》;

环境信息

  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文件夹下,如下图红框所示:
Jib构建镜像的问题分析(Could not find or load main class ${start-class})

问题:

  1. 在pom.xml文件所在目录执行命令mvn clean compile -u,镜像可以构建成功,但是控制台输出了警告信息,如下图:
    Jib构建镜像的问题分析(Could not find or load main class ${start-class})
  2. 尝试用此镜像创建容器,行命令docker run --name=test bolingcavalry/hellojib:0.0.1-snapshot,报错如下:
cn0014005932:~ zhaoqin$ docker run --name=test bolingcavalry/hellojib:0.0.1-snapshot
error: could not find or load main class ${start-class}
  1. docker ps -a查看容器信息如下,只能看到状态是"退出",别的没啥了:
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
  1. 不甘心,用命令docker ps -a --no-trunc查看未截断的容器信息:
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
  1. 这次有新发现,容器启动时执行命令是java -xms4g -xmx4g -cp /app/resources:/app/classes:/app/libs/* ${start-class},怪哉!这个${start-class}是什么?我们来看一个正常镜像的启动命令:
java -xms4g -xmx4g -cp /app/resources:/app/classes:/app/libs/* com.bolingcavalry.jiberrordemo.jiberrordemoapplication

如上所示,com.bolingcavalry.jiberrordemo.jiberrordemoapplication是main方法所在类,此命令可以正常运行jiberrordemoapplication类的main方法;

  1. 小结问题:容器启动时执行java命令,把${start-class}作为参数传给java,导致java无法处理此参数,所以进程报错,导致容器退出;

问题原因

此问题的原因很简单:java工程中带有main方法的类不止一个,去查看jib-error-demo工程的代码,发现utils.java中果然有个main方法:

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类,如下图红框所示:
Jib构建镜像的问题分析(Could not find or load main class ${start-class})
经过上面的设置,问题也可以解决。

接下来,如果您有兴趣了解更深层次的原因,咱们一起来深度探险吧。

查找问题

  1. 这个问题在jib的官方github上是有记录的,先看第一条,地址是:https://github.com/googlecontainertools/jib/issues/1601 ,如下图红框所示,同样的问题,最后issue的发起人自己关闭了这个issue,因为他发现这自己的项目中有两个带有main方法的类:
    Jib构建镜像的问题分析(Could not find or load main class ${start-class})
  2. 再来看看这个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}这个字符串了:
    Jib构建镜像的问题分析(Could not find or load main class ${start-class})
  3. 170这个issue的后续情节很有意思,jib作者q chen对这个问题也很纠结,如果java工程中发现了多个带有main方法的类,jib究竟该如何处理呢?q chen最后决定输出警告,如下图:
    Jib构建镜像的问题分析(Could not find or load main class ${start-class})
  4. 一起来看看这段代码吧,也就是上图中#288,地址是:https://github.com/googlecontainertools/jib/pull/228/files/c8757e1f9ea47edd78df18142de7836a68f22034 ,如果mainclass不像一个class类的名称,就输出警告,这个逻辑在gradle和maven插件中都写入了:
    Jib构建镜像的问题分析(Could not find or load main class ${start-class})
  5. 最后一个问题:上面代码中的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修改的,应该是来自这段代码:
    Jib构建镜像的问题分析(Could not find or load main class ${start-class})
    此时的您,如果依然意犹未尽,咱们再来巩固一下springboot的start-class

    关于start-class

  6. 熟悉springboot的同学其实对${start-class}并不陌生,当工程中多个类中都有main方法时,使用该参数来指定springboot的启动类;
  7. 先看springboot官方文档熟悉一下start-class,地址是:https://docs.spring.io/spring-boot/docs/current-snapshot/reference/htmlsingle/ ,下图内容比较关键:我们设置的启动类被指定到start-class属性中,而main-class属性变成了org.springframework.boot.loader.jarlauncher,这才是springboot真正的启动类:
    Jib构建镜像的问题分析(Could not find or load main class ${start-class})
  8. 如下图,这是个补充说明,main-class属性的值被转移到start-class属性这个动作,是maven插件在构建jar的时候做的:
    Jib构建镜像的问题分析(Could not find or load main class ${start-class})
  9. 所以start-class的值是来自main-class,再看main-class的值从哪里来,如下图红框所示,maven插件会去查找带有public static void main(string[] args)的类:
    Jib构建镜像的问题分析(Could not find or load main class ${start-class})
    至此,jib构建的镜像问题分析完毕,一个小小的问题引发了这么多学习和探索,虽然有点费时间,但是可以让人再次感受到"技术是相通的"感觉,不知道您有没有这种感觉呢?

    欢迎关注我的公众号:程序员欣宸

    Jib构建镜像的问题分析(Could not find or load main class ${start-class})