6、拦截器HandlerInterceptor

## 前言

很多组件都有拦截器的概念，比如 mybatis拦截器，axios拦截器

因为他们都涉及到数据的接收与发送，接收前和发送前，都有必要对数据进行拦截，因为任何时候都不要相信用户的输入。

### 1、实现HandlerInterceptor接口

新建一个MyInterceptor  实现HandlerInterceptor接口 。

~~~java
public class MyInterceptor implements HandlerInterceptor {

/**
     * 1、preHandle方法是进行处理器拦截用的，顾名思义，该方法将在Controller处理之前进行调用。
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        System.out.println(new Date() + "--preHandle:" + request.getRequestURL());
        StringBuffer url = request.getRequestURL();
        if(url.substring(url.lastIndexOf("/")+1,url.length()).equals("GetName")){
            System.out.println("------模糊查询方法------");
            String nickName = request.getParameter("nickName");
            System.out.println("获取的是nickName："+nickName+"，我可以根据获取的值判断是否是sql注入等操作");
        }
        return true;
    }

/**
     * 2、这个方法只会在当前这个Interceptor的preHandle方法返回值为true的时候才会执行。
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
                           ModelAndView modelAndView) throws Exception {
        System.out.println(new Date() + "--postHandle:" + request.getRequestURL());
    }

/**
     * 3、该方法将在postHandle请求完成之后，也就是DispatcherServlet渲染了视图执行
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        System.out.println(new Date() + "--afterCompletion:" + request.getRequestURL());
    }

}
~~~

> MyInterceptor 中的方法执行顺序为 preHandle – Controller 方法 – postHandle – afterCompletion ，所以拦截器实际上可以对 Controller 方法执行前后进行拦截监控。
>
> 最后还有一个非常重要的注意点， preHandle 需要返回布尔类型的值。 preHandle 返回 true 时，对控制器方法的请求才能到达控制器，继而到达 postHandle 和 afterCompletion 方法；如果 preHandle 返回 false ，后面的方法都不会执行。

### 2、添加Web项目的拦截器

MyInterceptor自定义的拦截器是写好了，但是默认是不生效的，需要在webconfig配置中配置一下才能生效。

addPathPatterns("/**") 表示 所有的请求，都要路由到 拦截器上进行处理。

~~~java
@Configuration
public class WebConfig implements WebMvcConfigurer {
    /**
     * 添加Web项目的拦截器
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 对所有访问路径，都通过MyInterceptor类型的拦截器进行拦截
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
    }
}
~~~

### 3、查看效果

访问 http://localhost:8080/GetName?nickName=hello 查看后台打印的日志。可以看到

~~~
------模糊查询方法------
获取的是nickName：hello，我可以根据获取的值判断是否是sql注入等操作
Thu Nov 03 12:48:35 CST 2022--postHandle:http://localhost:8080/GetName
Thu Nov 03 12:48:35 CST 2022--afterCompletion:http://localhost:8080/GetName
Thu Nov 03 12:48:35 CST 2022--preHandle:http://localhost:8080/error
Thu Nov 03 12:48:35 CST 2022--postHandle:http://localhost:8080/error
Thu Nov 03 12:48:35 CST 2022--afterCompletion:http://localhost:8080/error
~~~