一、说明
如果你使用的是 Spring Boot 默认的打包方式(通过 spring-boot-maven-plugin
插件),那么生成的 JAR 文件结构中就会包含 BOOT-INF
目录。
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
1.1、JAR 结构示例(Spring Boot 可执行 JAR):
your-app.jar
├── META-INF/
│ └── MANIFEST.MF
├── org/
│ └── springframework/
│ └── boot/loader/... # Spring Boot 的启动类加载器
├── BOOT-INF/
│ ├── classes/ # 你的项目代码(.class 文件)
│ │ └── cn/
│ │ └── jt/
│ │ └── sensitiveword/
│ │ └── annotation/
│ │ └── YourAnnotation.class
│ └── lib/ # 项目依赖的第三方 jar 包
│ ├── spring-boot-starter-web-*.jar
│ └── ...
二、关键问题:BOOT-INF/classes
中的类不能被外部项目直接引用
当你把这样一个 Spring Boot 打出来的 fat jar(可执行 jar) 作为依赖引入到另一个项目时:
<dependency>
<groupId>cn.aa</groupId>
<artifactId>sensitive-word-starter</artifactId>
<version>1.0.0</version>
</dependency>
JVM 的类加载器 不会自动去 BOOT-INF/classes
下加载类,所以你就会遇到:
❌ 找不到类:
cn.aa.sensitiveword.annotation.YourAnnotation
因为这个路径不在标准的 classpath 搜索范围内。
三、解决
1、在pmo.xml中将 spring-boot-maven-plugin
去掉,如下
2、那么springBoot就会使用默认的 maven-jar-plugin
,这种方式打出来的jar,其他项目就可以引入调用。
四、总结
1、如果你的 JAR 包是作为公共库(比如工具类、注解、SDK、Starter 等)被其他项目依赖的,那么你不应该使用 spring-boot-maven-plugin
打成可执行 fat jar,而是应该使用 标准的 Maven 打包方式 —— 也就是默认的 maven-jar-plugin
。
这里默认的
maven-jar-plugin
,就是你什么都不用在pom.xml中的plugins节点 配置,就行,但是如果你配置了 spring-boot-maven-plugin,那记得把这个去掉
4.1、正确选择:使用默认的 maven-jar-plugin
这个插件是 Maven 默认自带的,不需要显式配置就能工作。它会把你的 Java 代码编译后打包成一个标准的 JAR 文件,如下图这个就是标准的JAR文件,没有 BOOT-INF 文件
这种 JAR 可以被其他项目(Spring Boot 或非 Spring Boot)正常依赖和导入类。
4.2、什么时候用什么插件?
项目类型 | 使用插件 | 是否包含 BOOT-INF | 是否可被依赖引用 |
---|---|---|---|
Spring Boot 应用(可执行程序) | spring-boot-maven-plugin | ✅ 是 | ❌ 不能直接作为依赖 |
公共库 / 工具类 / 注解 / Starter | ❌ 不要用 spring-boot-maven-plugin ✅ 用默认 maven-jar-plugin | ❌ 否 | ✅ 可被正常引用 |
4.2.1、不要引入 spring-boot-maven-plugin
<!-- ❌ 删除这段(如果你加了的话) -->
<!--
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
-->
4.2.2、确保 packaging
是 jar
(默认),即什么都不配置即可,只要移除
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
<packaging>jar</packaging>