【天天时快讯】springboot统一响应实体封装+统一异常类管理

前言：

在日常前后端分离的接口开发过程中，需要我们按相应的格式给前端返回响应的数据，常见的方式就是我们后端自己封装一个包装类，每次返回给前端数据的时候都需要我们自己手动构建一。

(相关资料图)

短时间内来看或许并没有什么，但是一旦接口量变大，我们每个接口都去构建返回值的话，那样就会浪费我们很多的开发时间，所以我们就可以对响应的内容进行统一的处理，在写Controller中的方法时我们也可以不用统一返回类型了。例如：

@ApiOperation(value = "分页查询告警信息")    @PostMapping("findAlarmByPage")    public PageInfo selectAll(@RequestBody AlarmReqVo alarmReqVo) {        return towerAlarmInfoService.findByPage(alarmReqVo);    }

这样可以让我们减少很多的工作量。 可能有的朋友就会问：那我们的非空验证可一些异常的处理怎么办呢？ 下面介绍的就是统一的异常类型管理。把我们后端所有能发生的异常进行统一的封装（可以自定义一个异常类型），封装之后再返回给前端相应的提示，那么前端就会清晰的知道后端发生了什么错误，是不是前端的锅哈哈哈哈。

响应实体的封装：

首先肯定我们还是需要建一个统一返回的类：

1 package com.dlxx.tower.app.util;  2   3 import com.fasterxml.jackson.annotation.JsonInclude;  4 import lombok.AllArgsConstructor;  5 import lombok.Data;  6 import lombok.NoArgsConstructor;  7   8 @Data  9 @AllArgsConstructor 10 @NoArgsConstructor 11 //这个注解表示变量为空的时候构造json就不带上这个变量 12 @JsonInclude(JsonInclude.Include.NON_NULL) 13 public class FrontResult { 14     /** 15      * 结果状态码 16      */ 17     private Integer code; 18     /** 19      * 响应结果描述 20      */ 21     private String message; 22     /** 23      * 返回数据 24      */ 25     private Object data; 26  27     public FrontResult(Object data) { 28         this.data = data; 29         this.code = ResultEnum.SUCCESS.getCode(); 30         this.message = "操作成功"; 31     } 32  33     /** 34      * 静态方法，返回前端实体结果 35      * 36      * @param code    状态码 37      * @param message 消息 38      * @param data    数据 39      * @return 前端实体结果 40      */ 41     public static FrontResult build(Integer code, String message, Object data) { 42         return new FrontResult(code, message, data); 43     } 44  45     /** 46      * 返回成功的结果实体 47      * 48      * @param message 消息 49      * @param data    数据 50      * @return 实体 51      */ 52     public static FrontResult getSuccessResult(String message, Object data) { 53         FrontResult result = new FrontResult(); 54         result.code = ResultEnum.SUCCESS.getCode(); 55         result.message = message; 56         result.data = data; 57         return result; 58     } 59  60     /** 61      * 返回无需data的成功结果实体 62      * 63      * @param message 消息内容 64      * @return 返回结果 65      */ 66     public static FrontResult getSuccessResultOnlyMessage(String message) { 67         FrontResult result = new FrontResult(); 68         result.code = ResultEnum.SUCCESS.getCode(); 69         result.message = message; 70         result.data = null; 71         return result; 72     } 73  74     /** 75      * 获取一个异常结果 76      * 77      * @param code    错误码 78      * @param message 自定义异常信息 79      * @return FrontResult 80      */ 81     public static FrontResult getExceptionResult(Integer code, String message) { 82         FrontResult result = new FrontResult(); 83         result.code = (code == null) ? ResultEnum.CODE_EXCEPTION.getCode() : code; 84         result.message = message.isEmpty() ? ResultEnum.CODE_EXCEPTION.getMsg() : message; 85         return result; 86     } 87  88     /** 89      * 得到异常结果 90      * 91      * @param resultEnum 枚举结果代码 92      * @return {@link FrontResult} 93      */ 94     public static FrontResult getExceptionResult(ResultEnum resultEnum) { 95         FrontResult result = new FrontResult(); 96         Integer code = resultEnum.getCode(); 97         String msg = resultEnum.getMsg(); 98         result.code = (code == null) ? ResultEnum.CODE_EXCEPTION.getCode() : code; 99         result.message = msg.isEmpty() ? ResultEnum.CODE_EXCEPTION.getMsg() : msg;100         return result;101     }102 }

