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

简介: 使用Jib插件构建的SpringBoot工程的镜像,在运行时报错:Could not find or load main class ${start-class},今天就来一起分析这个问题,除了解决它,还要追溯Jib作者的思路和行动,去深入了解

欢迎访问我的GitHub

这里分类和汇总了欣宸的全部原创(含配套源码): 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插件版)实战》;
  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文件夹下,如下图红框所示:

在这里插入图片描述

问题:

  • 在pom.xml文件所在目录执行命令mvn clean compile -U,镜像可以构建成功,但是控制台输出了警告信息,如下图:

在这里插入图片描述

  • 尝试用此镜像创建容器,行命令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}
  • 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
  • 不甘心,用命令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
  • 这次有新发现,容器启动时执行命令是java -Xms4g -Xmx4g -cp /app/resources:/app/classes:/app/libs/* ${start-class}</font>,怪哉!这个<font color="red">\${start-class}是什么?我们来看一个正常镜像的启动命令:
java -Xms4g -Xmx4g -cp /app/resources:/app/classes:/app/libs/* com.bolingcavalry.jiberrordemo.JibErrorDemoApplication
  • 如上所示,com.bolingcavalry.jiberrordemo.JibErrorDemoApplication是main方法所在类,此命令可以正常运行JibErrorDemoApplication类的main方法;
  • 小结问题:容器启动时执行java命令,把&dollar;{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的官方GitHub上是有记录的,先看第一条,地址是:https://github.com/GoogleContainerTools/jib/issues/1601 ,如下图红框所示,同样的问题,最后issue的发起人自己关闭了这个issue,因为他发现这自己的项目中有两个带有main方法的类:

在这里插入图片描述

  • 再来看看这个issue, https://github.com/GoogleContainerTools/jib/issues/170 ,Jib的作者Q Chen推测是Spring将&dollar;{start-class}这个字符串设置为Main-Class属性的值(个人感觉,这里说的Spring应该是spring boot的mave插件吧),于是Jib插件在使用Main-Class的值得时候,拿到的就是&dollar;{start-class}这个字符串了:

在这里插入图片描述

  • 170这个issue的后续情节很有意思,Jib作者Q Chen对这个问题也很纠结,如果Java工程中发现了多个带有main方法的类,Jib究竟该如何处理呢?Q Chen最后决定输出警告,如下图:

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

  • 此时的您,如果依然意犹未尽,咱们再来巩固一下SpringBoot的start-class

关于start-class

  • 熟悉SpringBoot的同学其实对&dollar;{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真正的启动类:

在这里插入图片描述

  • 如下图,这是个补充说明,Main-Class属性的值被转移到Start-Class属性这个动作,是maven插件在构建jar的时候做的:

在这里插入图片描述

  • 所以start-class的值是来自main-class,再看main-class的值从哪里来,如下图红框所示,maven插件会去查找带有public static void main(String[] args)的类:

在这里插入图片描述

  • 至此,Jib构建的镜像问题分析完毕,一个小小的问题引发了这么多学习和探索,虽然有点费时间,但是可以让人再次感受到"技术是相通的"感觉,不知道您有没有这种感觉呢?

欢迎关注阿里云开发者社区博客:程序员欣宸

学习路上,你不孤单,欣宸原创一路相伴...
相关文章
|
机器学习/深度学习 算法 安全
密码学系列之六:公钥密码体制
密码学系列之六:公钥密码体制
1147 0
|
存储 Java Apache
Maven - 统一构建规范:Maven 插件管理最佳实践
Maven - 统一构建规范:Maven 插件管理最佳实践
1628 0
|
机器学习/深度学习 人工智能 算法
阿里公开自研AI集群细节:64个GPU,百万分类训练速度提升4倍
从节点架构到网络架构,再到通信算法,阿里巴巴把自研的高性能AI集群技术细节写成了论文,并对外公布。
阿里公开自研AI集群细节:64个GPU,百万分类训练速度提升4倍
|
人工智能 Serverless
两步构建 AI 总结助手,实现智能文档摘要
本方案将运用函数计算 FC,构建一套高可用性的 Web 服务,以满足用户多样化的需求。当用户发起请求时,系统内部会自动将包含文本和提示词的信息传递给百炼模型服务,百炼平台将根据后台配置调用相应的大模型服务,对文本数据进行智能识别与解析,最终将总结结果返回给用户。
854 20
|
消息中间件 监控 搜索推荐
OpenFeign日志组件Logger原理与应用
该文章详细解释了如何在OpenFeign中配置并使用请求和响应的GZIP压缩功能。
|
人工智能 决策智能 C++
【AI Agent系列】【阿里AgentScope框架】5. Pipeline模块的组合使用及Pipeline模块总结
【AI Agent系列】【阿里AgentScope框架】5. Pipeline模块的组合使用及Pipeline模块总结
967 1
|
前端开发 Java 数据库连接
开源一个基于SpringBoot的咖啡商城系统
开源一个基于SpringBoot的咖啡商城系统
565 0
开源一个基于SpringBoot的咖啡商城系统
|
XML 消息中间件 Java
Java(SpringBoot)项目打包(构建)成Docker镜像的几种方式
也就是使用Docker的打包命令去打包,麻烦,我这里不多说。
1504 1
|
IDE Java 开发工具
Spring Boot DevTools:加速开发的热部署工具
【4月更文挑战第28天】在Spring Boot的开发过程中,快速反馈和效率至关重要。Spring Boot DevTools是一个为开发者设计的模块,支持热部署(hot swapping),能够实现应用的快速重启和自动重载,极大地提高了开发效率。本篇博客将介绍Spring Boot DevTools的核心概念,并通过具体的实战示例展示如何在开发过程中利用这一工具。
641 0
|
存储 缓存 NoSQL
Guava 缓存详解及使用
Guava Cache 是`Google Fuava`中的一个内存缓存模块,用于将数据缓存到JVM内存中。 本文主要介绍下Guava缓存的配置详解及相关使用 缓存分为本地缓存与分布式缓存。本地缓存为了保证线程安全问题,一般使用`ConcurrentMap`的方式保存在内存之中,而常见的分布式缓存则有`Redis`,`MongoDB`等。