Spring Boot中如何在微服务间共享通用代码

1. 创建独立的通用库模块 #

• 用Maven/Gradle新建一个独立模块（或项目），可以基于spring-boot-starter-parent作为父依赖，复用Spring Boot的依赖管理能力；如果只是纯Java通用类，也可以不用Spring Boot依赖，做普通Java库。
• 把常量、自定义异常、DTO等通用代码按包结构分类存放，比如com.example.common.constants、com.example.common.exceptions、com.example.common.dto，不需要添加Spring Boot启动类。
• 按需引入必要依赖，比如lombok简化代码、jackson-databind支持DTO序列化，避免引入不必要的业务依赖。

示例Maven通用库核心配置：

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>3.2.0</version>
    <relativePath/>
</parent>

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

<dependencies>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <!-- 如需Spring基础支持，可添加 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <scope>provided</scope>
    </dependency>
</dependencies>

2. 打包发布通用库 #

• 本地开发时，执行mvn clean install将库安装到本地Maven仓库，方便本地微服务直接引用。
• 团队协作场景下，发布到私有仓库（如Nexus、Artifactory），确保所有服务能拉取到统一版本的通用库。

3. 在微服务中引入通用库 #

• 在每个微服务的依赖配置文件中添加通用库依赖：

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

• 直接在微服务代码中导入通用类使用即可，无需重复编写相同代码。

关键注意事项 #

• 异常处理：通用库仅定义异常类，全局异常处理器建议放在各微服务（或单独的starter模块）中，避免通用库依赖Web组件造成耦合。
• 版本管理：建议用多模块项目统一管理所有微服务和通用库的版本，避免版本冲突。
• 边界控制：通用库只存放真正跨服务复用的代码，不要包含业务逻辑，防止演变成耦合严重的“大泥球”。

内容的提问来源于stack exchange，提问作者Akheel Pasha