拦截器（Interceptor）与过滤器（Filter）

目录

• 用户的普通Http请求执行顺序
• 过滤器、拦截器添加后的执行顺序
• 拦截器（Interceptor）的基本定义
• 拦截器（Interceptor）必须实现的三个方法
• 单个拦截器（Interceptor）的Demo实现
• 拦截器（Interceptor）的两种配置方式
• 过滤器（Filter）的基本定义
• 过滤器（Filter）必须实现的三个方法
• 单个过滤器（Filter）的Demo实现
• 过滤器（Filter）的三种配置方式
• 通过@WebFilter注解配置
• 通过@Bean来配置
• Spring MVC在web.xml配置
• 拦截器和过滤器的区别
• 拦截器和过滤器的作用/用途
• 总结
• 参考文献

一、用户的普通Http请求执行顺序

二、过滤器、拦截器添加后的执行顺序

三、拦截器（Interceptor）的基本定义

　　拦截器是面向切面（AOP）编程中应用的一种统一处理方案，就是在你的Controller、Servie或者一个Method调用一个Method，或者在Method调用一个Method之后，统一的进行处理的方案，基于Java的反射机制。

　　拦截器，在AOP（Aspect-Oriented Programming）中可以用于在某个方法或者字段被访问之前，进行拦截，然后在之前或者之后加入某些统一的处理方法。拦截是AOP的一种具象的实现方式。

　　拦截器将很多service或者Controller中共有的行为提炼出来，在某些方法执行的前后执行，提炼为通用的处理方式，让被拦截的方法都能享受这一共有的功能，让代码更加简洁，同时，当共有的功能需要发生调整、变动的时候，不必修改很多的类或者方法，只要修改这个拦截器就可以了，可复用性很强。

　　Spring MVC 中的Interceptor拦截请求是通过HandlerInterceptor来实现的。

四、拦截器（Interceptor）必须实现的三个方法

　　1）总览

　　2）preHandle（HttpServletRequest request， HttpServletResponse response， Object handle）方法

　　　　该方法将在请求处理之前进行调用。SpringMVC 中的Interceptor 是链式的调用的，在一个应用中或者说是在一个请求中可以同时存在多个Interceptor 。每个Interceptor 的调用会依据它的声明顺序依次执行，而且最先执行的都是Interceptor 中的preHandle 方法，所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理，也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。该方法的返回值是布尔值Boolean类型的，当它返回为false 时，表示请求结束，后续的Interceptor 和Controller 都不会再执行；当返回值为true 时就会继续调用下一个Interceptor 的preHandle 方法，如果已经是最后一个Interceptor 的时候就会是调用当前请求的Controller 方法。

　　3)  postHandle (HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView) 方法  【前提：在当前所属的Interceptor 的preHandle 方法的返回值为true 时才能被调用】

　　　　在当前请求进行处理之后，也就是Controller 方法调用之后执行，但是它会在DispatcherServlet 进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。postHandle 方法被调用的方向跟preHandle 是相反的，也就是说先声明的Interceptor 的postHandle 方法反而会后执行，这和Struts2 里面的Interceptor 的执行过程有点类型。Struts2 里面的Interceptor 的执行过程也是链式的，只是在Struts2 里面需要手动调用ActionInvocation 的invoke 方法来触发对下一个Interceptor 或者是Action 的调用，然后每一个Interceptor 中在invoke 方法调用之前的内容都是按照声明顺序执行的，而invoke 方法之后的内容就是反向的。　　

　　4）afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex）方法  【前提：在当前所属的Interceptor 的preHandle 方法的返回值为true 时才能被调用】

　　　　该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。　　

五、单个拦截器（Interceptor）的Demo实现

　　1）初始化拦截器

@Component
public class UserAccessInterceptor implements HandlerInterceptor {

    private final Logger logger = LoggerFactory.getLogger(UserAccessInterceptor.class);

    @Resource
    private UserService userService;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        //1.获取headers里的author-Cookie
　　　　 //2.根据cookie使用userService查找当前user
　　　　 //3.存在且激活 当前用户信息设置到ThreadLocal return true；
　　　　 //4.不存在 或 未激活 return false;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
　　　　
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        //销毁ThreadLocal的用户信息
    }

　　2）拦截器配置类

@Configuration
public class WebInterceptorConfig extends WebMvcConfigurationSupport {

    @Autowired
    private UserAccessInterceptor userAccessInterceptor;

　　//不拦截的URL集合
    private static List<String> exclusionUrlList=new ArrayList<>();

