泛型类与泛型方法:如何编写一个通用的标准可复用的统一返回值Wrapper

星明酱_5630

星明酱_5630

2026-06-24

405人浏览

原创

使用泛型result类及配套静态工厂方法可统一接口返回结构:含code、message、泛型data和timestamp,支持自动类型推断与分层扩展(如pageresult),结合responsebodyadvice实现零侵入式自动包装。

泛型类与泛型方法:如何编写一个通用的标准可复用的统一返回值wrapper

直接用泛型类定义 Result<t></t>,再配一套泛型静态方法,就能让所有接口返回值自动带状态码、提示和类型安全的数据体,不用为每个业务对象写单独的结果类。

泛型类是骨架:定义 Result 的不可变结构

Wrapper 的核心是一个参数化类,T 代表任意业务数据类型,比如 User、List<order></order>、Void。字段全部声明为 final,确保构造即完成、线程安全、语义清晰:

  • private final int code; —— 业务状态码(非 HTTP 状态码),整数便于前端 switch 判断
  • private final String message; —— 用户或开发者可见的提示,空时可忽略输出
  • private final T data; —— 泛型承载真实数据,支持 null、对象、集合、甚至 void
  • private final long timestamp; —— 推荐带上,毫秒级时间戳,利于排障与缓存控制

不提供 public setter,禁用 @Data;推荐用 @Value + 全参构造器,或搭配 @Builder 支持分步构建。

泛型方法是灵魂:让 success/fail 自动适配调用处类型

静态工厂方法必须是泛型的,否则会掉进 Result<object></object> 和 Result<user></user> 类型不兼容的坑:

  • public static <t> Result<t> success(T data)</t></t> → code=200, message="OK"
  • public static <t> Result<t> success()</t></t> → data=null,适合删除、提交等无返回体操作
  • public static <t> Result<t> fail(int code, String message)</t></t> → data=null
  • public static <t> Result<t> fail(ResultCodeEnum enum)</t></t> → 从枚举取 code/message,集中管理、支持国际化
  • public static <t> Result<t> of(int code, String message, T data)</t></t> → 兜底全参方法

这样写接口时完全自然:
return Result.success(user); → 推断为 Result<user></user>
return Result.fail(404, "用户不存在"); → 推断为 Result<user></user>(data 为 null,但类型一致)

Gaga
Gaga

一款AI视频创作工具,主要用于曹越团队开发的AI视频生成工具,适合需要提升相关任务效率的用户。

下载

分层扩展不臃肿:BaseResult + 场景子类

一个 Wrapper 打天下容易失控。推荐分两级设计:

  • BaseResult<t></t>:最简抽象,含 code/message/data/timestamp,作为所有响应的顶层父类
  • PageResult<t></t>:继承 BaseResult<list>></list>,额外封装 total、pageNo、pageSize、list 字段,专用于分页
  • ValidateResult:不带泛型,内含 List<fielderror></fielderror>,比单条 message 更利于前端表单精准标红

Controller 可按需返回:
Result<user></user>、Result<pageresult>></pageresult>、ValidateResult,各司其职,不污染主干。

自动包装靠 Spring:@ResponseBodyAdvice 是关键粘合剂

真正实现“写啥返回啥”,靠的是 Spring 的响应体增强机制:

  • 实现 ResponseBodyAdvice<object></object>,重写 supports() 跳过已返回 Result 子类的接口(防套娃)
  • 在 beforeBodyWrite() 中判断原返回值:
     ✓ 是 null 或 void → 包装成 Result.success()
     ✓ 是普通对象(如 User、List)→ 包装成 Result.success(data)
     ✓ 是 Result 子类 → 直接放行
  • 配合 @ControllerAdvice 拦截异常:捕获 BizException 并转为 Result.fail(ex.getCode(), ex.getMsg()),系统异常兜底为 500

从此 Controller 方法只管业务逻辑,不再手动 new Result,也不拼 map 或 json。

相关文章

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

9977

6

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

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

2023.07.05

7122

9

java自学难吗
java自学难吗

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

2023.07.31

6272

8

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

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

2023.08.01

1084

3

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

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

2023.08.02

908

3

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

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

2023.08.02

1316

5

java有什么用
java有什么用

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

2023.08.02

2629

5

java在线网站
java在线网站

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

2023.08.03

19951

3

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

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

2023.08.03

1175

8

热门下载

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

精品课程

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

共6课时 | 54.6万人学习

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

共89课时 | 133.4万人学习