一、Filter简介
Filter也称之为过滤器,它是Servlet技术中最激动人心的技术之一,WEB开发人员通过Filter技术,对web服务器管理的所有web资源:例如Jsp, Servlet, 静态图片文件或静态html文件等进行拦截,从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等 一些高级功能。
Servlet API中提供了一个Filter接口,开发web应用时,如果编写的Java类实现了这个接口,则把这个java类称之为过滤器Filter。通过Filter 技术,开发人员可以实现用户在访问某个目标资源之前,对访问的请求和响应进行拦截,Filter接口源代码:
二、Filter是如何实现拦截的?(Filter的工作原理)
Filter接口中有一个doFilter方法,当我们编写好Filter,并配置对哪个web资源进行拦截后,WEB服务器每次在调用web资源的service方法之前, 都会先调用一下filter的doFilter方法,因此,在该方法内编写代码可达到如下目的:
调用目标资源之前,让一段代码执行。
是否调用目标资源(即是否让用户访问web资源)。
调用目标资源之后,让一段代码执行。
web服务器在调用doFilter方法时,会传递一个filterChain对象进来,filterChain对象是filter接口中最重要的一个对象,它也提供了一个 doFilter方法,开发人员可以根据需求决定是否调用此方法,调用该方法,则web服务器就会调用web资源的service方法,即web资源就会被访问, 否则web资源不会被访问。
Filter开发分为2步:
* 编写java类实现Filter接口,并实现其doFilter方法。
* 在web.xml 文件中使用<filter>和<filter-mapping>元素对编写的filter类进行注册,并设置它所能拦截的资源。
在web. xml中配置过滤器:
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框架下,如果配置过滤器。
很简单吧,这样几行配置代码,就完成了从全局控制字符编码的功能。接下来,我们看一下CharacterEncodingFilter这个过滤器的关键代码,感受
一下,大师的风采,如果我们写过滤器的话,可以以此为范例。
GenericFilterBean类:
public abstract class GenericFilterBean implements Filter, BeanNameAware, ServletContextAware, InitializingBean, DisposableBean
还没有过瘾,那就再看一个项目中使用过的一个过滤器:InvilidCharacterFilter(防止脚本攻击的过滤器)
如果我们不使用Spring的CharacterEncodingFilter类,可以自己来写。
Filter也称之为过滤器,它是Servlet技术中最激动人心的技术之一,WEB开发人员通过Filter技术,对web服务器管理的所有web资源:例如Jsp, Servlet, 静态图片文件或静态html文件等进行拦截,从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等 一些高级功能。
Servlet API中提供了一个Filter接口,开发web应用时,如果编写的Java类实现了这个接口,则把这个java类称之为过滤器Filter。通过Filter 技术,开发人员可以实现用户在访问某个目标资源之前,对访问的请求和响应进行拦截,Filter接口源代码:
- public abstract interface Filter{
- public abstract void init(FilterConfig paramFilterConfig) throws ServletException;
- public abstract void doFilter(ServletRequest paramServletRequest, ServletResponse paramServletResponse, FilterChain
- paramFilterChain) throws IOException, ServletException;
- public abstract void destroy();
- }
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类进行注册,并设置它所能拦截的资源。
过滤器范例:
- import java.io.IOException;
- import javax.servlet.Filter;
- import javax.servlet.FilterChain;
- import javax.servlet.FilterConfig;
- import javax.servlet.ServletException;
- import javax.servlet.ServletRequest;
- import javax.servlet.ServletResponse;
- /**
- * @author yangcq
- * @description 过滤器Filter的工作原理
- */
- public class FilterTest implements Filter{
- public void destroy() {
- System.out.println("----Filter销毁----");
- }
- public void doFilter(ServletRequest request, ServletResponse response,FilterChain filterChain) throws IOException, ServletException {
- // 对request、response进行一些预处理
- request.setCharacterEncoding("UTF-8");
- response.setCharacterEncoding("UTF-8");
- response.setContentType("text/html;charset=UTF-8");
- System.out.println("----调用service之前执行一段代码----");
- filterChain.doFilter(request, response); // 执行目标资源,放行
- System.out.println("----调用service之后执行一段代码----");
- }
- public void init(FilterConfig arg0) throws ServletException {
- System.out.println("----Filter初始化----");
- }
- }
- <?xml version="1.0" encoding="UTF-8"?>
- <web-app version="3.0"
- xmlns="http://java.sun.com/xml/ns/javaee"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
- http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
- <display-name></display-name>
- <welcome-file-list>
- <welcome-file>index.jsp</welcome-file>
- </welcome-file-list>
- <!--配置过滤器-->
- <filter>
- <filter-name>FilterTest</filter-name>
- <filter-class>com.yangcq.filter.FilterTest</filter-class>
- </filter>
- <!--映射过滤器-->
- <filter-mapping>
- <filter-name>FilterTest</filter-name>
- <!--“/*”表示拦截所有的请求 -->
- <url-pattern>/*</url-pattern>
- </filter-mapping>
- </web-app>
在一个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框架下,如果配置过滤器。
- <filter>
- <filter-name>encodingFilter</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>encodingFilter</filter-name>
- <url-pattern>/*</url-pattern>
- </filter-mapping>
- package org.springframework.web.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.util.ClassUtils;
- public class CharacterEncodingFilter extends OncePerRequestFilter{
- private static final boolean responseSetCharacterEncodingAvailable = ClassUtils.hasMethod(
- class$javax$servlet$http$HttpServletResponse, "setCharacterEncoding", new Class[] { String.class });
- // 需要设置的编码方式,为了支持可配置,Spring把编码方式设置成了一个变量
- private String encoding;
- // 是否强制使用统一编码,也是为了支持可配置
- private boolean forceEncoding;
- // 构造器,在这里,Spring把forceEncoding的值默认设置成了false
- public CharacterEncodingFilter(){
- this.forceEncoding = false;
- }
- // encoding/forceEncoding的setter方法
- public void setEncoding(String encoding){
- this.encoding = encoding;
- }
- public void setForceEncoding(boolean forceEncoding){
- this.forceEncoding = forceEncoding;
- }
- // Spring通过GenericFilterBean抽象类,对Filter接口进行了整合,
- protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
- throws ServletException, IOException{
- if ((this.encoding != null) && (((this.forceEncoding) || (request.getCharacterEncoding() == null)))) {
- request.setCharacterEncoding(this.encoding);
- if ((this.forceEncoding) && (responseSetCharacterEncodingAvailable)) {
- response.setCharacterEncoding(this.encoding);
- }
- }
- filterChain.doFilter(request, response);
- }
- }
public abstract class GenericFilterBean implements Filter, BeanNameAware, ServletContextAware, InitializingBean, DisposableBean
还没有过瘾,那就再看一个项目中使用过的一个过滤器:InvilidCharacterFilter(防止脚本攻击的过滤器)
- import java.io.IOException;
- import java.util.Enumeration;
- import javax.servlet.FilterChain;
- import javax.servlet.RequestDispatcher;
- import javax.servlet.ServletException;
- import javax.servlet.http.HttpServletRequest;
- import javax.servlet.http.HttpServletResponse;
- import org.apache.commons.lang.StringUtils;
- import org.springframework.web.filter.CharacterEncodingFilter;
- /*
- * InvalidCharacterFilter:过滤request请求中的非法字符,防止脚本攻击
- * InvalidCharacterFilter继承了Spring框架的CharacterEncodingFilter过滤器,当然,我们也可以自己实现这样一个过滤器
- */
- public class InvalidCharacterFilter extends CharacterEncodingFilter{
- // 需要过滤的非法字符
- private static String[] invalidCharacter = new String[]{
- "script","select","insert","document","window","function",
- "delete","update","prompt","alert","create","alter",
- "drop","iframe","link","where","replace","function","onabort",
- "onactivate","onafterprint","onafterupdate","onbeforeactivate",
- "onbeforecopy","onbeforecut","onbeforedeactivateonfocus",
- "onkeydown","onkeypress","onkeyup","onload",
- "expression","applet","layer","ilayeditfocus","onbeforepaste",
- "onbeforeprint","onbeforeunload","onbeforeupdate",
- "onblur","onbounce","oncellchange","oncontextmenu",
- "oncontrolselect","oncopy","oncut","ondataavailable",
- "ondatasetchanged","ondatasetcomplete","ondeactivate",
- "ondrag","ondrop","onerror","onfilterchange","onfinish","onhelp",
- "onlayoutcomplete","onlosecapture","onmouse","ote",
- "onpropertychange","onreadystatechange","onreset","onresize",
- "onresizeend","onresizestart","onrow","onscroll",
- "onselect","onstaronsubmit","onunload","IMgsrc","infarction"
- };
- protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
- throws ServletException, IOException{
- String parameterName = null;
- String parameterValue = null;
- // 获取请求的参数
- @SuppressWarnings("unchecked")
- Enumeration<String> allParameter = request.getParameterNames();
- while(allParameter.hasMoreElements()){
- parameterName = allParameter.nextElement();
- parameterValue = request.getParameter(parameterName);
- if(null != parameterValue){
- for(String str : invalidCharacter){
- if (StringUtils.containsIgnoreCase(parameterValue, str)){
- request.setAttribute("errorMessage", "非法字符:" + str);
- RequestDispatcher requestDispatcher = request.getRequestDispatcher("/error.jsp");
- requestDispatcher.forward(request, response);
- return;
- }
- }
- }
- }
- super.doFilterInternal(request, response, filterChain);
- }
- }
接下来需要在web.xml中进行配置:
- <filter>
- <filter-name>InvalidCharacterFilter</filter-name>
- <filter-class>com.yangcq.filter.InvalidCharacterFilter</filter-class>
- </filter>
- <filter-mapping>
- <filter-name>InvalidCharacterFilter</filter-name>
- <url-pattern>/*</url-pattern>
- </filter-mapping>
- import java.io.IOException;
- import java.util.Enumeration;
- import javax.servlet.Filter;
- import javax.servlet.FilterChain;
- import javax.servlet.FilterConfig;
- import javax.servlet.RequestDispatcher;
- import javax.servlet.ServletException;
- import javax.servlet.ServletRequest;
- import javax.servlet.ServletResponse;
- import org.apache.commons.lang.StringUtils;
- /**
- * SelfDefineInvalidCharacterFilter:过滤request请求中的非法字符,防止脚本攻击
- */
- public class SelfDefineInvalidCharacterFilter implements Filter{
- public void destroy() {
- }
- public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws IOException, ServletException {
- String parameterName = null;
- String parameterValue = null;
- // 获取请求的参数
- @SuppressWarnings("unchecked")
- Enumeration<String> allParameter = request.getParameterNames();
- while(allParameter.hasMoreElements()){
- parameterName = allParameter.nextElement();
- parameterValue = request.getParameter(parameterName);
- if(null != parameterValue){
- for(String str : invalidCharacter){
- if (StringUtils.containsIgnoreCase(parameterValue, str)){
- request.setAttribute("errorMessage", "非法字符:" + str);
- RequestDispatcher requestDispatcher = request.getRequestDispatcher("/error.jsp");
- requestDispatcher.forward(request, response);
- return;
- }
- }
- }
- }
- filterChain.doFilter(request, response); // 执行目标资源,放行
- }
- public void init(FilterConfig filterConfig) throws ServletException {