如何优雅地处理返回值

news/2024/11/15 4:25:02/文章来源:https://www.cnblogs.com/seven97-top/p/18417444

我们已经知道了如何优雅的校验传入的参数了，那么后端服务器如何实现把数据返回给前端呢？

返回格式

后端返回给前端我们一般用 JSON 体方式，定义如下：

{#返回状态码code:string,       #返回信息描述message:string,#返回值data:object
}

CODE 状态码

Code 返回状态码，一般是在开发的时候需要什么，就添加什么。

如接口要返回用户权限异常，我们加一个状态码为 101 吧，下一次又要加一个数据参数异常，就加一个 102 的状态码。这样虽然能够照常满足业务，但状态码太凌乱了。

这里可以参考 阿里巴巴开发手册 中前后端规约 以及 异常日志中的内容

U表示用户，后面4位数字编号为
#U1000～U1999 区间表示用户参数相关
#U2000～U2999 区间表示用户相关接口异常
...

这样前端开发人员在得到返回值后，根据状态码就可以知道，大概什么错误，再根据 Message 相关的信息描述，可以快速定位。

Message

这个字段相对理解比较简单，就是发生错误时，如何友好的进行提示。一般的设计是和 Code 状态码一起设计，如：

@Data
public class Result {private String retCode;private String retMsg;//默认成功状态码public static final String SUCCESSCODE = "S0000";public static final String SUCCESSMSG = "成功";//默认失败状态码public static final String ERROR_CODE = "E2222";public static final String ERROR_MSG = "失败";public static final String COMMENT_CODE = "E3333";public static final String RUNNING_ERROR_MSG = "运行出错，请联系管理员";private Result() {this(SUCCESSCODE, SUCCESSMSG);}
}

再在枚举中定义，状态码：

@Getter
public enum UserResultConstants implements ResultConstats{NOT_ID("U1001","未正确输入用户id"),ADD_FAIL("U1002","新增用户失败"),UPDATE_FAIL("U1003","更新用户失败"),DELETE_FAIL("U1004","删除用户失败"),USERNAME_EXIST("U1005","用户名已存在"),USER_NOT_EXIST("U1006","用户不存在");private String code;private String message;private UserResultConstants(String code, String message){this.code = code;this.message = message;}}

状态码和信息就会一一对应，比较好维护。

Data

返回数据体，JSON 格式，根据不同的业务又不同的 JSON 体。

我们要设计一个返回体类 Result：

@Data
public class Result {private String retCode;private String retMsg;private Object data;public static final String SUCCESSCODE = "0000";public static final String SUCCESSMSG = "成功";public static final String ERROR_CODE = "2222";public static final String ERROR_MSG = "失败";public static final String COMMENT_CODE = "3333";public static final String RUNNING_ERROR_MSG = "运行出错，请联系管理员";public Result() {this(SUCCESSCODE, SUCCESSMSG, null);}public Result(Object data) {this(SUCCESSCODE, SUCCESSMSG, data);}public Result(String retCode, String retMsg, Object data) {this.retCode = retCode;this.retMsg = retMsg;this.data = data;}public Result(String retCode, String retMsg) {this(retCode, retMsg, null);}
}

控制层 Controller

我们会在 Controller 层处理业务请求，并返回给前端，以 用户管理 为例：

@RestController
@RequestMapping("/user")
@Slf4j
@Validated
@RequiredArgsConstructor
public class UserController {private final UserService userService;/*** 查询所有用户信息** @return 返回所有用户信息*/@GetMapping(value = "/list")public Result userList() {List<UserVo> users = userService.selectUserList();Result result = new Result(users);log.info("userList查询的用户信息为:{}", JsonMapper.toJson(users));return result;}
}

我们看到在获得 users 对象之后，我们是用的 Result 构造方法进行包装赋值，然后进行返回。而@RestController注解是@Controller和@ResponseBody的合集，表示这是个控制器 bean,并且是将函数的返回值直接填入 HTTP 响应体中，是 REST 风格的控制器，更加适合目前前后端分离的架构下，返回 JSON 数据格式。

有没有发现，构造方法这样的包装是不是很麻烦，可以优化一下。

美观优化

我们可以在 Result 类中，加入静态方法，一看就懂：

@Data
public class Result {//...public static Result ok() {return new Result();}public static Result ok(Object data) {return new Result(data);}public static Result ok(String retCode, String retMsg) {return new Result(retCode, retMsg);}public static Result error(String retCode, String retMsg) {return new Result(retCode, retMsg);}}

再改造一下 Controller：

@RestController
@RequestMapping("/user")
@Slf4j
@Validated
@RequiredArgsConstructor
public class UserController {private final UserService userService;/*** 查询所有用户信息** @return 返回所有用户信息*/@GetMapping(value = "/list")public Result userList() {List<UserVo> users = userService.selectUserList();log.info("userList查询的用户信息为:{}", JsonMapper.toJson(users));return Result.ok(users);}
}

代码是不是比较简洁了，也美观了。

优雅优化

上面我们看到在 Result 类中增加了静态方法，使得业务处理代码简洁了。

但大家有没有发现这样有几个问题：