    static {
        exclusionUrlList.add("/favicon.ico");
        exclusionUrlList.add("/**/*.css");
        exclusionUrlList.add("/**/*.js");
        exclusionUrlList.add("/ok");
        exclusionUrlList.add("/");
        exclusionUrlList.add("/console/**");
        exclusionUrlList.add("/index");
    }

    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(this.userAccessInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns(exclusionUrlList);
        super.addInterceptors(registry);
    }

}

六、拦截器（Interceptor）的两种配置方式

　　1）同上 -> Demo实现

　　2）Spring MVC使用mvc:interceptors标签

<mvc:interceptors>
<!-- 使用bean定义一个Interceptor，直接定义在mvc:interceptors根下面的Interceptor将拦截所有的请求 -->
<bean class="com.baidu.interceptor.UserAccessInterceptor"/>
    <mvc:interceptor>
         <mvc:mapping path="/**"/>
         <mvc:exclude-mapping path="/parent/**"/>
         <bean class="com.baidu.interceptor.UserAccessInterceptor" />
    </mvc:interceptor>
</mvc:interceptors>

七、过滤器（Filter）的基本定义

　　Filter可以认为是Servlet的一种“加强版”，它主要用于对用户请求进行预处理，也可以对HttpServletResponse进行后处理，是个典型的处理链。Filter也可以对用户请求生成响应，这一点与Servlet相同，但实际上很少会使用Filter向用户请求生成响应。使用Filter完整的流程是：Filter对用户请求进行预处理，接着将请求交给Servlet进行处理并生成响应，最后Filter再对服务器响应进行后处理。

　　在Web中称之为Filter，通过配置多个过滤器，Web系统可以对所有的Servlet请求进行一层一层的过滤，以完成一些特殊的功能。例如常用的资源访问权限控制、特殊字符以及敏感词过滤、响应信息压缩等功能。

　　Servlet中的过滤器Filter是实现了javax.servlet.Filter接口的服务器端程序，主要的用途是设置字符集、控制权限、控制转向、做一些业务逻辑判断等。其工作原理是，只要你在web.xml文件配置好要拦截的客户端请求，它都会帮你拦截到请求，此时你就可以对请求或响应(Request、Response)统一设置编码，简化操作；同时还可进行逻辑判断，如用户是否已经登陆、有没有权限访问该页面等等工作。它是随你的web应用启动而启动的，只初始化一次，以后就可以拦截相关请求，只有当你的web应用停止或重新部署的时候才销毁。

八、过滤器（Filter）必须实现的三个方法

　　1）总览

　　2）default void init(FilterConfig filterConfig) throws ServletException {}

　　　　用于完成Filter的初始化。　　　　

　　3）void doFilter(ServletRequest var1, ServletResponse var2, FilterChain var3) throws IOException, ServletException;

　　　　实现过滤功能，该方法就是对每个请求及响应增加的额外处理。该方法可以实现对用户请求进行预处理(ServletRequest request)，也可实现对服务器响应进行后处理(ServletResponse response)—它们的分界线为是否调用了chain.doFilter(),执行该方法之前，即对用户请求进行预处理；执行该方法之后，即对服务器响应进行后处理。

　　4)  default void destroy() {}

　　　　用于Filter销毁前，完成某些资源的回收。

九、单个过滤器（Filter）的Demo实现

　　1）TestFilter初始化

public class TestFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("我是Filter,执行filterChain.doFilter(request,response)之前。");
        filterChain.doFilter(request,response);
        System.out.println("我是Filter,执行filterChain.doFilter(request,response)之后。");
    }

    @Override
    public void destroy() {

    }

　　2）Filter配置类

@Slf4j
@Configuration
public class TestFilterConfiguration {//不拦截路径
    private static List<String> exclusionUrlList=new ArrayList<>();
    //拦截路径
    private static List<String> inclusionUrlList=new ArrayList<>();

    static {
        exclusionUrlList.add("/favicon.ico");
        exclusionUrlList.add("/**/*.css");
        exclusionUrlList.add("/**/*.js");
        exclusionUrlList.add("/ok");
        inclusionUrlList.add("/api/**");
    }

    @Bean
    public FilterRegistrationBean filterRegistration() {
        FilterRegistrationBean<Filter> registration = new FilterRegistrationBean<>();
        registration.setFilter(new TestFilter());
        registration.addInitParameter(FILTER_INIT_PARAM_EXCLUSION_URLS,String.join(",", exclusionUrlList));
        registration.addInitParameter(AJAX_URL_PATTERNS,String.join(",", inclusionUrlList));
        registration.addUrlPatterns("/*");
        registration.setName("testFilter");
　　　　 return registration;
    }

}

