讲师中心 微信公众号
AI工具推荐 视频效率加速

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

星萱大大_8719

星萱大大_8719

发布时间:2026-06-06 18:04:26

|

491人浏览过

|

来源于php中文网

原创

统一返回值Wrapper应包含code、message、data、timestamp(推荐)四个核心字段,采用泛型保证类型安全,提供success()、fail()等语义化静态工厂方法,并通过@ControllerAdvice自动包装响应与异常。

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

设计一个通用、标准、可复用的统一返回值 Wrapper,核心是**兼顾规范性、扩展性、易用性与前后端协作友好性**。它不该只为“包装成功/失败”,而应成为接口契约的载体。

明确 Wrapper 的核心字段(最小必要集)

避免过度设计,先定义不可缺失的语义化字段:

  • code:业务状态码(非 HTTP 状态码),如 200(成功)、400(参数错误)、500(服务异常)、401(未登录)等;建议使用整数,便于前端 switch 判断
  • message:面向用户或开发者的简明提示,非堆栈信息;生产环境不暴露敏感细节
  • data:泛型承载实际业务数据(可为 null、对象、列表、空对象等),类型安全靠泛型约束
  • timestamp(可选但推荐):响应时间毫秒戳,便于排查时序问题、客户端缓存控制

用泛型支持任意数据类型,拒绝 Object 或 Map

硬编码 data 为 Object 或 Map 会丢失类型信息,导致调用方频繁强转、IDE 无法提示、JSON 序列化异常。正确做法是声明泛型:

<font size="2">public class Result<T> {
    private int code;
    private String message;
    private T data;
    private long timestamp;

    // 构造方法、getter/setter、静态工厂方法(如 success(data)、fail(code, msg))
}</font>

这样 Controller 层可精准返回:Result<User>、Result<List<Order>>、Result<Void>(无数据时用 Void 或直接 null)

提供语义化静态构造方法,屏蔽 new 操作

禁止让业务代码手动 new Result(...),易出错且不统一。封装常用场景的静态工厂方法:

  • success(T data):code=200,message="OK",自动填充 timestamp
  • success():data=null,适用于纯行为接口(如删除、提交)
  • fail(int code, String message):通用失败构造
  • fail(BizCodeEnum enum):对接枚举状态码(推荐,集中管理 code/message)
  • of(int code, String message, T data):兜底方法,供特殊场景使用

与全局异常处理器和 WebMvc 集成

Wrapper 的价值在“自动生效”。配合 @ControllerAdvice + @ResponseBodyAdvice 可实现透明包装:

  • 所有 @RestController 返回值自动被 Result<T> 包裹(包括 void 方法返回 Result<Void>)
  • 全局捕获 Exception,根据类型/场景转换为对应 Result.fail(...) 并设置 HTTP 状态码(如 401 → 401,500 → 500)
  • 避免在每个 Controller 里手动调 success(),真正实现“业务代码只关注 data”

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

相关专题

更多
java
java

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

10757

2023.06.15

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

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

7882

2023.07.05

java自学难吗
java自学难吗

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

6852

2023.07.31

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

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

1164

2023.08.01

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

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

948

2023.08.02

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

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

1396

2023.08.02

java有什么用
java有什么用

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

2829

2023.08.02

java在线网站
java在线网站

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

20131

2023.08.03

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

60

2026.10.16

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn