springboot项目编译后无法扫描加载到子jar包中的注解解决方法

清疚 2021-08-27 02:20 1174阅读 0赞

[http://blog.sina.com.cn/s/blog\_cfee55a70102yvyd.html][http_blog.sina.com.cn_s_blog_cfee55a70102yvyd.html]

A项目依赖B项目，B项目中存在@service等注解，在本地eclipse中运行A项目时可以正常扫描B项目的注解创建对象。

但经过打包后，B项目和A项目的目录结构变成

\+BOOT-INF

+classes

+lib

\+META-INF

\+org.springframework.boot.loader

B项目本身又作为A项目BOOT-INF/lib下的jar包，A项目使用java -jar从入口启动类启动后无法扫描到B项目的注解，

且B项目中的lib也与A项目中的lib下jar包存在重复。

解决方法，在B项目的pom.xml文件中添加<classifier>exec</classifier>

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o2OTE4Mzc4Nw_size_16_color_FFFFFF_t_70][]

这样B项目编译后target目录下会产生两个文件

B.jar  B-exec.jar

其中B-exec.jar和之前的结构一样

B.jar的目录结构是非springboot编译项目，只有B项目自身的文件

\+META-INF

\+com.B项目包名

配置文件....

这样再对A项目打包后，A项目BOOT-INF/lib目录下只会加入B.jar，实测启动可以正常扫描到B项目中的注解

如果需要单独执行B项目，只需执行B-exec.jar即可

\--------------------------------------------------------------------------------

### **场景2:** ###

因为之前用到的是,基于springboot框架所搭建的maven工程,而且都是相互独立的。现研发经理要求将所有工程进行整合和规范化,所以抽出一个**parent父工程**,**base基础模块(**包含一些公用的实体类和工具类等**)**,以及**其他子模块**(**Module A、 Module B ...**)。**Module A** 以及**Module B**工程都需要依赖**base工程**。

### **问题:** ###

在对**Module A**进行打包时,**出现问题:Module A中所依赖的base工程的util程序包不存在**。即使能打包成功,用java -jar启动jar包也会报Class Not Found,依赖的base工程的类找不到。

### **解决方案:** ###

未解决之前在base工程的pom.xml中maven插件的配置如下:

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

解决base工程的pom.xml的maven配置如下:

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

### **原因分析:** ###

**spring-boot-maven-plugin打包出来的jar是不可依赖的**

我们现在整合后的maven项目有一个parent工程，打包类型为pom，下面多个spring-boot工程作为它的module，分别为base和moduleA,moduleB。假如moduleA依赖于base。如果你在base中使用了spring-boot-maven-plugin的默认配置build，或者在parent工程中使用spring-boot-maven-plugin的默认配置build。那么在clean package的时候会发现moduleA找不到base中的类。原因就是默认打包出来的jar是不可依赖的。

解决方案：

官方告诉我们，你如果不想移代码，好吧，我这样来给你解决，给你打两个jar包，一个用来直接执行，一个用来依赖。于是，你需要指定一个属性classifier，这个属性为可执行jar包的名字后缀。比如我设置<classifier>exec</classifier>，原项目名为Vehicle-business。那么会得到两个jar：Vehicle-business.jar和Vehicle-bussiness-exec.jar

官方文档位置：84.5 Use a Spring Boot application as a dependency

总结：回到聚合maven上，如果你在parent工程中使用了spring-boot-maven-plugin作为builder，那么你的依赖module一定要用解决方案二来设置。否则你不在parent工程中用spring-boot-maven-plugin作为builder，而在需要打包的module上使用。

一般parent工程的maven插件配置如下**:**

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                 <configuration>
              		<source>1.8</source>
              		<target>1.8</target>
            	</configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

被依赖的maven子模块的maven插件配置如下**(其余maven子模块就不需要配置):**

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

**其他的坑:**

**1.jdk8一定要指明**

不指明的话在开发工具里运行没有一点问题，如果你没有用到java8的特性打包也没有问题。一旦你用到了java8的特性，而且使用spring-boot-maven-plugin作为builder，一定要指明jdk版本。不然你会收到类似不识别Lambda，请使用resource8这样的错误。

**2.BOOT-INF陷阱**

这个问题就很恶心了。这个时候你已经打包成功，你会发现运行jar的时候报错为file not found，而且不告诉你是什么文件。你打开jar去看，发现需要的lib，配置文件，class一样也不缺。

其实这里要说一个概念，spring-boot在打包后，会把文件拷贝到BOOT-INF/Classes之下，这个时候你原来定义的扫描包路径将失效。而这个问题官方文档根本没讲，还是我没有看到。

这个陷阱在你使用packages定义扫描路径的时候等着你。或者获取工程下文件的时候。对于获取文件的话，可以在原路径前加上classes，当然你要区分开发环境或生产环境的话，你可以使用profile或者conditional来解决。如果是扫描包路径就恶心了，因为你加上classes之后，不报file not found了。而是不报错，只是警告你找不到hibernate的某些xml。但是你很可能根本没有使用hibernate。

参考博客：https://blog.csdn.net/guduyishuai/article/details/60968728

[http_blog.sina.com.cn_s_blog_cfee55a70102yvyd.html]: http://blog.sina.com.cn/s/blog_cfee55a70102yvyd.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o2OTE4Mzc4Nw_size_16_color_FFFFFF_t_70]: /images/20210527/1d9d59b6c07e4ccdb264a53a84eb33b2.png