spring Filter 设置执行顺序

转载

锦绣前程未央 2024-09-06 15:47:53

文章标签 Filter java xml web服务器 文章分类 架构后端开发

一、Filter简介
　　Filter也称之为过滤器，它是Servlet技术中最激动人心的技术之一，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态html文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。
　　Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。通过Filter 技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截，Filter接口源代码：

1. public abstract interface
2. public abstract void init(FilterConfig paramFilterConfig) throws
3. public abstract void
4. throws
5. public abstract void
6. }

二、Filter是如何实现拦截的？(Filter的工作原理)

　　Filter接口中有一个doFilter方法，当我们编写好Filter，并配置对哪个web资源进行拦截后，WEB服务器每次在调用web资源的service方法之前，都会先调用一下filter的doFilter方法，因此，在该方法内编写代码可达到如下目的：

调用目标资源之前，让一段代码执行。

是否调用目标资源（即是否让用户访问web资源）。

调用目标资源之后，让一段代码执行。

　　web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对象，它也提供了一个 doFilter方法，开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方法，即web资源就会被访问，否则web资源不会被访问。

三、Filter开发流程

3.1、Filter开发步骤

Filter开发分为2步：

* 编写java类实现Filter接口，并实现其doFilter方法。

* 在web.xml 文件中使用<filter>和<filter-mapping>元素对编写的filter类进行注册，并设置它所能拦截的资源。

过滤器范例：

1. import
2. import
3. import
4. import
5. import
6. import
7. import
8. /**
9.  * @author yangcq
10.  * @description 过滤器Filter的工作原理
11.  */
12. public class FilterTest implements
13.   
14. public void
15. "----Filter销毁----");  
16.     }  
17.   
18. public void doFilter(ServletRequest request, ServletResponse response,FilterChain filterChain) throws
19. // 对request、response进行一些预处理
20. "UTF-8");  
21. "UTF-8");  
22. "text/html;charset=UTF-8");  
23. "----调用service之前执行一段代码----");  
24. // 执行目标资源，放行
25. "----调用service之后执行一段代码----");  
26.     }  
27.   
28. public void init(FilterConfig arg0) throws
29. "----Filter初始化----");  
30.     }

}

在web. xml中配置过滤器：

