Spring--同一数据返回格式与同一非常处理处罚

1.同一数据返回格式

欺压登录案例中, 我们共做了两部分⼯作
1. 通过Session来判断⽤户是否登录
2. 对后端返回数据进⾏封装, 告知前端处理处罚的结果（设置status401等）
回想我们在给前端返回时举行了一个同一的数据包装

2. @Data
3. public class Result<T> {
4.     private int status;//1.  200成功   2. -1未登录 3. -2  异常
5.     private String errorMsg;//错误信息
6.     private T data;
8.     /**
9.      * 登录成功
10.      * @param data
11.      * @param <T>
12.      * @return
13.      */
14.     public static <T> Result success(T data) {
15.         Result result = new Result();
16.         result.setStatus(ResultStatus.SUCCESS.getCode());
17.         result.setErrorMsg("");
18.         result.setData(data);
19.         return result;
20.     }
22.     /**
23.      * 未登录
24.      * @return
25.      */
26.     public static Result unLogin() {
27.         Result result = new Result();
28.         result.setErrorMsg("未登录，请登录后访问");
29.         result.setStatus(ResultStatus.UNLOGIN.getCode());
30.         return result;
31.     }
33.     /**
34.      * 登录失败
35.      * @param data
36.      * @param <T>
37.      * @return
38.      */
39.     public static <T> Result fail(String msg) {
40.         Result result = new Result();
41.         result.setErrorMsg(msg);
42.         result.setStatus(ResultStatus.FAIL.getCode());
43.         result.setData("");
44.         return result;
45.     }
46. }

复制代码

假如能将返回的数据全部都包装为Result那么代码就更加结实了（方便后续的添加修改）
参考拦截器，我们肯定不会对原来的方法返回结果直接一个一个修改。
SpringBoot也对此功能举行了支持
使用方法：
统⼀的数据返回格式使⽤ @ControllerAdvice 和 ResponseBodyAdvice 的⽅式实现 

2. @ControllerAdvice
3. public class ResponseAdvice implements ResponseBodyAdvice {
4. @Override
5. public boolean supports(MethodParameter returnType, Class converterType) {
6. return true;
7. }
9. @Override
10. public Object beforeBodyWrite(Object body, MethodParameter returnType,
11. MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest
12. request, ServerHttpResponse response) {
13. return Result.success(body);
14. }
15. }

复制代码

 
@ControllerAdvice注解已经包罗五大注解，会交给Spring举行管理
这个类有两个方法：supports（），beforeBodyWrite（）
supports（）：判断是否要执⾏beforeBodyWrite⽅法. true为执⾏, false不执⾏
可以通过参数获取类及方法誊写逻辑：

2.     @Override
3.     public boolean supports(MethodParameter returnType, Class converterType) {
4.         //获取执行方法的类
5.         Class<?> declaringClass = returnType.getMethod().getDeclaringClass();
6.         //获取执行的方法
7.         Method method = returnType.getMethod();
8.         //判断是否执行beforeBodyWrite方法   true--执行  false--不执行
9.         return true;
10.     }

复制代码

 beforeBodyWrite（）: 对response⽅法进⾏详细操纵处理处罚
 在这里是将返回数据包装后返回给前端
但是这里假如直接对String举行包装返回会出现错误：
写一个测试类：

2. @RestController
3. @RequestMapping("/test")
4. public class TestController {
5.     @RequestMapping("/t1")
6.     public String t1() {
7.         return "t1";
8.     }
10.     @RequestMapping("/t2")
11.     public Integer t2() {
12.         return 2;
13.     }
15.     @RequestMapping("/t3")
16.     public Boolean t3() {
17.         return true;
18.     }
19. }

复制代码

而其他范例不会出现这种环境。出现这种环境是在源码阶段的范例不匹配（这里不举行穷究）
解决方法是将返回的Result转换成Spring范例。

2.          private static ObjectMapper mapper = new ObjectMapper();        
3.          if(body instanceof String) {
4.             //将result类型转化为String类型   否则在源码阶段会出现类型不匹配
5.             return  mapper.writeValueAsString(Result.success(body));
6.         }

复制代码

假如返回的范例就是Result则不消转换，直接返回

2.         //如果body是Result类型就直接返回
3.         if(body instanceof Result) {
4.             return body;
5.         }

