SpringBoot中过滤器和拦截器的简单构建

今天想把过滤器和拦截器学习一下、实现一下。实现完了，心也很累，但是还是记录一下吧

过滤器：顾名思义，就是能起到过滤作用的工具。它能对HttpServletrequest、HttpServletresponse进行操作，一般可以在过滤器里面进行字符的转换。

拦截器：拦截一些特殊的请求，并进行相应的操作。我们可以用它来做权限控制。

过滤器的实现：它的实现有两种方式，一种是注解、一种是代码实现

注解方式，最基本的过滤器实现是非常简单的，只需要新建一个filter类去实现filter接口，并在类上加@Component注解即可完成，这种简单方式实现的过滤器它的配置都是缺省的配置，过滤器起作用的路径是 /* 。

实现filter接口会重写三个方法，过滤器出生、过滤器所进行的操作与过滤器的死亡这三个方法。

@Component

public class TestFilter1 implements Filter {

    
    @Override
    public void destroy() {
        // TODO Auto-generated method stub
        System.out.println("过滤器摧毁");
    }

    
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
            throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;
        System.out.printf("测试1执行前");
        response.getOutputStream().write("测试1执行".getBytes());
        
        filterChain.doFilter(request, response);
        System.out.printf("测试1执行后");
    }

    
    @Override
    public void init(FilterConfig arg0) throws ServletException {
        // TODO Auto-generated method stub
        System.out.println("过滤器1生成");
    }

}

当然单纯的只有一个@Component注解这的太不像话，另一个注解@WebFilter：urlPatterns 指定起作用的url路径，filterName命名过滤器。@Order ：当有多个过滤器执行的时候，此注解可以指定执行顺序。

我们再写一个相同的filter类继承filter接口


//@Component
//@Order(1)
//@WebFilter(urlPatterns = "/hi/**", filterName = "Test1")
public class TestFilter2 implements Filter {

    
    @Override
    public void destroy() {
        // TODO Auto-generated method stub
        System.out.println("过滤器摧毁");
    }

    
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
            throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;
        System.out.printf("测试2执行前");
        response.getOutputStream().write("测试2执行".getBytes());
        
        filterChain.doFilter(request, response);
        System.out.printf("测试2执行后");
    }

    @Override
    public void init(FilterConfig arg0) throws ServletException {
        // TODO Auto-generated method stub
        System.out.println("过滤器2生成");
    }

}

将两个过滤器的urlPatterns的值指定到同一个路径，这样我们就能测试@Order注解的作用。测试结果是：当其值越大，执行顺序月靠后（自然数）。

代码方式：代码方式主要分为三部分。
一是创建自己的filter类实现filter接口。
二是注册filterbean。
三是设置参数

filter类在上面用注解方式实现时用到的filter类可以共用，不需要再重新创建（只需要删除类上面的注解即可）
在启动类里面的代码如下

@Bean
    public FilterRegistrationBean FilterRegistrationBean() {
        FilterRegistrationBean frtb = new FilterRegistrationBean();
        //TestFilter1 tf = new TestFilter1();
        TestFilter2 tf = new TestFilter2();
        frtb.setFilter(tf);
        frtb.addUrlPatterns("/hi/*");
        frtb.setName("test2");
        frtb.setOrder(1);
        return frtb;
    }

其中addUrlPatterns()方法是添加单独的一个过滤路径，若是使用多个，可创建一个集合list来存储多个路径，使用setUrlPatterns（）进行添加，非常方便。setOrder()方法可以指定过滤器执行顺序。最后执行一下访问，可以查看一下执行顺序。

image.png

再说一下拦截器的实现。也是分三步：
一是创建TestInterceptor 实现 HandlerInterceptor接口。
二是MVC的配置适配器
三是实例化我们自定义的拦截器，然后将对像手动添加到拦截器链中

代码如下：
创建TestInterceptor

public class TestInterceptor implements HandlerInterceptor {

    @Override//在DispatcherServlet完全处理完请求之后被调用，可用于清理资源 
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object oobj, Exception exce)
            throws Exception {
        String host = request.getHeader("Host");
                System.out.println(host+"拦截器1流程走完了");
    }

    @Override// 在业务处理器处理请求完成之后，生成视图之前执行  
    public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
            throws Exception {
        System.out.println("拦截器1可以对视图进一步操作..");
        
    }

    @Override//// 在业务处理器处理请求完成之前执行
    public boolean preHandle(HttpServletRequest request, HttpServletResponse arg1, Object arg2) throws Exception {
        String host = request.getHeader("Host");
        if(host!="localhost"){
            host="localhost";
        }
        System.out.println(host+"拦截器1马上进入请求处理");
        return true;
    }

}

在启动类（或者自己新创建一个类）继承WebMvcConfigurerAdapter，并重写 addInterceptors 方法。
启动类中代码

 //mvc控制器
    @Configuration
    static class WebMvcConfigurer extends WebMvcConfigurerAdapter{
        //增加拦截器
        public void addInterceptors(InterceptorRegistry registry){
            registry.addInterceptor(new TestInterceptor())    //指定拦截器类
                    .addPathPatterns("/hi/*");        //指定该类拦截的url
            registry.addInterceptor(new TestInterceptor2()).addPathPatterns("/hi/*");
            super.addInterceptors(registry);
            
        }
    }

代码完成后启动测试，结果如下：

image.png

有的文章上写到需要加上@ServletComponentScan此注解来识别@WebServlet、@WebFilter、@WebListener。其实不需要的，启动类放在代码包的上一层即可。