SpringBoot统一功能处理

目录

1.统一数据返回格式

1.1快速入门

1.2存在问题

1.3案例代码修改

1.4优点

2.统一异常处理

1.统一数据返回格式

1.1快速入门

统一的数据返回格式使用 @ControllerAdvice和ResponseBodyAdvice的方式实现

@ControllerAdvice表示控制器通知类

添加类ResponseAdvice，实现ResponseBodyAdvice接口，并添加@ControllerAdvice注解

@ControllerAdvice
 public class ResponseAdvice implements ResponseBodyAdvice {
     @Override
     public boolean supports(MethodParameter returnType, Class converterType) {
         return true;
     } 

     @Override
     public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
         return Result.success(body);
     }
 }

supports方法:   判断是否要执行beforeBodyWrite方法. true为执行 , false不执行 .  通过该方法可以选择哪些类或哪些方法的response要进行处理, 其他的不进行处理.

  从returnType获取类名和方法名 

 //获取执⾏的类
 Class<?> declaringClass = returnType.getMethod().getDeclaringClass();
 //获取执⾏的⽅法
 Method method = returnType.getMethod();

beforeBodyWrite方法:   对response⽅法进⾏具体操作处理测试

测试接口： 

http://127.0.0.1:8080/book/queryBookById?bookId=1http://127.0.0.1:8080/book/queryBookById?bookId=1http://127.0.0.1:8080/book/queryBookById?bookId=1 添加

统⼀数据返回格式之前:

添加统⼀数据返回格式之后:

1.2存在问题

问题现象:

我们继续测试修改图书的接口：http://127.0.0.1:8080/book/updateBook

结果显示 , 发生内部错误 

查看数据库, 发现数据操作成功

查看日志, 日志报错

 多测试几种不同的返回结果, 发现只有返回结果为String类型时才有这种错误发生

解决方案：

   private static ObjectMapper mapper = new ObjectMapper();

   @Override
   public Object beforeBodyWrite(Object body, MethodParameter returnType, Media
        //如果返回结果为String类型, 使⽤SpringBoot内置提供的Jackson来实现信息的序列化
        if (body instanceof String){
             return mapper.writeValueAsString(Result.success(body));
         }
         return Result.success(body);
     }
 }

原因分析：

SpringMVC默认会注册一些自带的HttpMessageConverter

 public class RequestMappingHandlerAdapter extends AbstractHandlerMethodAdapter
       implements BeanFactoryAware, InitializingBean {

      //...
       public RequestMappingHandlerAdapter() {
        this.messageConverters = new ArrayList<>(4);
        this.messageConverters.add(new ByteArrayHttpMessageConverter());
        this.messageConverters.add(new StringHttpMessageConverter());
        if (!shouldIgnoreXml) {
          try {
              this.messageConverters.add(new SourceHttpMessageConverter<>());
          }
          catch (Error err) {
             // Ignore when no TransformerFactory implementation is available
          }
        }
        this.messageConverters.add(new AllEncompassingFormHttpMessageConverter());
     }
      //...
 }

其中AllEncompassingFormHttpMessageConverter 会根据项目依赖情况 添加对应的 HttpMessageConverter

在((HttpMessageConverter) converter) .write(body, selectedMediaType,的处理中, 调用父类的write⽅法,由于StringHttpMessageConverter重写了addDefaultHeaders方法，所以会执行子类方法

然而子类StringHttpMessageConverter的addDefaultHeaders方法定义接收参数为String， 此时T为Result类型，所以出线类型不匹配"Result cannot be cast to java.lang.String"的异常

1.3案例代码修改

@Controller
@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {
    @Autowired
    private ObjectMapper objectMapper;

    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }

    @SneakyThrows
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        //在返回之前, 需要做的事情
        //body 是返回的结果
        if (body instanceof Result){
            return body;
        }
        if (body instanceof String){
            return objectMapper.writeValueAsString(Result.success(body));
        }
        return Result.success(body);
    }
}

1.4优点

1.  方便前端程序员更好的接收和解析后端数据接口返回的数据

2.  降低前端程序员和后端程序员的沟通成本, 按照某个格式实现就可以了, 因为所有接口都是这样返回的.

3.  有利于项目统⼀数据的维护和修改.

4.  有利于后端技术部门的统⼀规范的标准制定, 不会出现稀奇古怪的返回内容.

2.统一异常处理

统⼀异常处理使用的是@ControllerAdvice来实现的,@ControllerAdvice表⽰控制器通知类，@ExceptionHandler是异常处理器 ，两个结合表示当出现异常的时候执⾏某个通知 ，也就是执⾏某个方法事件

 @ControllerAdvice
 @ResponseBody
 public class ErrorAdvice { 

     @ExceptionHandler
     public Object handler(Exception e) {
         return Result.fail(e.getMessage());
     }
 }

类名、方法名和返回值可以自定义，重要的是加上注解

接口返回为数据时，需要加@ResponseBody注解

以上代码表示 ，如果代码出现Exception异常(包括Exception的子类), 就返回⼀个 Result的对象, Result对象的设置参考Result.fail(e.getMessage))

 public static Result fail(String msg) {
     Result result = new Result();
     result.setStatus(ResultStatus.FAIL);
     result.setErrorMessage(msg);
     result.setData("");
     return result;
 }

我们可以针对不同的异常, 返回不同的结果.

 @ResponseBody
 @ControllerAdvice
 public class ErrorAdvice { 

     @ExceptionHandler
     public Object handler(Exception e) {
         return Result.fail(e.getMessage());
     }
     @ExceptionHandler
     public Object handler(NullPointerException e) {
         return Result.fail("发⽣NullPointerException:"+e.getMessage());
     } 

     @ExceptionHandler
     public Object handler(ArithmeticException e) {
         return Result.fail("发⽣ArithmeticException:"+e.getMessage());
     }
 }

其中具体执行哪个方法是根据异常的类型，哪个类型更接近就执行哪个，即匹配顺序为当前类及其子类向上依次匹配