1. <?xml version="1.0" encoding="UTF-8"?>
2. <web-app version="3.0"
3. xmlns="http://java.sun.com/xml/ns/javaee"
4. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5. xsi:schemaLocation="http://java.sun.com/xml/ns/javaee   
6. >
7. <display-name></display-name>
8. <welcome-file-list>
9. <welcome-file>index.jsp</welcome-file>
10. </welcome-file-list>
11. <!--配置过滤器-->
12. <filter>
13. <filter-name>FilterTest</filter-name>
14. <filter-class>com.yangcq.filter.FilterTest</filter-class>
15. </filter>
16. <!--映射过滤器-->
17. <filter-mapping>
18. <filter-name>FilterTest</filter-name>
19. <!--“/*”表示拦截所有的请求 -->
20. <url-pattern>/*</url-pattern>
21. </filter-mapping>
22. </web-app>

3.2、Filter链

　　在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。web服务器根据Filter在web.xml文件中的注册顺序，决定先调用哪个Filter，当第一个Filter的doFilter方法被调用时，web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter 方法中，开发人员如果调用了FilterChain对象的doFilter方法，则web服务器会检查FilterChain对象中是否还有filter，如果有，则调用第2个filter，如果没有，则调用目标资源。

四，Spring框架下，过滤器的配置

如果项目中使用了Spring框架，那么，很多过滤器都不用自己来写了，Spring为我们写好了一些常用的过滤器。下面我们就以字符编码的

过滤器CharacterEncodingFilter为例，来看一下Spring框架下，如果配置过滤器。

1. <filter>
2. <filter-name>encodingFilter</filter-name>
3. <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
4. <init-param>
5. <param-name>encoding</param-name>
6. <param-value>UTF-8</param-value>
7. </init-param>
8. <init-param>
9. <param-name>forceEncoding</param-name>
10. <param-value>true</param-value>
11. </init-param>
12. </filter>
13.   
14. <filter-mapping>
15. <filter-name>encodingFilter</filter-name>
16. <url-pattern>/*</url-pattern>
17. </filter-mapping>

很简单吧，这样几行配置代码，就完成了从全局控制字符编码的功能。接下来，我们看一下CharacterEncodingFilter这个过滤器的关键代码，感受一下，大师的风采，如果我们写过滤器的话，可以以此为范例。

1. package
2. import
3. import
4. import
5. import
6. import
7. import
8. public class CharacterEncodingFilter extends
9. private static final boolean
10. class$javax$servlet$http$HttpServletResponse, "setCharacterEncoding", new Class[] { String.class
11. // 需要设置的编码方式，为了支持可配置，Spring把编码方式设置成了一个变量
12. private
13. // 是否强制使用统一编码，也是为了支持可配置
14. private boolean
15. // 构造器，在这里，Spring把forceEncoding的值默认设置成了false
16. public
17. this.forceEncoding = false;  
18.     }  
19. // encoding/forceEncoding的setter方法
20. public void
21. this.encoding = encoding;  
22.     }  
23. public void setForceEncoding(boolean
24. this.forceEncoding = forceEncoding;  
25.     }  
26. // Spring通过GenericFilterBean抽象类，对Filter接口进行了整合，
27. protected void
28. throws
29. if ((this.encoding != null) && (((this.forceEncoding) || (request.getCharacterEncoding() == null)))) {  
30. this.encoding);  
31. if ((this.forceEncoding) && (responseSetCharacterEncodingAvailable)) {  
32. this.encoding);  
33.             }  
34.         }  
35.         filterChain.doFilter(request, response);  
36.     }  
37. }

GenericFilterBean类：

public abstract class GenericFilterBean implements Filter, BeanNameAware, ServletContextAware, InitializingBean, DisposableBean

还没有过瘾，那就再看一个项目中使用过的一个过滤器：InvilidCharacterFilter（防止脚本攻击的过滤器）

1. import
2. import
3. import
4. import
5. import
6. import
7. import
8. import
9. import
10. /*
11.  * InvalidCharacterFilter：过滤request请求中的非法字符，防止脚本攻击
12.  * InvalidCharacterFilter继承了Spring框架的CharacterEncodingFilter过滤器，当然，我们也可以自己实现这样一个过滤器
13.  */
14. public class InvalidCharacterFilter extends
15. // 需要过滤的非法字符
16. private static String[] invalidCharacter = new
17. "script","select","insert","document","window","function",  
18. "delete","update","prompt","alert","create","alter",  
19. "drop","iframe","link","where","replace","function","onabort",  
20. "onactivate","onafterprint","onafterupdate","onbeforeactivate",  
21. "onbeforecopy","onbeforecut","onbeforedeactivateonfocus",  
22. "onkeydown","onkeypress","onkeyup","onload",  
23. "expression","applet","layer","ilayeditfocus","onbeforepaste",  
24. "onbeforeprint","onbeforeunload","onbeforeupdate",  
25. "onblur","onbounce","oncellchange","oncontextmenu",  
26. "oncontrolselect","oncopy","oncut","ondataavailable",  
27. "ondatasetchanged","ondatasetcomplete","ondeactivate",  
28. "ondrag","ondrop","onerror","onfilterchange","onfinish","onhelp",  
29. "onlayoutcomplete","onlosecapture","onmouse","ote",  
30. "onpropertychange","onreadystatechange","onreset","onresize",  
31. "onresizeend","onresizestart","onrow","onscroll",  
32. "onselect","onstaronsubmit","onunload","IMgsrc","infarction"
33.     };  
34.   
35. protected void
36. throws
37. null;  
38. null;  
39. // 获取请求的参数
40. @SuppressWarnings("unchecked")  
41.         Enumeration<String> allParameter = request.getParameterNames();  
42. while(allParameter.hasMoreElements()){  
43.             parameterName = allParameter.nextElement();  
44.             parameterValue = request.getParameter(parameterName);  
45. if(null
46. for(String str : invalidCharacter){  
47. if
48. "errorMessage", "非法字符："
49. "/error.jsp");  
50.                         requestDispatcher.forward(request, response);  
51. return;  
52.                     }  
53.                 }  
54.             }  
55.         }  
56. super.doFilterInternal(request, response, filterChain);  
57.     }  
58. }

接下来需要在web.xml中进行配置：

1. <filter>
2. <filter-name>InvalidCharacterFilter</filter-name>
3. <filter-class>com.yangcq.filter.InvalidCharacterFilter</filter-class>
4. </filter>
5. <filter-mapping>
6. <filter-name>InvalidCharacterFilter</filter-name>
7. <url-pattern>/*</url-pattern>
8. </filter-mapping>

如果我们不使用Spring的CharacterEncodingFilter类，可以自己来写。

1. import
2. import
3. import
4. import
5. import
6. import
7. import
8. import
9. import
10. import
11. /**
12.  * SelfDefineInvalidCharacterFilter：过滤request请求中的非法字符，防止脚本攻击
13.  */
14. public class SelfDefineInvalidCharacterFilter implements
15.   
16. public void
17.           
18.     }  
19.   
20. public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws
21. null;  
22. null;  
23. // 获取请求的参数
24. @SuppressWarnings("unchecked")  
25.         Enumeration<String> allParameter = request.getParameterNames();  
26. while(allParameter.hasMoreElements()){  
27.             parameterName = allParameter.nextElement();  
28.             parameterValue = request.getParameter(parameterName);  
29. if(null
30. for(String str : invalidCharacter){  
31. if
32. "errorMessage", "非法字符："
33. "/error.jsp");  
34.                         requestDispatcher.forward(request, response);  
35. return;  
36.                     }  
37.                 }  
38.             }  
39.         }  
40. // 执行目标资源，放行
41.     }  
42.   
43. public void init(FilterConfig filterConfig) throws
44.

1. public abstract interface
2. public abstract void init(FilterConfig paramFilterConfig) throws
3. public abstract void
4. throws
5. public abstract void
6. }