SpringBoot统一功能处理

时间:2022-09-28 喜欢敲代码的大秃噜人气:0

基于SpringAOP已经实现统一功能增强，但如果希望对Controller增强，就无法获取其中的http请求数据。因此，实现以下这些统一增强的业务，就不能使用SpringAOP：

响应数据统一封装
统一异常处理（返回错误信息的http响应）
http请求日志记录

SpringMVC统一处理的三种方式

SpringMVC在SpringBoot项目中，是默认进行了配置，同时也提供了自定义的配置方式。

1、基于SpringMVC的配置类扩展

如：

（1）添加路径前缀

    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        //对Controller中的路径，添加前缀
        //需要注意：添加前缀后，之后进行资源访问也需要添加前缀
        //第一个参数：要添加的前缀，第二个参数：用于锅炉Controller中的方法
        configurer.addPathPrefix("api",(c)->true);
    }

（2）添加拦截器

添加Controller的方法拦截器=>对请求映射方法进行统一增强。

web开发中的三大组件：过滤器、拦截器、监听器。

拦截器：

对web请求和响应进行拦截，然后可以统一处理；

Spring中，包含两种拦截器：

HandlerInterceptor：专门做SpringMVC请求和响应的拦截；
MethodInterceptor：对方法进行拦截，是SpringAOP的一种实现。

拦截器的实现原理：

HandlerInterceptor的实现原理：SpringMVC是基于框架实现了一个顶级的Servlet：DispatcherServlet，里面封装了很多逻辑，其中包括HandlerInterceptor的逻辑。是基于代码设计上的实现=>不是动态代理！！！

MethodInterceptor实现原理：基于动态代理。

2、统一的响应数据格式封装

使用@ControllerAdvice+ResponseBodyAdvice的方式实现。

import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
 
import java.util.HashMap;
import java.util.Map;
 
@ControllerAdvice
//注解是对Controller进行增强（SpringMVC代码设计）
public class ResponseAdvice implements ResponseBodyAdvice {
    //方法的返回值表示是否要对请求映射方法增强
    //两个方法参数，可以筛选controller中的请求映射方法
    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return false;
    }
    //增强的逻辑：http返回的响应，基于方法的返回值来设置响应体body
    //第一个方法参数body，是请求映射方法的返回值
    //调用登录接口，返回map对象（ok=false,msg=xxx），就是body方法参数
    @Override
    public Object beforeBodyWrite(Object body,
                                  MethodParameter returnType,
                                  MediaType selectedContentType, 
                                  Class selectedConverterType,
                                  ServerHttpRequest request,
                                  ServerHttpResponse response) {
        //构造一个统一的返回格式
        Map<String,Object> map =new HashMap<>();
        map.put("success",true);
        map.put("data",body);
        return map;
    }
}

3、统一异常处理

Controller请求映射方法，如果抛异常，由统一异常处理的代码来执行。

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
 
import javax.servlet.http.HttpServletResponse;
import java.util.HashMap;
 
//统一异常处理
@Controller
public class ExceptionAdvice {
 
    //使用@ExceptionHandler注解，可以设置要补货的Controller请求映射方法抛出的异常类
    @ExceptionHandler(Exception.class)
    //方法的写法，和Controller请求映射方法的写法类似
    //如果返回json就使用@ResponseBody，如果返回网页，就返回资源路径的字符串
    @ResponseBody
    public Object handle(Exception e,
                         HttpServletResponse){
        HashMap<String, Object>  map= new HashMap<>();
        map.put("success", 0);
        map.put("status", 1);
        map.put("msg", e.getMessage());
        return map;
    }
    
}

加载全部内容