过滤器Filter

Filter(过滤器)简介

1.Filter 的基本功能是对 Servlet 容器调用 Servlet 的过程进行拦截，从而在 Servlet 进行响应处理的前后实现一些特殊的功能。
2.在 Servlet API 中定义了三个接口类来开供开发人员编写 Filter 程序：Filter, FilterChain, FilterConfig
3.Filter 程序是一个实现了 Filter 接口的 Java 类，与 Servlet 程序相似，它由 Servlet 容器进行调用和执行
4.Filter 程序需要在 web.xml 文件中进行注册和设置它所能拦截的资源：Filter 程序可以拦截 Jsp, Servlet, 静态图片文件和静态 html 文件
Filter 的基本工作原理

1.当在 web.xml 中注册了一个 Filter 来对某个 Servlet 程序进行拦截处理时，这个 Filter 就成了 Servlet 容器与该 Servlet 程序的通信线路上的一道关卡，该 Filter 可以对 Servlet 容器发送给 Servlet 程序的请求和 Servlet 程序回送给 Servlet 容器的相应进行拦截，可以决定是否将请求继续传递给 Servlet 程序，以及对请求和相应信息是否进行修改
2.在一个 web 应用程序中可以注册多个 Filter 程序，每个 Filter 程序都可以对一个或一组 Servlet 程序进行拦截。
3.若有多个 Filter 程序对某个 Servlet 程序的访问过程进行拦截，当针对该 Servlet 的访问请求到达时，web 容器将把这多个 Filter 程序组合成一个 Filter 链(过滤器链)。Filter 链中各个 Filter 的拦截顺序与它们在应用程序的 web.xml 中映射的顺序一致
Filter 接口

1.init(FilterConfig filterConfig)throws ServletException：在 web 应用程序启动时，web 服务器将根据 web.xml 文件中的配置信息来创建每个注册的 Filter 实例对象，并将其保存在服务器的内存中。Web容器创建 Filter 对象实例后，将立即调用该 Filter 对象的 init 方法。Init 方法在 Filter 生命周期中仅执行一次，web 容器在调用 init 方法时，会传递一个包含 Filter 的配置和运行环境的 FilterConfig 对象(FilterConfig的用法和ServletConfig类似)。利用FilterConfig对象可以得到ServletContext对象，以及部署描述符中配置的过滤器的初始化参数。在这个方法中，可以抛出ServletException异常，通知容器该过滤器不能正常工作。
2.destroy()：在Web容器卸载 Filter 对象之前被调用。该方法在Filter的生命周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源
3.与开发Servlet不同的是，Filter接口并没有相应的实现类可供继承，要开发过滤器，只能直接实现Filter接口。
4.doFilter(ServletRequest request,ServletResponse response, FilterChain chain)throws java.io.IOException,ServletException：
doFilter()方法类似于Servlet接口的service()方法。当客户端请求目标资源的时候，容器就会调用与这个目标资源相关联的过滤器的doFilter()方法。其中参数 request, response 为 web 容器或 Filter 链的上一个 Filter 传递过来的请求和相应对象；参数 chain 为代表当前 Filter 链的对象，在特定的操作完成后，可以在当前 Filter 对象的 doFilter 方法内部需要调用 FilterChain 对象的 chain.doFilter(request,response)方法才能把请求交付给 Filter 链中的下一个 Filter 或者目标 Servlet 程序去处理，也可以直接向客户端返回响应信息，或者利用RequestDispatcher的forward()和include()方法，以及HttpServletResponse的sendRedirect()方法将请求转向到其他资源。这个方法的请求和响应参数的类型是ServletRequest和ServletResponse，也就是说，过滤器的使用并不依赖于具体的协议。
FilterChain接口
1.FilterChain接口：代表当前 Filter 链的对象。由容器实现，容器将其实例作为参数传入过滤器对象的doFilter()方法中。过滤器对象使用FilterChain对象调用过滤器链中的下一个过滤器，如果该过滤器是链中最后一个过滤器，那么将调用目标资源。
2.doFilter(ServletRequest request,ServletResponse response)throws java.io.IOException：调用该方法将使过滤器链中的下一个过滤器被调用。如果是最后一个过滤器，会调用目标资源。
FilterConfig 接口
1.javax.servlet.FilterConfig接口：该接口类似于ServletConfig接口，由容器实现。Servlet规范将代表 ServletContext 对象和 Filter 的配置参数信息都封装在该对象中。Servlet 容器将其作为参数传入过滤器对象的init()方法中。
2.String getFilterName()：得到描述符中指定的过滤器的名字。
3.String getInitParameter(String name)： 返回在部署描述中指定的名字为name的初始化参数的值。如果不存在返回null.
4.Enumeration getInitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合。
5.public ServletContext getServletContext()：返回Servlet上下文对象的引用。
过滤器的部署
在实现一个过滤器后，需要在 web.xml 中进行注册和设置它所能拦截的资源。这可以通过<filter>和<filter-mapping>元素来完成的。
<filter> 元素（注册Filter）
1.<filter>元素用于在Web应用程序中注册一个过滤器。
2.在<filter>元素内
-<filter-name>用于为过滤器指定一个名字，该元素的内容不能为空。
-<filter-class>元素用于指定过滤器的完整的限定类名。
-<init-param>元素用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。
映射 Filter
<filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径( url样式)
<filter-name>子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字
<url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式)
<servlet-name>指定过滤器所拦截的Servlet名称。
<dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST. 可以设置多个<dispatcher> 子元素用来指定 Filter 对资源的多种调用方式进行拦截
-----------
使用