复制代码

 最终代码：

1. /** * 同一结果返回 */@Slf4j@ControllerAdvicepublic class ResponseAdvice implements ResponseBodyAdvice {    private static ObjectMapper mapper = new ObjectMapper();
2.     @Override
3.     public boolean supports(MethodParameter returnType, Class converterType) {
4.         //获取执行方法的类
5.         Class<?> declaringClass = returnType.getMethod().getDeclaringClass();
6.         //获取执行的方法
7.         Method method = returnType.getMethod();
8.         //判断是否执行beforeBodyWrite方法   true--执行  false--不执行
9.         return true;
10.     }    @SneakyThrows    @Override    public Object beforeBodyWrite(Object body, MethodParameter returnType            , MediaType selectedContentType, Class selectedConverterType            , ServerHttpRequest request, ServerHttpResponse response) {        //判断body是否是String范例        if(body instanceof String) {            //将result范例转化为String范例   否则在源码阶段会出现范例不匹配            return  mapper.writeValueAsString(Result.success(body));        }
11.         //如果body是Result类型就直接返回
12.         if(body instanceof Result) {
13.             return body;
14.         }        return Result.success(body);    }}

复制代码

2.同一非常处理处罚

在上一步同一结果返回时，假如范例不匹配，并没有爆出非常（最外层显示200），这是我们不能吸取的。
我们固然可以对每一块代码举行trycacth围绕，但同样面对冗余的环境。
解决方法是：同一非常处理处罚
统⼀非常处理处罚使⽤的是 @ControllerAdvice + @ExceptionHandler 来实现的
@ControllerAdvice 控制器关照类（标识作用）， @ExceptionHandler 是非常处理处罚器，两个团结表⽰当出现非常的时间执⾏某个关照，也就是执⾏某个⽅法变乱
记得加： @ResponseBody

2. /**
3. * 统一异常处理
4. */
5. //接⼝返回为数据时, 需要加 @ResponseBody 注解
6. @ControllerAdvice
7. @ResponseBody
8. public class ErrorAdvice {
9.     @ExceptionHandler
10.     public Object handler(Exception e) {
11.         return Result.fail(e.getMessage());
12.     }
13. }

复制代码

假如代码出现Exception非常(包罗Exception的⼦类), 就返回⼀个 Result的对象, Result 对象的设置参考 Result.fail(e.getMessage())

2.     public static <T> Result fail(String msg) {
3.         Result result = new Result();
4.         result.setErrorMsg(msg);
5.         result.setStatus(ResultStatus.FAIL.getCode());
6.         result.setData("");
7.         return result;
8.     }

复制代码

固然，只能爆Exception这么宽泛的非常就没有意义了
我们可以针对差别的非常, 返回差别的结果

2. @ExceptionHandler
3.     public Object handler(Exception e) {
4.         return Result.fail(e.getMessage());
5.     }
7.     //空指针异常
8.     @ExceptionHandler
9.     public Object handler(NullPointerException e) {
10.         return Result.fail(e.getMessage());
11.     }
13.     //算数异常
14.     @ExceptionHandler
15.     public Object handler(ArithmeticException e) {
16.         return Result.fail(e.getMessage());
17.     }

复制代码

如今我们在测试类中添加两个非常观察一下：

2.     @RequestMapping("/t1")
3.     public String t1() {
4.         String s = "1";
5.         char a = s.charAt(2);
6.         return "t1";
7.     }
9.     @RequestMapping("/t2")
10.     public Integer t2() {
11.         int s = 10/0;
12.         return 2;
13.     }

复制代码

它会抛出隔断最近的非常
针对差别的非常, 返回差别的结果尚有一种写法：

2.     //算数异常
3.     @ExceptionHandler(ArithmeticException.class)
4.     public Object handler1(Exception e) {
5.         return Result.fail(e.getMessage());
6.     }
7.     @ExceptionHandler(NullPointerException.class)
8.     public Object handler2(Exception e) {
9.         return Result.fail(e.getMessage());
10.     }
11.     @ExceptionHandler(Exception.class)
12.     public Object handler3(Exception e) {
13.         return Result.fail(e.getMessage());
14.     }

复制代码

将非常加在注解中