过滤器Filter
1.
与servlet类似,过滤器是一些web应用程序组件,可以绑定到一个web应用程序中,但是与其他web应用程序不同的是,filter是“链”在容器的处理过程中的。意味着会在servlet处理器之前访问一个进入的请求,并在返回响应信息给客户端之前,由Filter访问这些响应信息。这样是为了Filter可以检查并修改请求和响应的内容。
即对HttpServletRequest进行预处理,对HttpServletResponse进行后处理,可以修改request和response的头和数据。是典型的处理链FilterChain
Filter与请求,响应之间的关系:多对多
2.
Filter的种类:
用户授权的Filter:Filter负责检查用户请求,根据请求过滤非法请求
日志Filter:详细记录某些特殊的用户请求
负责解码的Filter:包括对非标准码的请求解码
能改变XML内容的XSLTFiler
3.
创建Filter:
(1). 创建Filter处理类
实现javax.servlet.Filter接口,在该接口中定义了三个方法。
void init(FilterConfig config): 用于完成Filter的初始化。
void destroy(): 用于Filter销毁前,完成某些资源的回收。
void doFilter(ServletRequest request, ServletResponse response,FilterChain
chain):实现过滤功能,该方法就是对每个请求及响应增加的额外处理。
生命周期:inti()->doFilter()->destroy()
(2).web.xml中配置Filter
4.
Filter常用场景:
(1).日志的记录,当有请求到达时,在该过滤器中进行日志的记录,处理完成后,进行后续的Filter或处理。
a.编写Filter类
publicclass LogFilter implements Filter {
private FilterConfig config;
//实现初始化方法
publicvoid init(FilterConfig config) {
this.config = config;
}
//实现销毁方法
publicvoid destroy() {
this.config =null;
}
publicvoid doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) {
//获取ServletContext对象,用于记录日志
ServletContext context =this.config.getServletContext();
long before = System.currentTimeMillis();
System.out.println("开始过滤... ");
//将请求转换成HttpServletRequest请求
HttpServletRequest hrequest = (HttpServletRequest) request;
//记录日志
context.log("Filter已经截获到用户的请求的地址: " + hrequest.getServletPath());
try {
// Filter只是链式处理,请求依然转发到目的地址。
chain.doFilter(request, response);
}catch (Exception e) {
e.printStackTrace();
}
long after = System.currentTimeMillis();
//记录日志
context.log("过滤结束");
//再次记录日志
context.log("请求被定位到" + ((HttpServletRequest) request).getRequestURI()
+"所花的时间为: " + (after - before));
}
}
在上面的请求Filter中,仅在日志中记录请求的URL,对所有的请求都执行chain.doFilter(request,reponse)方法,当Filter对请求过滤后,依然将请求发送到目的地址。
b.在web.xml中配置Filter
<!--定义Filter -->
<filter>
<!-- Filter的名字 -->
<filter-name>log</filter-name>
<!-- Filter的实现类 -->
<filter-class> test.filter.LogFilter</filter-class>
</filter>
<!--定义Filter 拦截地址 -->
<filter-mapping>
<!-- Filter的名字 -->
<filter-name>log</filter-name>
<!-- Filter负责拦截的URL -->
<url-pattern>/filter/*</url-pattern>
</filter-mapping>
通过上述步骤的操作,此时就可以通过URI进行访问。具体访问后会在log文件中的localhost文件中产生具体的访问日志。如下所示:
2010-12-28 21:12:50 org.apache.catalina.core.ApplicationContext log
信息:请求被定位到/examples/jsp/jsp2/el/basic-arithmetic.jsp所花的时间为: 0
2010-12-28 21:14:55 org.apache.catalina.core.ApplicationContext log
信息: Filter已经截获到用户的请求的地址: /jsp/jsp2/el/basic-comparisons.jsp
2010-12-28 21:14:56 org.apache.catalina.core.ApplicationContext log
信息:过滤结束
(2).进行编码修正,当有新的请求的时候,需要将用户传过来的字符进行重新编码,使它能够满足服务器的编码格式。
a.编写Filter类
publicclass EncodingFilter implements Filter {
private FilterConfig filterConfig =null;
private String encoding =null;
//实现销毁方法
publicvoid destroy() {
encoding = null;
}
//进行具体的过滤
publicvoid doFilter(ServletRequest request, ServletResponse response,
FilterChain chain)throws IOException, ServletException {
//获取ServletContext对象,用于记录日志
ServletContext context =this.filterConfig.getServletContext();
context.log("开始设置编码格式");
String encoding = getEncoding();
if (encoding == null){
encoding ="gb2312";
}
//在请求里设置上指定的编码
request.setCharacterEncoding(encoding);
chain.doFilter(request, response);
context.log("成功设置了编码格式");
}
//初始化配置
publicvoid init(FilterConfig filterConfig)throws ServletException {
this.filterConfig = filterConfig;
this.encoding = filterConfig.getInitParameter("encoding");
}
private String getEncoding() {
returnthis.encoding;
}
}
b.在web.xml中配置Filter
<!--定义Filter -->
<filter>
<!-- Filter的名字 -->
<filter-name>encoding</filter-name>
<!-- Filter的实现类 -->
<filter-class> test.filter.EncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>gb2312</param-value>
</init-param>
</filter>
<!--定义Filter 拦截地址 -->
<filter-mapping>
<!-- Filter的名字 -->
<filter-name> encoding </filter-name>
<!-- Filter负责拦截的URL -->
<url-pattern>/encode/*</url-pattern>
</filter-mapping>
通过上述步骤的操作,此时就可以通过URI进行访问。
(3).用户权限的认证,当用户发送请求时,可以对用户的身份信息进行验证,如果通过验证就进行其他操作,否则进入下一步处理。
a.编写Filter类
publicclass SecurityFilter implements Filter {
private FilterConfig filterConfig;
//初始化方法实现
@Override
publicvoid init(FilterConfig filterConfig)throws ServletException {
this.filterConfig = filterConfig;
}
//身份认证的过滤
@Override
publicvoid doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
ServletContext context =this.filterConfig.getServletContext();
HttpServletRequest req = (HttpServletRequest) request;
HttpServletResponse res = (HttpServletResponse) response;
HttpSession session = req.getSession();
//登录后才能进入下一步处理,否则直接进入错误提示页面
if (session.getAttribute("username") !=null) {
context.log("身份认证通过,进入下一步处理 ");
chain.doFilter(request, response);
}else {
context.log("身份认证失败,直接返回");
res.sendRedirect("../failure.jsp");
}
}
//实现销毁方法
@Override
publicvoid destroy() {
this.filterConfig = null;
}
}
b.在web.xml中配置Filter
<!--定义Filter -->
<filter>
<!-- Filter的名字 -->
<filter-name>security</filter-name>
<!-- Filter的实现类 -->
<filter-class> test.filter.SecurityFilter</filter-class>
</filter>
<!--定义Filter 拦截地址 -->
<filter-mapping>
<!-- Filter的名字 -->
<filter-name> security </filter-name>
<!-- Filter负责拦截的URL -->
<url-pattern>/security/*</url-pattern>
</filter-mapping>
通过上述步骤的操作,此时就可以通过URI进行访问。此时如果能够取得Session中的username值时,会直接进入下一步处理,否则直接进入错误页面。
5.
FilterChain
两个过滤器,EncodingFilter负责编码,SecurityFilter负责控制权限,服务器会按照web.xml中过滤器定义的先后循环组装成一条链,然后一次执行其中的doFilter()。
执行的顺序:
执行的代码顺序是:
(1)执行EncodingFilter.doFilter()中chain.doFilter()之前的部分;request.setCharacterEncoding(encoding);
(2)执行SecurityFilter.doFilter()中chain.doFilter()之前的部分:判断用户是否已登录。
(3)如果用户已登录,则访问请求的资源。
(4)如果用户未登录,则页面重定向到:/failure.jsp。
(5)执行SecurityFilter.doFilter()中chain.doFilter()之后的部分:这里没有代码。
(6)执行EncodingFilter.doFilter()中chain.doFilter()之后的部分:写入已经完成的日志。
过滤链的好处是,执行过程中任何时候都可以打断,只要不执行chain.doFilter()就不会再执行后面的过滤器和请求的内容。而在实际使用时,就要特别注意过滤链的执行顺序问题,像EncodingFilter就一定要放在所有Filter之前,这样才能确保在使用请求中的数据前设置正确的编码。