Maven项目间共享实体类或公共代码的最佳实践-java教程-PHP中文网

Maven项目间共享实体类或公共代码的最佳实践

碧海醫心

发布： 2025-11-02 14:26:48

原创

628人浏览过

Maven项目间共享实体类或公共代码的最佳实践

本教程详细阐述了如何在maven多项目环境中高效共享实体类或公共代码。核心方法是采用maven模块化，将共享代码封装成独立模块，并通过maven依赖机制在其他项目中引入。文章将涵盖多模块项目结构、构建发布流程以及依赖管理，旨在提供一个结构清晰、易于维护的解决方案，避免代码冗余并提升开发效率。

引言在复杂的软件开发项目中，代码复用是提高效率和保持一致性的关键。特别是在微服务架构或大型单体应用拆分过程中，多个Maven项目可能需要共享同一套实体类、工具类或数据模型。直接复制粘贴代码不仅效率低下，还会导致维护困难和版本不一致。本文将介绍一种Maven的最佳实践，通过模块化来优雅地解决跨项目代码共享的问题。

核心策略：Maven模块化 Maven的模块化（Multi-Module Project）机制是解决项目间代码共享问题的最佳途径。它允许我们将一个大型项目分解为多个相互关联的子模块，每个子模块都可以独立构建，但由一个父POM文件统一管理。

1. 构建多模块项目结构

首先，我们需要将共享的实体类从现有项目（例如 project_a）中剥离出来，创建一个独立的Maven模块。

假设原始项目结构如下：

project_a/
├─ src/
│  ├─ main/
│  │  ├─ java/
│  │  │  ├─ com/
│  │  │  │  ├─ myproject/
│  │  │  │  │  ├─ model/  <-- 这些是需要共享的实体类
│  │  │  │  │  ├─ Application.java
├─ pom.xml

登录后复制

现在，我们创建一个新的父项目，并将 project_a 和新的 model-entities 模块作为其子模块。

新的项目结构示例：

my-parent-project/
├─ project_a/
│  ├─ ...
│  ├─ pom.xml
├─ model-entities/  <-- 新增的共享实体模块
│  ├─ src/
│  │  ├─ main/
│  │  │  ├─ java/
│  │  │  │  ├─ com/
│  │  │  │  │  ├─ myproject/
│  │  │  │  │  ├─ model/  <-- 原始project_a中的实体类将迁移到这里
│  ├─ pom.xml
├─ project_b/       <-- 需要使用实体类的另一个项目
│  ├─ ...
│  ├─ pom.xml
├─ pom.xml           <-- 父项目的pom.xml

登录后复制

my-parent-project 的 pom.xml (父项目)：

<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.myproject</groupId>
    <artifactId>my-parent-project</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <packaging>pom</packaging> <!-- 父项目通常是pom类型 -->

    <modules>
        <module>model-entities</module>
        <module>project_a</module>
        <module>project_b</module>
    </modules>

    <!-- 可以在这里定义公共依赖、插件管理、属性等 -->
    <properties>
        <java.version>17</java.version>
        <spring.boot.version>3.2.0</spring.boot.version>
        <!-- 其他公共属性 -->
    </properties>

    <dependencyManagement>
        <dependencies>
            <!-- 统一管理Spring Boot版本 -->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring.boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- 其他公共依赖的版本管理 -->
        </dependencies>
    </dependencyManagement>

</project>

登录后复制

model-entities 模块的 pom.xml：

<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>

    <parent>
        <groupId>com.myproject</groupId>
        <artifactId>my-parent-project</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>

    <artifactId>model-entities</artifactId>
    <packaging>jar</packaging> <!-- 实体模块通常打包成JAR -->

    <!-- 如果实体类依赖于其他库，例如JPA注解，在这里添加 -->
    <dependencies>
        <dependency>
            <groupId>jakarta.persistence</groupId>
            <artifactId>jakarta.persistence-api</artifactId>
            <!-- 版本由父POM的dependencyManagement统一管理 -->
        </dependency>
        <!-- 其他必要的依赖 -->
    </dependencies>

</project>

登录后复制

2. 构建与发布共享模块

当 model-entities 模块创建并包含了所有共享实体类后，需要对其进行构建，以便其他项目能够引用。

ViiTor实时翻译

AI实时多语言翻译专家！强大的语音识别、AR翻译功能。

116

查看详情

本地开发环境： 在父项目 my-parent-project 的根目录下执行 mvn clean install 命令。Maven 会依次构建所有子模块，并将 model-entities 模块生成的 JAR 文件安装到本地的 Maven 仓库（通常位于 ~/.m2/repository 目录下）。这样，本地其他项目就能立即引用这个 JAR 包。
团队协作与持续集成： 对于团队开发或持续集成环境，推荐使用远程 Maven 仓库管理器，如 Artifactory、Nexus 或 GitHub Packages。
1. 配置 Maven 将 model-entities 模块发布到远程仓库。这通常涉及在 pom.xml 中配置 <distributionManagement> 和在 settings.xml 中配置认证信息。
2. 执行 mvn clean deploy 命令。这会将 JAR 文件发布到远程仓库，供所有开发人员和CI/CD流水线使用。

3. 在其他项目中使用共享模块

一旦 model-entities 模块被构建并发布（无论是到本地仓库还是远程仓库），其他需要使用这些实体类的项目（如 project_a 和 project_b）就可以像引用任何第三方库一样，将其作为依赖引入。

project_b 的 pom.xml (或 project_a 的 pom.xml)：

<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>

    <parent>
        <groupId>com.myproject</groupId>
        <artifactId>my-parent-project</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>

    <artifactId>project_b</artifactId>
    <packaging>jar</packaging> <!-- 或war等 -->

    <dependencies>
        <!-- 引入共享的实体模块 -->
        <dependency>
            <groupId>com.myproject</groupId>
            <artifactId>model-entities</artifactId>
            <!-- 版本号应与父项目和model-entities模块的版本保持一致 -->
            <!-- 如果在同一个多模块项目中，通常可以省略version，由父POM统一管理 -->
        </dependency>

        <!-- project_b 自身的其他依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- ... -->
    </dependencies>

</project>

登录后复制

注意事项

版本管理： 确保共享模块的版本号（version）与父项目以及引用它的项目保持一致。在多模块项目中，通常建议使用父POM中定义的版本。SNAPSHOT 版本在开发阶段非常有用，表示该版本仍在开发中，每次 install 或 deploy 都会更新。
依赖冲突： 当多个项目依赖同一个共享模块时，要警惕潜在的依赖冲突。Maven的依赖调解机制会尝试解决冲突，但有时仍需手动排除或统一版本。父POM的 dependencyManagement 可以有效管理所有子模块的依赖版本，避免冲突。
命名规范： 为共享模块选择一个清晰、描述性的 artifactId，例如 common-utils、domain-models 或 shared-api，以便于识别其用途。
避免循环依赖： 确保模块之间没有循环依赖，即模块A依赖模块B，同时模块B又依赖模块A。这会导致构建失败。
直接导入包的后果： 问题中提到是否可以直接导入 com.myproject.model 包。这在Maven体系中是不可能直接实现的，因为Maven是基于模块（JARs）进行依赖管理的，而不是基于包。尝试直接引用一个未打包为JAR的包会违反Maven的构建原则，并导致编译错误。唯一的“直接导入”方式就是将包含该包的JAR作为依赖引入，而这正是模块化方案所实现的目标。