  • 每个方法的返回都是 Result 封装对象，没有业务含义。
  • 在业务代码中，成功的时候我们调用 Result.success，异常错误调用 Result.error。是不是很多余。

我们最好的方式直接返回真实业务对象，最好不要改变之前的业务方式，如下：

@RestController
@RequestMapping("/user")
@Slf4j
@Validated
@RequiredArgsConstructor
public class UserController {private final UserService userService;/*** 查询所有用户信息** @return 返回所有用户信息*/@GetMapping(value = "/list")public List<UserVo> userList() {List<UserVo> users = userService.selectUserList();log.info("userList查询的用户信息为:{}", JsonMapper.toJson(users));return users;}
}

这个和我们平时的代码是一样的，非常直观，直接返回 user 对象，这样是不是很完美。

那实现方案是什么呢？

返回值优雅方案实现

要优化这段代码很简单，只需要借助SpringBoot提供的ResponseBodyAdvice即可。

ResponseBodyAdvice的作用：拦截Controller方法的返回值，统一处理返回值/响应体，一般用来统一返回格式，加解密，签名等等。

重写返回体

@RestControllerAdvice
@RequiredArgsConstructor
public class ResponseAdvice implements ResponseBodyAdvice<Object> {private final ObjectMapper objectMapper;@Overridepublic boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {return true;}@SneakyThrows@Overridepublic Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {//如果Controller直接返回String的话，SpringBoot是直接返回，故我们需要手动转换成json。if (body instanceof String) {return objectMapper.writeValueAsString(Result.ok(body));}//如果已经封装成Result了，则不需要再次封装，否则就会导致出现多层if (body instanceof Result) {return body;}return Result.ok(body);}
}

上面代码就是判断是否需要返回值包装，如果需要就直接包装。这里我们只处理了正常成功的包装，如果方法体报异常怎么办？

异常问题处理

此时有个问题，由于没对异常进行处理，当调用的方法一旦出现异常，就会出现问题，此时就可以写全局异常，来通过全局异常返回同一格式的Result。

