使用maven-assembly-plugin将 system 依赖范围的jar以class 方式打包进 jar包中网站首页 其他

使用maven-assembly-plugin将 system 依赖范围的jar以class 方式打包进 jar包中

java爱好者 2024-08-26 12:01:03

简介使用maven-assembly-plugin将 system 依赖范围的jar以class 方式打包进 jar包中

List item

背景描述

服务A 有本地系统依赖（scope = system）如果服务A作为普通服务使用没有任何问题，但如果将服务A 以jar 包方式提供给服务B使用，那么服务B在编译的时候就有可能报错，因为找不到服务A 依赖的本地Jar。

解决问题思路：将服务A依赖的本地Jar 以class 方式直接打包进输出jar包中，这样服务B在使用服务A时，就不会报找不到本地依赖的问题了；

那要将本地依赖jar 打包进输出jar 中需要使用到 maven-assembly-plugin 插件；

1、添加插件

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-assembly-plugin</artifactId>
    <version>3.6.0</version>
    <configuration>
        <appendAssemblyId>false</appendAssemblyId>
        <attach>false</attach>
        <descriptors>
            <descriptor>src/main/assembly/assembly.xml</descriptor>
        </descriptors>
    </configuration>
    <executions>
        <execution>
            <id>make-assembly</id>
            <phase>package</phase>
            <goals>
                <goal>single</goal>
            </goals>
        </execution>
    </executions>
</plugin>

这里使用 assembly.xml 配置文件方式配置打包详细

<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.1.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.1.0 https://maven.apache.org/xsd/assembly-2.1.0.xsd">
    <id>jar-with-dependencies</id>
    <formats>
        <format>jar</format>
    </formats>
    <includeBaseDirectory>false</includeBaseDirectory>
    <dependencySets>
        <dependencySet>
            <outputDirectory>/</outputDirectory>
            <useProjectArtifact>true</useProjectArtifact>
            <unpack>true</unpack>
            <scope>system</scope>
            <includes>
                <include>com.lop:CommonQueryOrderApi</include>
            </includes>
        </dependencySet>
        <dependencySet>
            <outputDirectory>/</outputDirectory>
            <useProjectArtifact>true</useProjectArtifact>
            <unpack>true</unpack>
            <scope>runtime</scope>
            <includes>
                <include>com.lop.open:lop-opensdk-support</include>
                <!-- 这个是本地项目，不知道为什么取消本项目就不能打进jar 包中 -->
                <include>com.aimlin.local:express</include>
            </includes>
        </dependencySet>
    </dependencySets>
</assembly>

2、本地依赖配置

   <dependency>
        <groupId>com.lop</groupId>
        <artifactId>CommonQueryOrderApi</artifactId>
        <version>${CommonQueryOrderApi.version}</version>
        <scope>system</scope>
        <systemPath>${basedir}/lib/CommonQueryOrderApi.jar</systemPath>
        <optional>true</optional>
    </dependency>

说明：
对于本地依赖添加 <scope>system</scope> 配置项，指定为本地依赖；另外还需要设置 <optional>true</optional> 防止依赖传递个服务B；

问题：

如果在编译过程出现

[WARNING] Artifact: com.xxx:xxx:jar:1.0.0 references the same file as the assembly destination file. Moving it to a temporary location for inclusion.

这个问题一般都是默认 maven 已经生成了jar ，这里使用maven-assembly-plugin ?将原来的jar替换了，就会提示该异常，解决方案：排除到默认编译器生成jar 即可

<!-- 排除默认jar生成器 -->
 <plugin>
     <groupId>org.apache.maven.plugins</groupId>
     <artifactId>maven-jar-plugin</artifactId>
     <executions>
         <execution>
             <id>default-jar</id>
             <phase>none</phase>
         </execution>
     </executions>
 </plugin>

[WARNING] Configuration option 'appendAssemblyId' is set to false.
Instead of attaching the assembly file: /Users/xxx.jar, it will become the file for main project artifact.
NOTE: If multiple descriptors or descriptor-formats are provided for this project, the value of this file will be non-deterministic!
[WARNING] Replacing pre-existing project main-artifact file: /Users/xxx/target/classes
with assembly file: /Users/xxx.jar

出现这种告警，一般都是appendAssemblyId 设置为false ，并且 <attach>true</attach> 导致的，只需要设置附加为false即可取消告警，同时打包方式应该指定为：single

 <executions>
     <execution>
         <id>make-assembly</id>
         <phase>package</phase>
         <goals>
             <goal>single</goal>
         </goals>
     </execution>
 </executions>