如何编写一个通用的标准可复用的面向对象统一返回值Wrapper对象

小辰大大_4339

小辰大大_4339

2026-06-08

344人浏览

原创

wrapper 应为不可变结果载体,含 final 枚举 code、泛型 data、语义化静态工厂;分 baseresult、pageresult、validateresult 三层;支持 traceid、extra 扩展及 json 友好序列化。

如何编写一个通用的标准可复用的面向对象统一返回值wrapper对象

设计一个通用、标准、可复用的面向对象统一返回值 Wrapper 对象,核心是**解耦业务逻辑与响应结构**,同时兼顾**类型安全、可扩展性、序列化友好和团队协作一致性**。它不该只是简单套个 code/msg/data 三层壳,而应体现明确的契约意识和分层职责。

明确 Wrapper 的核心契约与不可变性

Wrapper 应代表一次请求的完整响应语义,不是数据容器,而是“结果载体”。因此:

  • 所有字段必须为 final,构造即完成,禁止 setter(避免状态污染和并发问题)
  • 提供全参构造器 + 静态工厂方法(如 success() / fail() / of()),强制使用语义化创建路径
  • code 应为枚举(如 ResultCode.SUCCESS、ResultCode.VALIDATE_ERROR),而非 magic number 或字符串,便于 IDE 提示、校验和国际化扩展
  • data 字段泛型化(T),支持任意业务实体,且保留原始类型信息(利于 Jackson/Gson 正确反序列化)

分层设计:基础 Wrapper + 业务场景子类(按需)

不强求“一个 Wrapper 打天下”。推荐分两级:

  • BaseResult:最简抽象,含 code、message、data、timestamp(可选)。作为所有返回值的顶层父类,供全局统一拦截器/过滤器识别
  • PageResult:继承 BaseResult>,额外封装 page、size、total、list 字段,专用于分页场景
  • ValidateResult:不带泛型,专用于参数校验失败,内含 List,比笼统的 msg 更利于前端精准提示

这样既保持主干简洁,又让特殊场景有清晰归属,避免 BaseResult 膨胀成“上帝对象”。

博查AI搜索
博查AI搜索

一款AI工具,主要用于博查是一个无广告干扰的答案引擎,国内首个多模型AI搜索引擎,适合需要提升相关任务效率的用户。

下载

深度集成 JSON 序列化与反序列化

Wrapper 必须对主流序列化框架(Jackson / Gson)透明友好:

  • 为 code 枚举添加 @JsonValue 注解,确保序列化输出为数字码(非枚举名)
  • 为 message 字段加 @JsonInclude(JsonInclude.Include.NON_EMPTY),空消息不输出,减小响应体积
  • 若用 Lombok,禁用 @Data(会生成 setter),改用 @Value + @Builder(仅 builder 模式支持不可变构建)
  • 在 Spring Boot 中,通过 @ControllerAdvice + ResponseEntity> 全局统一封装,避免每个 Controller 手动 new Wrapper

预留扩展点:上下文与元数据支持

生产级 Wrapper 需考虑诊断与灰度能力:

  • 增加 traceId(String) 字段,从 MDC 或网关透传,方便全链路日志追踪
  • 增加 extra(Map) 字段(标注 @JsonAnyGetter/@JsonAnySetter),允许临时注入调试信息、灰度标识、降级原因等,不影响主结构
  • 所有字段命名采用小驼峰(如 resultCode → code),与前端 JS 变量习惯一致,避免下划线转驼峰的序列化配置

不复杂但容易忽略

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

9677

6

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

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

2023.07.05

6822

9

java自学难吗
java自学难吗

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

2023.07.31

6032

8

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

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

2023.08.01

1044

3

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

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

2023.08.02

868

3

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

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

2023.08.02

1276

5

java有什么用
java有什么用

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

2023.08.02

2529

5

java在线网站
java在线网站

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

2023.08.03

19871

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1135

8

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习