统一封装一下枚举类型ResultEnum

import lombok.AllArgsConstructor;/** * 结果枚举 * * @author longjun * @date 2023/04/11 */@AllArgsConstructorpublic enum ResultEnum {    /**     * 成功     */    SUCCESS(200, "操作成功"),    /**     * 代码异常     */    CODE_EXCEPTION(500, "后端代码内部异常"),    /**     * 参数错误     */    PARAMETER_ERROR(999, "前端入参异常"),    /**     * 失败     */    FAIL(1111, "后端代码异常异常"),    /**     * 空点     */    NULL_POINT(1000, "空指针异常"),    /**     * 指数误差     */    OUT_OF_INDEX_ERROR(1001, "索引越界异常"),    /**     * 模型零     */    MODEL_NULL(1002, "前端入参实体的实体为空"),    /**     * 数据库错误     */    DATABASE_ERROR(1003, "数据库异常"),    /**     * 身份验证错误     */    AUTHENTICATION_ERROR(1004, "身份验证异常"),    /**     * 逻辑错误     */    LOGIC_ERROR(1005, "业务逻辑异常"),    /**     * 类没有找到     */    CLASS_NOT_FOUND(1006, "类未找到异常"),    /**     * sql异常     */    SQL_EXCEPTION(1007, "sql语句异常"),    /**     * io例外     */    IO_EXCEPTION(1008, "io异常"),    /**     * json解析错误     */    JSON_PARSE_ERROR(1009, "json转换异常"),    NUMBER_FORMAT_ERROR(1010, "String转换为数字错误"),    /**     * 更新失败     */    UPDATE_FAIL(1011, "更新失败"),    /**     * 发送POST错误     */    SEND_POST_ERROR(1012, "发送POST请求异常"),    /**     * 短信发送错误     */    SMS_SEND_ERROR(1013, "短信发送失败");    /**     * 状态码     */    private Integer code;    public Integer getCode() {        return code;    }    ResultEnum(Integer code) {        this.code = code;    }    private String msg;    public String getMsg() {        return msg;    }}  

基本的类型封装好了，接下来就是重头戏，关键代码也在这里。主要就是实现了ResponseBodyAdvice接口，其实是对加了@RestController(也就是@Controller+@ResponseBody)注解的处理器将要返回的值进行增强处理。

其实也就是采用了AOP的思想，对返回值进行一次修改。

该接口一共有两个方法：

（1）supports ——判断是否要执行beforeBodyWrite方法，true为执行，false不执行 —— 通过supports方法，我们可以选择哪些类或哪些方法要对response进行处理，其余的则不处理。

（2）beforeBodyWrite —— 对 response 处理的具体执行方法。

1 package com.dlxx.tower.app.config; 2  3 import com.dlxx.tower.app.exception.BizException; 4 import com.dlxx.tower.app.util.FrontResult; 5 import com.fasterxml.jackson.core.JsonProcessingException; 6 import com.fasterxml.jackson.databind.ObjectMapper; 7 import org.springframework.core.MethodParameter; 8 import org.springframework.http.MediaType; 9 import org.springframework.http.converter.HttpMessageConverter;10 import org.springframework.http.server.ServerHttpRequest;11 import org.springframework.http.server.ServerHttpResponse;12 import org.springframework.web.bind.annotation.RestControllerAdvice;13 import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;14 15 /**16  * 响应控制器建议17  *18  * @author longjun19  * @description: 全局处理增强版Controller，避免Controller里返回数据每次都要用响应体来包装20  *21  * @date 2023/04/0422  */23 @RestControllerAdvice(basePackages = {"com.dlxx.tower.app.controller"})24 public class ResponseControllerAdvice implements ResponseBodyAdvice