十、过滤器（Filter）的三种配置方式

　　1）通过@WebFilter注解配置

1.初始化Filter

@WebFilter(urlPatterns = "/test001")
@Order(1) //order值越小，过滤器越靠前，此处配置无效
public class TestFilter implements Filter {
    @Override
    public void init(javax.servlet.FilterConfig filterConfig) throws ServletException {
        System.out.println("##############TestFilter init##############");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        //在DispatcherServlet之前执行
        System.out.println("##############doFilter before##############");
        filterChain.doFilter(servletRequest, servletResponse);
        // 在视图页面返回给客户端之前执行，但是执行顺序在Interceptor之后
        System.out.println("##############doFilter after##############");
    }

    @Override
    public void destroy() {
        System.out.println("##############TestFilter destroy##############");
    }
}

//2.在启动类添加 @ServletComponentScan

@SpringBootApplication 
@ServletComponentScan 
public class TestbootApplication { 
　　public static void main(String[] args) { 
　　　　SpringApplication.run(TestbootApplication.class, args); 
　　} 
}

　　2）通过@Bean来配置

//1.初始化Filter

@Component
public class TestFilter3 implements Filter{
    @Override
    public void init(javax.servlet.FilterConfig filterConfig) throws ServletException {
        System.out.println("##############Filter3 init##############");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        //在DispatcherServlet之前执行
        System.out.println("##############doFilter3 before##############");
        filterChain.doFilter(servletRequest, servletResponse);
        // 在视图页面返回给客户端之前执行，但是执行顺序在Interceptor之后
        System.out.println("##############doFilter3 after##############");
    }

    @Override
    public void destroy() {
        System.out.println("##############Filter3 destroy##############");
    }
}

//2.注册到config

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean testFilter3RegistrationBean() {
        FilterRegistrationBean registration = new FilterRegistrationBean(new TestFilter3());
        registration.addUrlPatterns("/hello");
        registration.setOrder(1); // 值越小越靠前，此处配置有效
        return registration;
    }

    @Bean
    public FilterRegistrationBean testFilter4RegistrationBean() {
        FilterRegistrationBean registration = new FilterRegistrationBean(new TestFilter4());
        registration.addUrlPatterns("/hello");
        registration.setOrder(2);
        return registration;
    }
}

　　3）Spring MVC在web.xml进行配置

　　　　1.初始化Filter

　　　　2.web.xml文件中配置Filter

<filter>
    <filter-name>CharacterEncodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
    <init-param>
        <param-name>forceEncoding</param-name>
        <param-value>true</param-value>
    </init-param>
</filter>

<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

十一、拦截器和过滤器的区别

十二、拦截器和过滤器的作用/用途

　　过滤器用途：用于设置字符编码、URL级别的权限控制，敏感词汇的过滤

　　拦截器用途：拦截未登录的用户，拦截器和过滤器的功能相近

十三、总结

　　1.过滤器：所谓过滤器顾名思义是用来过滤的，在java web中，你传入的request,response提前过滤掉一些信息，或者提前设置一些参数，然后再传入servlet或者struts的action进行业务逻辑，比如过滤掉非法url（不是login.do的地址请求，如果用户没有登陆都过滤掉）,或者在传入servlet或者struts的action前统一设置字符集，或者去除掉一些非法字符（聊天室经常用到的，一些骂人的话）。filter 流程是线性的， url传来之后，检查之后，可保持原来的流程继续向下执行，被下一个filter, servlet接收等.

　　2.java的拦截器 主要是用在插件上，扩展件上比如 hibernate spring struts2等 有点类似面向切片的技术，在用之前先要在配置文件即xml文件里声明一段的那个东西。

十四、参考文献

1. https://www.cnblogs.com/panxuejun/p/7715917.html《过滤器（Filter）和拦截器（Interceptor）的执行顺序和区别》
2. https://www.cnblogs.com/junzi2099/p/8022058.html《过滤器（Filter）与拦截器（Interceptor )区别》
3. https://blog.csdn.net/qq_34908167/article/details/80624507《过滤器和拦截器的区别和执行顺序》
4. https://www.cnblogs.com/feibazhf/p/11265145.html《过滤器、拦截器和监听器区别》