0

0

如何避免微服务间重复的 POJO 定义

碧海醫心

碧海醫心

发布时间:2026-01-09 18:36:02

|

272人浏览过

|

来源于php中文网

原创

如何避免微服务间重复的 POJO 定义

在多服务 spring web 应用中,不同服务因 rest 交互而各自维护相同结构的 pojo,易引发同步维护难题;本文阐述为何共享数据模块并非最优解,并推荐基于接口契约、版本化和上下文隔离的可持续演进方案。

当多个 Spring Boot(或传统 Spring)服务通过 REST 相互调用时,常见现象是:/users 服务定义 UserData,/emails 服务为解析其响应又定义了结构完全一致的 UserData。表面看这是代码重复,但强行“去重”——例如抽取为独立 shared-data-objects 模块并让各服务依赖它——实则埋下严重架构隐患。

❌ 共享 POJO 模块的危害远超重复代码



    com.myapp
    shared-data-objects
    1.2.0 
  • 破坏服务自治性:一旦 shared-data-objects 发布新版本(如新增 @NotNull 校验或重命名 firstName → givenName),所有依赖它的服务必须同步编译、测试、发布——哪怕只有 /users 服务实际需要该变更。
  • 模糊边界契约:REST 的本质是松耦合的 HTTP+JSON 协议交互,而共享类库将序列化细节(如 Jackson 注解、Lombok 行为、字段顺序)硬编码进二进制依赖,使服务间契约从“语义契约”退化为“实现契约”。
  • 阻碍独立演进:未来 /emails 服务可能只需 User.id 和 User.email,而 /billing 服务需完整用户档案。若共用 POJO,则任一服务的精简或扩展需求都会波及他人。

✅ 正确实践:以 Bounded Context 为指导,拥抱“合理重复”

Martin Fowler 提出的 Bounded Context(限界上下文) 是解题关键:每个服务代表一个独立业务域,其数据模型应由该域的语义驱动,而非技术便利性驱动。

1. 各服务自主定义 DTO,严格遵循接口契约

  • /users 服务在 OpenAPI(Swagger)中明确定义 GET /users/{id} 的响应 Schema:
    components:
      schemas:
        UserData:
          type: object
          properties:
            id: { type: integer }
            fullName: { type: string }
            email: { type: string }
  • /emails 服务不引用任何外部类,而是基于此契约生成自己的 EmailServiceUserDto:
    public class EmailServiceUserDto {
        private Long id;
        private String fullName; // 注意:此处字段名与 users 服务保持一致,但属于本服务的独立定义
        private String email;
        // 构造函数、Jackson 注解、校验逻辑均由本服务控制
    }

2. 使用契约优先工具自动化同步(非代码共享)

借助 OpenAPI Generator,在 CI 流程中自动生成各服务所需的客户端 DTO:

Runwayml(AI painting)
Runwayml(AI painting)

Runway 平台的文本生成图像AI工具

下载
# 在 emails 服务构建阶段执行(无需人工维护)
openapi-generator generate \
  -i https://users-service/api-docs.json \
  -g java \
  --model-name-suffix Dto \
  -o src/main/java/com/myapp/emails/dto/generated/

→ 生成的是 EmailsUserDto,而非 SharedUserDto,所有权仍归属 /emails 服务。

3. 为变更建立显式版本化策略

当 /users 服务需新增字段 timezone:

  • v1 接口保留:GET /users/{id} 维持原 JSON 结构(向后兼容)
  • 发布 v2 接口:GET /users/v2/{id} 返回含 timezone 的新 Schema
  • /emails 服务按需在后续迭代中升级到 v2,并生成新的 EmailsUserV2Dto —— 无强制升级,无跨服务阻塞。

总结:重复是表象,契约才是核心

不要为消除“看起来一样”的 POJO 而牺牲服务独立性。真正的 DRY(Don’t Repeat Yourself)原则在此场景下应解读为:Don’t Repeat Your Contracts —— 通过统一的 OpenAPI 规范、自动化代码生成和语义化版本控制,确保各服务对同一业务概念的理解一致,而非让它们共享同一段 Java 字节码。让每个服务成为自己数据模型的权威,才是微服务架构可持续演进的基石。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

829

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

735

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

733

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

396

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

398

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16925

2023.08.03

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

3

2026.01.09

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.4万人学习

C# 教程
C# 教程

共94课时 | 6.4万人学习

Java 教程
Java 教程

共578课时 | 44.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号