• 一文教你处理SpringBoot统一返回格式

    背景

    相信大部分后端开发人员在日常开发中都需要和前端对接，当然前后端都是你自己一个人搞的话可以想怎么玩就怎么玩，但是我们还是要做到一定的规范性。在前后端分离的项目中后端返回的格式一定要友好，并且固定，不能经常变来变去，不然会对前端的开发人员带来很多的工作量。

    SpringBoot Controller 常见的返回格式

    String

    1. @PostMapping("/test")
    2. public String test(){
    3.     return "Hello World";
    4. }
    5. 复制代码

    postman调用结果：

    自定义对象

    正常返回

    1.     @PostMapping("/getUser")
    2.     public ActionResult getUser(){
    3.         User user = new User();
    4.         user.setId(UUID.randomUUID().toString());
    5.         user.setName("MrDong");
    6.         user.setAge(20);
    7.         return ActionResult.defaultOk(user);
    8.     }
    9. 复制代码

    postman调用结果：

    错误返回

    1.    @PostMapping("/error")
    2.     public ActionResult error(){
    3.         return ActionResult.defaultFail(1000,"服务器异常，请联系管理员");
    4.     }
    5. 复制代码

    postman调用结果：

    定义返回对象

    我定义两个ActionResult这个对象来对返回值进行封装，可以根据自己公司实际情况修改：

    1. package com.wxd.entity;
    2.  
    3. import com.wxd.enums.ResultCodeEnum;
    4. import lombok.Data;
    5.  
    6. /**
    7.  * @ClassName ActionResult
    8.  * @Description 统一返回值封装
    9.  * @Author Mr Dong
    10.  * @Date 2022/7/26 14:51
    11.  */
    12. @Data
    13. public class ActionResult {
    14.  
    15.     private Integer code;
    16.     private String msg;
    17.     private Integer count;
    18.     private Object data;
    19.  
    20.     public static ActionResult defaultOk(Integer code, String msg, Integer count, Object data) {
    21.         return new ActionResult(code, msg, count, data);
    22.     }
    23.  
    24.     public static ActionResult defaultOk(Integer count, Object data) {
    25.         return new ActionResult(ResultCodeEnum.RC200, count, data);
    26.     }
    27.  
    28.     public static ActionResult defaultOk(Object data) {
    29.         return new ActionResult(ResultCodeEnum.RC200, null, data);
    30.     }
    31.  
    32.     public static ActionResult defaultOk() {
    33.         return new ActionResult(ResultCodeEnum.RC200);
    34.     }
    35.  
    36.     public static ActionResult defaultFail() {
    37.         return new ActionResult(ResultCodeEnum.RC999);
    38.     }
    39.  
    40.     public static ActionResult defaultFail(Integer code, String msg) {
    41.         return new ActionResult(code, msg);
    42.     }
    43.  
    44.     public static ActionResult defaultFail(ResultCodeEnum resultCodeEnum) {
    45.         return new ActionResult(resultCodeEnum);
    46.     }
    47.  
    48.     public ActionResult(Integer code, String msg, Integer count, Object data) {
    49.         this.code = code;
    50.         this.msg = msg;
    51.         this.count = count;
    52.         this.data = data;
    53.     }
    54.  
    55.     public ActionResult(Integer code, String msg) {
    56.         this.code = code;
    57.         this.msg = msg;
    58.     }
    59.  
    60.     public ActionResult(ResultCodeEnum resultCodeEnum) {
    61.         this.code = resultCodeEnum.getCode();
    62.         this.msg = resultCodeEnum.getMessage();
    63.     }
    64.  
    65.     public ActionResult(ResultCodeEnum resultCodeEnum, Integer count, Object data) {
    66.         this.code = resultCodeEnum.getCode();
    67.         this.msg = resultCodeEnum.getMessage();
    68.         this.count = count;
    69.         this.data = data;
    70.     }
    71.  
    72. }
    73. 复制代码

    定义状态枚举

    1. package com.wxd.enums;
    2.  
    3. /**
    4.  * @author wxd
    5.  * @version V1.0
    6.  * @description ResultCodeEnum
    7.  * @date 2022/8/10 13:35
    8.  **/
    9. public enum ResultCodeEnum {
    10.     /**
    11.      * 操作成功
    12.      */
    13.     RC200(200, "操作成功"),
    14.     /**
    15.      * 未授权
    16.      */
    17.     RC401(401, "用户未授权"),
    18.     /**
    19.      * 请求被禁止
    20.      */
    21.     RC403(403, "请求被禁止"),
    22.     /**
    23.      * 服务异常
    24.      */
    25.     RC500(500, "服务器异常，请联系管理员"),
    26.     /**
    27.      * 操作失败
    28.      */
    29.     RC999(999, "操作失败"),
    30.  
    31.     RC1001(1001, "用户名密码错误"),
    32.     RC1002(1002, "未授权的资源"),
    33.     RC1003(1003, "未授权的资源"),
    34.     RC1004(1004, "缺少请求参数异常"),
    35.     RC1005(1005, "缺少请求体参数异常"),
    36.     RC1006(1006, "参数绑定异常"),
    37.     RC1007(1007, "方法参数无效异常");
    38.  
    39.     private Integer code;
    40.     private String message;
    41.  
    42.     ResultCodeEnum(Integer code, String message) {
    43.         this.code = code;
    44.         this.message = message;
    45.     }
    46.  
    47.     public Integer getCode() {
    48.         return code;
    49.     }
    50.  
    51.     public String getMessage() {
    52.         return message;
    53.     }
    54. }
    55. 复制代码

    统一处理返回值及异常

    实现原理：需要实现SpringBoot提供的ResponseBodyAdvice这个接口，完成统一返回值的封装及异常的处理。实现了这个接口之后，在Controller返回的时候只需要将对象直接返回，有些不需要返回值的可以直接返回void。

    1. package com.wxd.advice;
    2.  
    3. import com.wxd.entity.ActionResult;
    4. import com.wxd.enums.ResultCodeEnum;
    5. import lombok.extern.slf4j.Slf4j;
    6. import org.springframework.core.MethodParameter;
    7. import org.springframework.http.HttpStatus;
    8. import org.springframework.http.MediaType;
    9. import org.springframework.http.converter.HttpMessageNotReadableException;
    10. import org.springframework.http.server.ServerHttpRequest;
    11. import org.springframework.http.server.ServerHttpResponse;
    12. import org.springframework.validation.BindException;
    13. import org.springframework.web.bind.MethodArgumentNotValidException;
    14. import org.springframework.web.bind.MissingServletRequestParameterException;
    15. import org.springframework.web.bind.annotation.ExceptionHandler;
    16. import org.springframework.web.bind.annotation.ResponseStatus;
    17. import org.springframework.web.bind.annotation.RestControllerAdvice;
    18. import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
    19.  
    20. /**
    21.  * @version: V1.0
    22.  * @author: wxd
    23.  * @description: 全局异常处理以及返回值的统一封装
    24.  * @Date 2022/7/26 16:24
    25.  */
    26. @RestControllerAdvice(value = "com.wxd.controller")
    27. @Slf4j
    28. public class ResponseAdvice implements ResponseBodyAdvice {
    29.  
    30.     @Override
    31.     public boolean supports(MethodParameter methodParameter, Class aClass) {
    32.         return true;
    33.     }
    34.  
    35.     /**
    36.      * 统一包装
    37.      *
    38.      * @param o
    39.      * @param methodParameter
    40.      * @param mediaType
    41.      * @param aClass
    42.      * @param serverHttpRequest
    43.      * @param serverHttpResponse
    44.      * @return
    45.      */
    46.     @Override
    47.     public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
    48.         /**
    49.          * String、ActionResult不需要再包一层（不想包一层ActionResult对象的可以在这里把这个对象过滤掉）
    50.          */
    51.         if (o instanceof String || o instanceof ActionResult) {
    52.             return o;
    53.         }
    54.         return ActionResult.defaultOk(o);
    55.     }
    56.  
    57.     /**
    58.      * 系统内部异常捕获
    59.      *
    60.      * @param e
    61.      * @return
    62.      */
    63.     @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    64.     @ExceptionHandler(value = Exception.class)
    65.     public Object exceptionHandler(Exception e) {
    66.         log.error("系统内部异常，异常信息", e);
    67.         return ActionResult.defaultFail(ResultCodeEnum.RC500);
    68.     }
    69.  
    70.  
    71.     /**
    72.      * 忽略参数异常处理器;触发例子:带有@RequestParam注解的参数未给参数
    73.      *
    74.      * @param e 忽略参数异常
    75.      * @return ResponseResult
    76.      */
    77.     @ResponseStatus(HttpStatus.BAD_REQUEST)
    78.     @ExceptionHandler(MissingServletRequestParameterException.class)
    79.     public Object parameterMissingExceptionHandler(MissingServletRequestParameterException e) {
    80.         log.error("缺少Servlet请求参数异常", e);
    81.         return ActionResult.defaultFail(ResultCodeEnum.RC1004);
    82.     }
    83.  
    84.     /**
    85.      * 缺少请求体异常处理器;触发例子:不给请求体参数
    86.      *
    87.      * @param e 缺少请求体异常
    88.      * @return ResponseResult
    89.      */
    90.     @ResponseStatus(HttpStatus.BAD_REQUEST)
    91.     @ExceptionHandler(HttpMessageNotReadableException.class)
    92.     public Object parameterBodyMissingExceptionHandler(HttpMessageNotReadableException e) {
    93.         log.error("参数请求体异常", e);
    94.         return ActionResult.defaultFail(ResultCodeEnum.RC1005);
    95.     }
    96.  
    97.  
    98.     /**
    99.      * 统一处理请求参数绑定错误(实体对象传参);
    100.      *
    101.      * @param e BindException
    102.      * @return ResponseResult
    103.      */
    104.     @ResponseStatus(HttpStatus.BAD_REQUEST)
    105.     @ExceptionHandler(BindException.class)
    106.     public Object validExceptionHandler(BindException e) {
    107.         log.error("方法参数绑定错误(实体对象传参)", e);
    108.         return ActionResult.defaultFail(ResultCodeEnum.RC1006);
    109.     }
    110.  
    111.     /**
    112.      * 统一处理请求参数绑定错误(实体对象请求体传参);
    113.      *
    114.      * @param e 参数验证异常
    115.      * @return ResponseResult
    116.      */
    117.     @ResponseStatus(HttpStatus.BAD_REQUEST)
    118.     @ExceptionHandler({MethodArgumentNotValidException.class})
    119.     public Object parameterExceptionHandler(MethodArgumentNotValidException e) {
    120.         log.error("方法参数无效异常(实体对象请求体传参)", e);
    121.         return ActionResult.defaultFail(ResultCodeEnum.RC1007);
    122.     }
    123.  
    124. }
    125. 复制代码

    void 无返回值

    有返回值


     

  • 相关阅读:
    大数据技术之 Kafka
    java对象与字节数组互转
    【从零开始学习 SystemVerilog】11.3、SystemVerilog 断言—— Concurrent Assertions（并发断言）
    为什么要停止在 SpringBoot 中使用字段注，改用构造器注入
    vue3项目经验分享
    Siri怎么重置主人声音
    UE4 GeoReferencing Plugin
    一年拿两证？初级会计和中级会计可以同时报考吗？
    MMoE论文中Synthetic Data生成代码(控制多任务学习中任务之间的相关性)
    java计算机毕业设计网络游戏管理网站源码+数据库+系统+lw文档+mybatis+运行部署
  • 原文地址：https://blog.csdn.net/m0_71777195/article/details/126284110