springboot 之 自定义拦截器

拦截器的作用

日志记录，权限检查，性能监控，通用行为

拦截器在web处理流程中所处位置

https://blog.csdn.net/u013919153/article/details/104817616

一般实现流程

1、自定义拦截器, 实现HandlerInterceptor接口
	preHandle：调用Controller某个方法之前
	postHandle：Controller之后调用，视图渲染之前，如果控制器Controller出现了异常，则不会执行此方法
	afterCompletion：不管有没有异常，这个afterCompletion都会被调用，用于资源清理

2、@Configuration
	SpringBoot2.X 新版本配置拦截器 implements WebMvcConfigurer，添加自定义的拦截器

3、按照注册顺序进行拦截，先注册，先被拦截

代码：

自定义拦截器

import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 *  拦截器作用：
 *  日志记录，权限检查，性能监控，通用行为
 *
 */

@Component
public class MyInterceptorTwo implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        request.setAttribute("startTime", System.currentTimeMillis());

        System.out.println("在请求处理之前进行调用（Controller方法调用之前）");

        if (handler instanceof HandlerMethod){
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            System.out.println("controller object is " + handlerMethod.getBean().getClass().getName());
            System.out.println("controller method is " + handlerMethod.getMethod());
        }else{
            System.out.println("undefine api");
            return  false;
        }


        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("请求处理之后进行调用，但是在视图被渲染之前（Controller方法调用之后），如果异常发生，则该方法不会被调用");

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("在整个请求结束之后被调用，也就是在DispatcherServlet 渲染了对应的视图之后执行（主要是用于进行资源清理工作）");
        long startTime = (long) request.getAttribute("startTime");
        System.out.println("time consume is " + String.valueOf(System.currentTimeMillis() - startTime));

    }
}

配置类

import com.example.mydefination.interceptor.MyInterceptorTwo;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.annotation.Resource;

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {

    @Resource
    private MyInterceptorTwo myInterceptorTwo;


    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptorTwo).addPathPatterns("/**").excludePathPatterns("/api/v1/**");
    }
}

结果

过滤器和拦截器对比

1. 过滤器基于函数回调，依赖于servlet容器；拦截器基于动态代理(java反射机制)，不依赖servlet。

2.过滤器只能在请求前和请求后各调用一次；拦截器可以在action前和action后调用，异常前后调用。

3.拦截器可以获取IOC容器中的各个bean，在拦截器里注入一个service，可以调用业务逻辑；过滤器不行