Java项目使用自定义的公共单元(Maven管理)

最新推荐文章于 2024-06-27 10:42:31 发布

若苗瞬

最新推荐文章于 2024-06-27 10:42:31 发布

阅读量461

点赞数

分类专栏： JAVA 文章标签： java maven 公共单元 assembly.xml

本文链接：https://blog.youkuaiyun.com/ddrfan/article/details/126585348

版权

JAVA 专栏收录该内容

34 篇文章

订阅专栏

本文介绍如何将Java项目中的公共单元独立出来制作成Jar包，并详细解释如何在其他项目中通过手动管理依赖的方式引入该Jar包。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

（一）前言

我们用C++，Pascal语言的时候不存在这个问题。
如果需要引用公用的单元，只需要include/uses一下，并不需要在意公共单元的代码在哪里。

而Java项目，要求代码必须在项目内部。
导致公共单元代码被拷贝到每个类似项目的目录下。

难以统一维护，同时也生成了大量的重复代码。

所以需要：

将公共单元作为一个单独的项目，打成jar包。
其它项目用依赖的方式引入这个jar包。

（二）制作公共单元（Jar）

这步比较简单，可以从一个可执行的项目开始修改。
仅需保留公共单元代码，去掉主类的代码和打包配置。
pom.xml 例子如下:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>my.pub.utils</groupId>

    <artifactId>my-public-utils</artifactId>
    <name>我的公共单元</name>
    <version>1.0.1</version>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>...公共依赖1...</dependency>
        <dependency>...公共依赖2...</dependency>
    </dependencies>

    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <version>3.3.0</version>
                <configuration>
                    <delimiters>@</delimiters>
                    <useDefaultDelimiters>false</useDefaultDelimiters>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.10.1</version>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

用Maven打包后，
生成了文件：my-public-utils-1.0.1.jar
放置在：PublicJava 目录中。

（三）项目使用自定义的公共单元

现在需要将上面章节生成的jar包加入到其它项目的依赖中。

简单办法，可以将公共单元包加入到Maven的本地仓库中。
或者某些情况下，我们需要 😄手动管理这个公共单元的依赖：

（3.1）手动管理自定义依赖项目

PS：这个例子没有用到Spring Boot之类的框架。

需要将下面的内容加入到pom.xml中<dependencies>段。

        <dependency>
            <groupId>my.pub.utils</groupId>
            <artifactId>my-public-utils</artifactId>
            <version>1.0.1</version>
            <scope>system</scope>
            <systemPath>/path/my-public-utils-1.0.1.jar</systemPath>
        </dependency>

（3.2）修改maven-assembly-plugin

还需要修改pom.xml中的maven-assembly-plugin部分：

在<plugin>中先找到：
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>

在同级层次中注释掉：

                <configuration>
                	......
                    <!--<descriptorRefs>-->
                    <!--    <descriptorRef>jar-with-dependencies</descriptorRef>-->
                    <!--</descriptorRefs>-->
                </configuration>

再加入assembly.xml配置：

                <executions>
                    <execution>
                    	......
                        <configuration>
                            <!-- assembly.xml文件路径 -->
                            <descriptors>
                                <descriptor>src/assembly/assembly.xml</descriptor>
                            </descriptors>
                        </configuration>
                    </execution>
                </executions>

（3.2）添加assembly.xml文件

在：项目/src/assembly/目录下添加assembly.xml文件，
内容如下：

<assembly>
    <id>jar-with-dependencies</id>
    <formats>
        <format>jar</format>
    </formats>
    <includeBaseDirectory>false</includeBaseDirectory>
    <dependencySets>
        <!-- 默认的配置 -->
        <dependencySet>
            <outputDirectory>/</outputDirectory>
            <useProjectArtifact>true</useProjectArtifact>
            <unpack>true</unpack>
            <scope>runtime</scope>
        </dependencySet>
        <!-- 增加scope类型为system的配置 -->
        <dependencySet>
            <outputDirectory>/</outputDirectory>
            <useProjectArtifact>true</useProjectArtifact>
            <unpack>true</unpack>
            <scope>system</scope>
        </dependencySet>
    </dependencySets>
</assembly>

（3.4）整体结构和例子

整个项目的结构类似：
在这里插入图片描述

完整的pom.xml例子如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.ac</groupId>

    <name>我的程序名称</name>
    <artifactId>myid</artifactId>
    <version>3.39.09</version>

    <dependencies>
        <!--common utils-->
        <dependency>
            <groupId>my.pub.utils</groupId>
            <artifactId>my-public-utils</artifactId>
            <version>1.0.1</version>
            <scope>system</scope>
            <!-- 是的这里用了相对路径，且路径在项目外 -->
            <systemPath>${pom.basedir}/../../../PublicJava/my-public-utils-1.0.1.jar</systemPath>
        </dependency>

        <dependency>...我的依赖1...</dependency>
		<dependency>...我的依赖2...</dependency>

        <!-- https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-api -->
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-api</artifactId>
            <version>5.9.0</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <version>3.3.0</version>
                <configuration>
                    <delimiters>@</delimiters>
                    <useDefaultDelimiters>false</useDefaultDelimiters>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.10.1</version>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.2.2</version>
                <configuration>
                    <archive>
                        <manifest>
                            <mainClass>com.ac.ClassName</mainClass>
                        </manifest>
                    </archive>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>3.4.2</version>
                <configuration>
                    <archive>
                        <manifest>
                            <mainClass>com.ac.ClassName</mainClass>
                        </manifest>
                        <manifestEntries>
                            <Class-Path>.</Class-Path>
                        </manifestEntries>
                    </archive>
                    <!--<descriptorRefs>-->
                    <!--    <descriptorRef>jar-with-dependencies</descriptorRef>-->
                    <!--</descriptorRefs>-->
                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                        <configuration>
                            <!-- assembly.xml文件路径 -->
                            <descriptors>
                                <descriptor>src/assembly/assembly.xml</descriptor>
                            </descriptors>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>