0

0

在Java中开发通用返回结果封装类_Java接口响应设计实践

P粉602998670

P粉602998670

发布时间:2025-12-18 17:41:02

|

385人浏览过

|

来源于php中文网

原创

统一响应封装需包含code、message、data三部分,支持泛型与静态工厂方法;区分http状态与业务code;保障空值安全并提供issuccess()判断。

在java中开发通用返回结果封装类_java接口响应设计实践

在Java后端开发中,统一的响应结果封装是接口设计的基本规范。它能屏蔽底层异常细节、标准化状态码、简化前端解析逻辑,并提升团队协作效率。

定义通用返回结构体

一个典型的通用返回类应包含状态码、消息、数据三部分,支持泛型以适配不同业务实体:

  • 使用int code表示HTTP或自定义业务状态(如200成功、500系统错误、400参数异常)
  • String message提供可读提示,避免直接暴露堆或敏感信息
  • T data为泛型字段,兼容对象、列表、空值等任意类型返回
  • 提供静态工厂方法(如success()fail(int, String))快速构造实例

区分HTTP状态与业务状态

不要将Spring MVC的HTTP状态码(如HttpStatus.OK)直接映射为业务code。建议分层处理:

  • Controller层统一返回ResponseEntity>,由全局异常处理器决定HTTP状态
  • Result内部code专注业务语义:10000表示“操作成功”,10001表示“用户不存在”,20001表示“库存不足”
  • 前端通过code判断业务分支,通过HTTP状态识别网络或服务级问题(如503 Service Unavailable)

支持空值安全与链式构建

避免data字段为null导致前端JSON解析异常或NPE风险:

一览妙笔
一览妙笔

自媒体、编剧、营销人员写作工具

下载

立即学习Java免费学习笔记(深入)”;

  • 默认data初始化为null,但提供of(T data)empty()明确语义
  • 添加isSuccess()便捷方法,基于code范围判断(如code >= 10000 && code
  • 构造器私有,强制通过静态方法创建,便于未来扩展日志埋点或审计字段

配合全局异常处理器统一兜底

Result类本身不处理异常,需搭配@ControllerAdvice实现自动封装:

  • 捕获RuntimeException,返回Result.fail(500, "系统繁忙")
  • IllegalArgumentException等参数异常,转为Result.fail(400, e.getMessage())
  • 避免在每个Controller里手动try-catch,保持业务代码干净

不复杂但容易忽略。关键是把code定义清楚、data保持类型安全、异常流转不泄露细节。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

142

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

81

2026.01.26

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

442

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

544

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

322

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

81

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

750

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

244

2023.09.22

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

462

2026.02.13

热门下载

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

精品课程

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

共23课时 | 3.7万人学习

C# 教程
C# 教程

共94课时 | 9.7万人学习

Java 教程
Java 教程

共578课时 | 67.4万人学习

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

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