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

基于泛型的响应体封装规范_如何设计通用的Result对象以支持各类业务变量输出

风婷姑娘_1262

风婷姑娘_1262

发布时间:2026-05-14 18:31:00

|

626人浏览过

|

来源于php中文网

原创

Result 仅含 code(自定义语义码)、message(纯文本提示)、data(泛型业务数据)三字段;提供泛型静态工厂方法 success/fail/empty 支持类型推导;Controller 统一返回 Result;异常由 @ExceptionHandler 全局转译,禁止手动封装。

基于泛型的响应体封装规范_如何设计通用的result对象以支持各类业务变量输出

设计一个基于泛型的通用 Result 对象,核心是让 code、message、data 三要素稳定可预期,同时确保泛型 T data 在各类业务场景下不破型、不报错、不丢失语义。关键不在“能封装”,而在“怎么封装才不踩坑”。

字段定义要精简且语义明确

只保留三个必选字段:int code(业务状态码)、String message(前端/日志可见提示)、T data(泛型业务数据)。避免堆砌 timestamp、extend、success 等冗余字段——它们要么可由网关补充,要么应交由具体业务子类扩展。code 不用 HTTP 状态码(如 200/404),而用自定义语义码(如 10000=成功,40001=参数缺失);message 必须是纯文本,禁止拼接异常堆栈或敏感路径。

泛型方法必须支持类型推导

静态工厂方法不能返回固定类型(如 Result),否则在声明 Result 的接口中调用 error() 会编译失败。正确写法是泛型静态方法:

  • public static Result success(T data)
  • public static Result fail(int code, String message)
  • public static Result empty() —— 显式表示 data 为 null 且合法

这样无论接口返回 Result 还是 Result>,所有分支路径都能自动适配 T 类型。

Controller 层强制统一返回类型

所有 @RestController 方法的返回值必须声明为 Result,禁用 void、Map、POJO 或 ResponseEntity 直接返回。好处有三:

  • 前端始终解析同一结构,无需 if-else 判别响应格式
  • Swagger 自动生成一致的 response schema
  • 后续接入 API 网关时,签名、脱敏、审计等增强逻辑可集中注入

若已有部分接口未改造,可通过 @RestControllerAdvice 的 beforeBodyWrite 拦截非 Result 返回值,自动包装为 Result.success(value),但需排除已返回 Result 或抛出异常的情况,保证两条通路互不干扰。

异常流转必须隔离且收敛

Result 类本身不处理异常,只负责承载结果。所有异常必须经由全局 @ExceptionHandler 统一捕获并转为标准 Result:

  • MethodArgumentNotValidException → Result.fail(400, 校验字段提示)
  • 自定义业务异常(如 InsufficientBalanceException)→ Result.fail(42001, "余额不足")
  • 兜底 Exception → 记录日志 + Result.fail(500, "系统繁忙,请稍后再试")

禁止在 service 或 controller 中手动 try-catch 后 new Result,否则 code 定义易混乱、message 易泄露细节、日志埋点难统一。

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

热门AI工具

更多
DeepSeek

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

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

豆包大模型

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

WorkBuddy

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

相关专题

更多
java
java

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

11957

2023.06.15

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

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

9042

2023.07.05

java自学难吗
java自学难吗

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

7752

2023.07.31

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

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

1264

2023.08.01

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

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

1008

2023.08.02

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

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

1516

2023.08.02

java有什么用
java有什么用

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

3129

2023.08.02

java在线网站
java在线网站

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

20371

2023.08.03

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

0

2026.11.05

热门下载

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

精品课程

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

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