  • 定义异常类
public class UserException extends RuntimeException {public UserException(String message) {super(message);}
}
  • 全局异常类
@RestControllerAdvice
@Slf4j
@Order(value = Ordered.HIGHEST_PRECEDENCE)
public class GlobalExceptionHandler {@ExceptionHandler(value = UserException.class)public Result handlerUserException(UserException e, HttpServletRequest request) {String msg = e.getMessage();log.error("请求[ {} ] {} 的参数校验发生错误，错误信息：{}", request.getMethod(), request.getRequestURL(), msg, e);return Result.error(Result.COMMENT_CODE, msg);}
}

重写 Controller

@RestController
@RequestMapping("/user")
@Slf4j
@Validated
@RequiredArgsConstructor
public class UserController {private final UserService userService;/*** 根据用户id查询用户信息** @param id 用户id* @return 成功则返回用户信息*/@GetMapping("/selectById")public UserVo selectById(@RequestParam(required = false) Integer id) {UserVo user = userService.selectUserById(id);log.info("selectById根据id:{}执行查询,查询的用户信息为:{}", id, JsonMapper.toJson(user));if (user == null) {throw new UserException("查询的用户不存在");}return user;}
}

到此返回的同一格式的设计思路完成，是不是又简洁，又优雅。

关于作者

来自一线程序员Seven的探索与实践，持续学习迭代中~

本文已收录于我的个人博客：https://www.seven97.top

公众号：seven97，欢迎关注~

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/798746.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

白云龙期货分析-第九讲

白云龙期货分析-第九讲

九种职业操盘手高级战法 出征准备买卖法V旗买卖法双旗合并买卖法青龙取水买卖法中长线可选60日均线水杯买卖法南辕北辙买卖法国内和国外趋势不一样 断剑买卖法大阴阳买卖法童子拜佛买卖法 下影线多于上影线，向上趋势能量
阅读更多...
浮点数的比较

浮点数的比较

浮点数与"零值" 精度损失: 浮点值与实际值不等,可能偏大可能偏小,都属于精度损失验证浮点数是否存在精度损失验证浮点数的差值是否存在精度损失浮点数直接比较验证结论: 浮点数在进行比较时,绝对不能使用双等号==来进行比较. 浮点数本身有精度损失,进而导致结果可能…
阅读更多...
白家强的第一次作业

白家强的第一次作业

一、自我介绍 大家好，我的名字是白家强，我来自河北邢台，我的家乡处于华北平原，在我的家乡有美丽的苞米地和一望无垠的大麦田。我现就读于浙江理工大学22级自动化（1）班，是一名大三的学生。在杭州上学的这两年中，遇到了许许多多的人，结识了许多好友，认识了很多老师，我…
阅读更多...
Qt加载天地图离线api开发包/从官网趴地图js代码/费了九牛二虎之力终于搞定

Qt加载天地图离线api开发包/从官网趴地图js代码/费了九牛二虎之力终于搞定

一、前言说明 网上关于如何趴天地图离线api文件的文章，只有少量的两三篇，而且几乎没有说全和说对，搞得评论也是一片懵逼，这里不行那你不行，思路可以借鉴就是。索性花了点时间，自己研究了如何从官网一步步趴下来js文件，最终所有离线能使用的功能全部搞定，也根本不会有ht…
阅读更多...
一键生成！轻量级 AI 证件照制作工具！

一键生成！轻量级 AI 证件照制作工具！

HivisionIDPhotos —— 一个轻量级的 AI 证件照制作工具，利用一套完善的模型工作流程，实现对多种用户拍照场景的识别、抠图与证件照生成。大家好，我是 Java陈序员。 在日常生活中，我们需要各式各样的证件照。有时候需要不同的尺寸，一寸、两寸、小二寸...而有的时候需要不同…
阅读更多...
[问题排查]CPU占用过高

[问题排查]CPU占用过高

查看占用cpu高的进程 top 按P 如下图：可看出PID为7149的java进程占用cpu最高，达到了98%查看进程中最耗cpu的子线程 top -Hp 7149 如下图：可看出PID为7166的线程占用cpu最高，达到了97.7%将最耗cpu的线程id转换为16进制输出 perl printf "%x \n" 7166 查询具体出现…
阅读更多...
白云龙期货投资-第八讲

白云龙期货投资-第八讲

假突破的深度分析 一 高低点 平台之假突破深度分析 二 趋势线假突破之深度分析 三 假突破实盘应变操作法 假突破之飘旗确认法 在上沿做旗形整理，假突破假突破之空间确认法盘久必跌 趋势线假突破之深度分析假突破实盘应变方法 一 任何突破后不要急于进场，要看下一步行情的反应…
阅读更多...
章13——包装类——StringBuilder类

章13——包装类——StringBuilder类

StringBuilder介绍其继承关系和 StringBuffer 是一样的。同 StringBuffer 一样，是在堆中（value[]）而非在常量池中。 三种 String 的对比有关复用率高的解读：String 的内容在常量池中，相同内容的对象（或其在堆中的东西）都可以指向常量池中的同一个位置 效率问题：StringB…
阅读更多...
章13——常用类——StringBuffer类

章13——常用类——StringBuffer类

基本介绍即 StringBuffer 是存在堆中的而非常量池中的。（value 数组存放字符串内容） 与 String 的对比StringBuffer：不用每次更新地址，但当数组空间不够时，会扩大并且更新地址。 构造器StringBuffer stringBuffer = new StringBuffer();StringBuffer stringBuffer1 = new …
阅读更多...
Windows的树形目录结构

Windows的树形目录结构

一、文件、文件夹（目录）、逻辑盘、路径的概念文件：是操作系统用来存储和管理信息的基本单位文件夹也叫目录：是文件的集合体，文件夹中可包含多个文件，也可包含多个子文件夹。每个文件夹都有一个唯一的名称，用于在文件系统中标识和访问。逻辑盘，计算机的外存储器一…
阅读更多...
高等数学 2.5 函数的微分

高等数学 2.5 函数的微分

目录一、微分的定义二、微分的几何意义三、微分运算1、函数和、差、积、商的微分法则2、复合函数的微分法则四、微分在近似计算中的应用 一、微分的定义定义 设函数 \(y = f(x)\) 在某区间内有定义，\(x_0\) 及 \(x_0 + \Delta x\) 在这区间内，如果函数的增量 \[\Delta y = f(…
阅读更多...
信息学奥赛初赛天天练-91-CSP-S2023基础题3-编译命令、树的重心、拓扑排序、进制转换、R进制转十进制、十进制转R进制

信息学奥赛初赛天天练-91-CSP-S2023基础题3-编译命令、树的重心、拓扑排序、进制转换、R进制转十进制、十进制转R进制

PDF文档公众号回复关键字:202409172023 CSP-S 选择题 1单项选择题（共15题，每题2分，共计30分：每题有且仅有一个正确选项） 11 以下哪个命令，能将一个名为 main.cpp 的 C++ 源文件，编译并生成一个名为 main 的可执行文件？( ) A g++ -o main main.cpp B g++ -o main.…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023