在 Java 项目中，跨项目的代码共享是常见的需求。通常，跨项目代码共享的目标是使多个项目能够复用公共代码，而不需要重复开发。Java 提供了多种方法来实现代码共享，以下是常用的方法及其适用场景：
1. 通过共享 JAR 包

将公共的代码打包成 JAR 文件，然后在其他项目中使用该 JAR。这个方法适用于多个项目共享公共库的场景。
步骤：

创建公共库项目：
将公共代码提取到一个独立的 Java 项目中，例如 common-utils。

打包成 JAR：
使用构建工具（如 Maven 或 Gradle）将公共代码打包成一个 JAR 文件。

Maven 打包示例：

xml

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>3.1.0</version>
            <configuration>
                <archive>
                    <manifest>
                        <addClasspath>true</addClasspath>
                        <mainClass>com.example.Main</mainClass>
                    </manifest>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>

在项目的根目录运行以下命令：

bash

mvn clean package

在其他项目中使用 JAR：

将生成的 JAR 文件放置在其他项目的 libs 目录下，或者通过构建工具（如 Maven、Gradle）添加依赖。

Maven 引用 JAR 示例：

xml

    <dependency>
        <groupId>com.example</groupId>
        <artifactId>common-utils</artifactId>
        <version>1.0.0</version>
    </dependency>

2. 使用 Maven/Gradle 私有仓库

如果你有多个项目需要共享代码，并且使用 Maven 或 Gradle 管理依赖，可以将共享代码上传到 Maven 私有仓库（如 Nexus、Artifactory）中，然后在其他项目中通过 Maven 或 Gradle 引入这些库。
步骤：

发布共享代码到私有仓库：
在公共库项目的 pom.xml 或 build.gradle 中配置私有仓库的上传路径。

Maven 配置示例：

xml

<distributionManagement>
    <repository>
        <id>private-repo</id>
        <url>http://your-private-repo/repository/maven-releases/</url>
    </repository>
    <snapshotRepository>
        <id>private-repo-snapshots</id>
        <url>http://your-private-repo/repository/maven-snapshots/</url>
    </snapshotRepository>
</distributionManagement>

然后在项目根目录运行以下命令将 JAR 发布到私有仓库：

bash

mvn clean deploy

在其他项目中添加依赖：在其他项目中配置私有仓库地址，并添加依赖。

Maven 配置示例：

xml

    <repositories>
        <repository>
            <id>private-repo</id>
            <url>http://your-private-repo/repository/maven-releases/</url>
        </repository>
    </repositories>

    <dependency>
        <groupId>com.example</groupId>
        <artifactId>common-utils</artifactId>
        <version>1.0.0</version>
    </dependency>

3. Git 子模块 (Git Submodule)

使用 Git 子模块可以在多个项目共享同一个代码库。每个项目都可以将共享的代码库作为子模块嵌入项目中，并保持与原始库的同步。
步骤：

创建公共代码库：
将共享代码库作为一个独立的 Git 仓库进行管理。

在其他项目中添加子模块：在其他项目中，使用 Git 子模块命令将公共代码库添加到项目中：

bash

git submodule add https://github.com/yourusername/common-utils.git common-utils

这将把 common-utils 作为子模块添加到当前项目的 common-utils 目录下。

更新子模块：当公共代码库有更新时，你可以在项目中同步更新子模块：

bash

git submodule update --remote

优点：

子模块可以随着独立的公共代码库更新，适合多项目共享持续更新的代码库。

4. 使用 Git Monorepo（多项目单仓库）

Monorepo 是一种管理多个项目的仓库结构，它允许将多个项目和共享库放在一个仓库中进行管理。所有项目共享同一个代码库，可以通过版本控制系统协调更新。
步骤：

创建单一仓库：
在同一个 Git 仓库中创建多个项目，并通过不同的目录结构区分各项目。

bash

/monorepo
├── /projectA
├── /projectB
└── /common-utils

项目间依赖管理：

使用构建工具（如 Maven 或 Gradle）在项目之间管理依赖。例如，projectA 和 projectB 都可以依赖于 common-utils。

Maven 项目依赖管理示例：在父 pom.xml 中管理模块：

xml

    <modules>
        <module>projectA</module>
        <module>projectB</module>
        <module>common-utils</module>
    </modules>

独立构建与测试：
你可以独立构建和测试每个子项目，也可以整体构建整个仓库。

优点：

所有项目和共享代码库位于同一个版本控制系统中，方便统一管理和版本控制。

5. 使用 OSGi 模块化系统

OSGi 是一种动态模块化系统，它允许你将代码拆分为多个模块，并在运行时加载或卸载模块。它适用于复杂的应用程序，特别是需要在运行时动态加载共享库的场景。
示例：

创建 OSGi 模块：
创建一个 OSGi 捆绑包（bundle），包含公共代码。

在 OSGi 环境中运行：
在 OSGi 容器（如 Apache Felix 或 Equinox）中动态加载模块。

总结

    JAR 包共享：适合简单的公共库共享，易于使用和维护。
    Maven/Gradle 私有仓库：适合大规模项目共享，能灵活管理依赖版本。
    Git 子模块：适用于多个项目依赖同一个独立的代码库，适合版本控制和更新。
    Monorepo：适合多个紧密相关项目的管理，便于集中化管理和版本控制。
    OSGi 模块化系统：适用于需要动态模块加载的场景。

ITPub博客

ava进行跨项目的代码共享

最新文章