Servlet技术简介之 开发web应用过滤器

Web应用中的过滤器截取从客户端进来的请求，并作出处理的答复。它可以说是外部进入网站的第一道关，在这个关卡里，可以验证客户是否来自可信的网络，可以对客户提交的数据进行重新编码，可以从系统里获得配置的信息等等。

 

可以为一个Web应用组件部署多个过滤器，这些过滤器组成一个过滤链，每个过滤器只执行某个特定的操作或者检查，这样请求在到达被访问的目标之前，需要经过这个过滤链，如果由于安全问题而不能访问目标资源，那么过滤器就可以把客户端的请求拦截。

 

web应用的请求传递如下：

客户端 →  http请求→ Filter1（doFilter）→Filter2（doFilter）→目标组件。

 

1.Filter的开发

为应用开发中，我们经常使用的过滤功能就是对客户端的请求进行统一编码，对客户端进行认证。

要开发一个Filter,必须直接或间接实现Filter接口。Filter接口定义了以下的方法：

●init（）：用于获得FilterConfig对象。

●destroy（）：销毁这个Filter。

●doFilter（）：进行过滤处理。

 

示例代码如下：

package jp.co.xiehl.commons.presentation; 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 * @since 2009/07/10 */ public class CharacterEncodingFilter implements Filter { /** *　encoding名 */ private String encoding = null; /** * destroy */ public void destroy() { this.encoding = null; } /** * {@inheritDoc} */ public void doFilter(final ServletRequest request, final ServletResponse response, final FilterChain chain) throws IOException, ServletException { if (encoding != null) { request.setCharacterEncoding(encoding); } chain.doFilter(request, response); } /** * {@inheritDoc} */ public void init(final FilterConfig filterConfig) throws ServletException { this.encoding = filterConfig.getInitParameter("encoding"); } }

 

上例代码中，在init方法中通过filterConfig.getInitParameter("encoding");来获得FilterConfig中的参数，可以看出这种获得参数的方法和Servlet获得初始参数是一样的。

doFilter是过滤器中最重要的方法，通过这个方法来进行实际的业务处理。在doFilter中，首先获得Http的请求和响应对象，然后对Http请求中的参数进行统一编码，这里采用的是UTF-8，进行编码后把控制权转让给下一个过滤器，如果在这个过滤链中没有下一个过滤器，那么就会把请求直接发送到目标。

 

过滤器的配置

<filter> <filter-name>Character Encoding Filter</filter-name> <filter-class>jp.co.xiehl.commons.presentation.CharacterEncodingFilter</filter-class> <init-param> <param-name>encoding</param-name> <param-value>utf-8</param-value> </init-param> </filter> <filter-mapping> <filter-name>Character Encoding Filter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>

 

以上配置文件中，首先声明了该Filter的名字为Character Encoding Filter，然后指定它的实现类，这里是jp.co.xiehl.commons.presentation.CharacterEncodingFilter。Filter的名字和实现类的指定是必须的。由于在该Filter中需要使用初始化参数，股在这里需要进行声明，用

  <init-param>
   <param-name>encoding</param-name>
   <param-value>utf-8</param-value>
  </init-param>

方式进行初始化参数的设定。

 

 

2.SignonFilter

再举一个例子。

这个Filter用于对用户的访问进行认证，如果认证通过，那么允许访问指定的资源；如果认证不通过，那么把请求转发到登录的界面。

SignonFilter.java

 

package jp.co.xiehl.commons.presentation; 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; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpSession; public class SignonFilter implements Filter { String LOGIN_PAGE = "login.jsp"; @Override public void destroy() { // TODO Auto-generated method stub } @Override public void doFilter(ServletRequest req, ServletResponse res, FilterChain fc) throws IOException, ServletException { HttpServletRequest hreq = (HttpServletRequest)req; HttpServletResponse hres = (HttpServletResponse)res; HttpSession session = hreq.getSession(); String isLogin=""; try{ isLogin = (String)session.getAttribute("isLogin"); // check OK! if(isLogin.equals("true")) { System.out.println("Security check is ok"); fc.doFilter(req, res); } else { // check NG! hres.sendRedirect(LOGIN_PAGE); System.out.println("the request failed"); } }catch(Exception e) { e.printStackTrace(); } } @Override public void init(FilterConfig arg0) throws ServletException { // TODO Auto-generated method stub } }

 

以上程序中的doFilter方法中，首先通过isLogin = (String)session.getAttribute("isLogin");代码来获得用户是否登录的属性，如果登录，就可以访问目标资源；如果未登录则把请求转发到登录画面。

 

配置：

配置Filter有两个任务，首先声明Filter，然后是使用Filter。声明Filter时，需要指定Filter的名字，Filter的实现类，如果有参数，那么要配置它的参数。在使用Filter时，主要是做一些URL的映射，和Filter映射匹配的请求会被处理。