基于SpringMVC的拦截器（Interceptor）和过滤器（Filter）的区别与联系

时间 2019-11-06

标签基于 springmvc 拦截 interceptor 过滤器 filter 区别联系栏目 Spring 繁體版

原文原文链接

2016/10/07 | Spring | admin| 5 条评论 | 1587 viewshtml

一简介

（1）过滤器：java

依赖于servlet容器。在实现上基于函数回调，能够对几乎全部请求进行过滤，可是缺点是一个过滤器实例只能在容器初始化时调用一次。使用过滤器的目的是用来作一些过滤操做，获取咱们想要获取的数据，好比：在过滤器中修改字符编码；在过滤器中修改HttpServletRequest的一些参数，包括：过滤低俗文字、危险字符等web

关于过滤器的一些用法能够参考我写过的这些文章：spring

继承HttpServletRequestWrapper以实如今Filter中修改HttpServletRequest的参数：https://www.zifangsky.cn/677.html
在SpringMVC中使用过滤器（Filter）过滤容易引起XSS的危险字符：https://www.zifangsky.cn/683.html

（2）拦截器：编程

依赖于web框架，在SpringMVC中就是依赖于SpringMVC框架。在实现上基于Java的反射机制，属于面向切面编程（AOP）的一种运用。因为拦截器是基于web框架的调用，所以可使用Spring的依赖注入（DI）进行一些业务操做，同时一个拦截器实例在一个controller生命周期以内能够屡次调用。可是缺点是只能对controller请求进行拦截，对其余的一些好比直接访问静态资源的请求则没办法进行拦截处理mvc

关于过滤器的一些用法能够参考我写过的这些文章：app

在SpringMVC中使用拦截器（interceptor）拦截CSRF攻击（修）：https://www.zifangsky.cn/671.html
SpringMVC中使用Interceptor+Cookie实如今必定天数以内自动登陆：https://www.zifangsky.cn/700.html

二多个过滤器与拦截器的代码执行顺序

若是在一个项目中仅仅只有一个拦截器或者过滤器，那么我相信相对来讲理解起来是比较容易的。可是咱们是否思考过：若是一个项目中有多个拦截器或者过滤器，那么它们的执行顺序应该是什么样的？或者再复杂点，一个项目中既有多个拦截器，又有多个过滤器，这时它们的执行顺序又是什么样的呢？框架

下面我将用简单的代码来测试说明：jsp

（1）先定义两个过滤器：函数

i）过滤器1：

package cn.zifangsky.filter;

import java.io.IOException;

import javax.servlet.FilterChain;

import javax.servlet.ServletException;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.springframework.web.filter.OncePerRequestFilter;

public class TestFilter1 extends OncePerRequestFilter {

protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)

throws ServletException, IOException {

//在DispatcherServlet以前执行

System.out.println("############TestFilter1 doFilterInternal executed############");

filterChain.doFilter(request, response);

//在视图页面返回给客户端以前执行，可是执行顺序在Interceptor以后

System.out.println("############TestFilter1 doFilter after############");

// try {

// Thread.sleep(10000);

// } catch (InterruptedException e) {

// e.printStackTrace();

// }

}

ii）过滤器2：

package cn.zifangsky.filter;

import java.io.IOException;

import javax.servlet.FilterChain;

import javax.servlet.ServletException;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.springframework.web.filter.OncePerRequestFilter;

public class TestFilter2 extends OncePerRequestFilter {

protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)

throws ServletException, IOException {

System.out.println("############TestFilter2 doFilterInternal executed############");

filterChain.doFilter(request, response);

System.out.println("############TestFilter2 doFilter after############");

}

iii）在web.xml中注册这两个过滤器：

<filter-name>testFilter1</filter-name>

<filter-class>cn.zifangsky.filter.TestFilter1</filter-class>

</filter>

<filter-mapping>

<filter-name>testFilter1</filter-name>

<url-pattern>/*</url-pattern>

</filter-mapping>

<filter-name>testFilter2</filter-name>

<filter-class>cn.zifangsky.filter.TestFilter2</filter-class>

</filter>

<filter-mapping>

<filter-name>testFilter2</filter-name>

<url-pattern>/*</url-pattern>

</filter-mapping>

（2）再定义两个拦截器：

i）拦截器1，基本拦截器：

package cn.zifangsky.interceptor;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.HandlerInterceptor;

import org.springframework.web.servlet.ModelAndView;

public class BaseInterceptor implements HandlerInterceptor{

/**

* 在DispatcherServlet以前执行

* */

public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {

System.out.println("************BaseInterceptor preHandle executed**********");

return true;

}

/**

* 在controller执行以后的DispatcherServlet以后执行

* */

public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)

throws Exception {

System.out.println("************BaseInterceptor postHandle executed**********");

}

/**

* 在页面渲染完成返回给客户端以前执行

* */

public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)

throws Exception {

System.out.println("************BaseInterceptor afterCompletion executed**********");

// Thread.sleep(10000);

}

ii）指定controller请求的拦截器：

package cn.zifangsky.interceptor;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.HandlerInterceptor;

import org.springframework.web.servlet.ModelAndView;

public class TestInterceptor implements HandlerInterceptor {

public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {

System.out.println("************TestInterceptor preHandle executed**********");

return true;

}

public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)

throws Exception {

System.out.println("************TestInterceptor postHandle executed**********");

}

public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)

throws Exception {

System.out.println("************TestInterceptor afterCompletion executed**********");

}

iii）在SpringMVC的配置文件中注册这两个拦截器：

<mvc:interceptors>

<mvc:interceptor>

<mvc:mapping path="/test.html"/>

</mvc:interceptor>

</mvc:interceptors>

（3）定义一个测试使用的controller：

package cn.zifangsky.controller;

import org.springframework.stereotype.Controller;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.servlet.ModelAndView;

@Controller

public class TestController {

@RequestMapping("/test.html")

public ModelAndView handleRequest(){

System.out.println("---------TestController executed--------");

return new ModelAndView("test");

}

（4）视图页面test.jsp：

<%@ page language="java" contentType="text/html; charset=UTF-8"

pageEncoding="UTF-8"%>

String path = request.getContextPath();

String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";

<html>

<head>

<title>FilterDemo</title>

</head>

<body>

System.out.println("test.jsp is loading");

This is test page

</div>

</body>

</html>

（5）测试效果：

启动此测试项目，能够看到控制台中输出以下：

这就说明了过滤器的运行是依赖于servlet容器的，跟springmvc等框架并无关系。而且，多个过滤器的执行顺序跟xml文件中定义的前后关系有关

接着清空控制台中的输出内容并访问：http://localhost:9180/FilterDemo/test.html

能够看到，此时的控制台输出结果以下：

相信从这个打印输出，你们就能够很清晰地看到有多个拦截器和过滤器存在时的整个执行顺序了。固然，对于过个拦截器它们之间的执行顺序跟在SpringMVC的配置文件中定义的前后顺序有关

注：对于整个SpringMVC的执行流程来讲，若是加上上面的拦截器和过滤器，其最终的执行流程就以下图所示：

PS：这个图是我用画图软件画出来的，将就着看吧^_^

参考：

《Spring实战（第4版）》第5章

基于SpringMVC的拦截器（Interceptor）和过滤器（Filter）的区别与联系

一 简介

二 多个过滤器与拦截器的代码执行顺序

一简介

二多个过滤器与拦截器的代码执行顺序