有两个过滤器，用户名和密码过滤器



UserNameFilter

public class UserNameFilter implements Filter {

/**
* 结合init()方法得到FilterConfig对象，用来获取<filter>标签中的初始化参数
*/
private FilterConfig filterConfig;

public void init(FilterConfig filterConfig) throws ServletException {
this.filterConfig = filterConfig;
}

public void doFilter(ServletRequest request, ServletResponse response,
FilterChain chain) throws IOException, ServletException {
/**
* Filter的初始化参数，使用FilterConfig来获取！
*/
String initUser = filterConfig.getInitParameter("username");
String username = request.getParameter("username");
if (!initUser.equals(username)) {
request.setAttribute("message", "用户名不正确");
request.getRequestDispatcher("/login.jsp").forward(request, response);
}
chain.doFilter(request, response);
}

public void destroy() {

}
}

PasswordFilter

public class PasswordFilter implements Filter {

private FilterConfig filterConfig;

public void init(FilterConfig fConfig) throws ServletException {
this.filterConfig = fConfig;
}

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
/**
* web应用的初始化参数，使用ServletContext对象来获取:filterConfig.getServletContext()
*/
String initPassword = filterConfig.getServletContext().getInitParameter("password");
String password = request.getParameter("password");

if (!initPassword.equals(password)) {
request.setAttribute("message", "密码不正确");
request.getRequestDispatcher("/login.jsp").forward(request, response);
return;
}

chain.doFilter(request, response);
}

public void destroy() {
}

}

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
version="2.4"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> 
<context-param>
<param-name>password</param-name>
<param-value>1234</param-value>
</context-param>

<filter>
<filter-name>userNameFilter</filter-name>
<filter-class>com.winner.filter.UserNameFilter</filter-class>
<init-param>
<param-name>username</param-name>
<param-value>Tom</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>userNameFilter</filter-name>
<url-pattern>/hello.jsp</url-pattern>
</filter-mapping>

<filter>
<filter-name>passwordFilter</filter-name>
<filter-class>com.winner.filter.PasswordFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>passwordFilter</filter-name>
<url-pattern>/hello.jsp</url-pattern>
</filter-mapping>

</web-app>

注意两种参数不同的获取方式！

对Filter进行封装

/**
* 自定义的HttpFilter, 实现自Filter接口
*/
public abstract class HttpFilter implements Filter {

/**
* 用于保存FilterConfig对象.
*/
private FilterConfig filterConfig;

@Override
public void init(FilterConfig filterConfig) throws ServletException {
this.filterConfig = filterConfig;
init();
}

/**
* 供子类继承的初始化方法.可以通过getFilterConfig()获取FilterConfig对象.
*/
protected void init() {
}

/**
* 直接返回init(ServletConfig)的FilterConfig对象
*/
public FilterConfig getFilterConfig() {
return filterConfig;
}

/**
* 原生的doFilter方法, 在方法内部把ServletRequest和ServletResponse
* 转为了HttpServletRequest和HttpServletResponse,并调用了
* doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
* <p>
* 若编写Filter的过滤方法不建议直接继承该方法. 而建议继承
* doFilter(HttpServletRequest request, HttpServletResponse response,
* FilterChain filterChain)方法
*/
@Override
public void doFilter(ServletRequest req, ServletResponse resp,
FilterChain chain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) req;
HttpServletResponse response = (HttpServletResponse) resp;

doFilter(request, response, chain);
}

/**
* 抽象方法,为Http定制，必须实现.
*
* @param request
* @param response
* @param filterChain
* @throws IOException
* @throws ServletException
*/
public abstract void doFilter(HttpServletRequest request, HttpServletResponse response,
FilterChain filterChain) throws IOException, ServletException;

/**
* 空的 destroy 方法
*/
@Override
public void destroy() {
}

}