Servlet过滤器
一、Filter简介
-
Filter:可以动态的过滤请求和响应，当需要限制用户访问某些资源或者在处理请求时提前处理某些资源时，即可以使用过滤器完成。
-
过滤器是以一种组件的形式绑定到web应用程序当中的，与其他的web应用程序组建不同的是过滤器是采用‘链’的方式进行处理的，可以将一个或多个servlet过滤器添加到一个或一组servlet中，也可以附加到js和HTML中，调用servlet前先调用附加的servlet过滤器。
-
servlet过滤器是可用servlet编写的java类，可实现如下功能：
- 在客户端请求资源到servlet处理之前，拦截过滤的信息；
- 在服务器返回信息，客户端接收响应之前，拦截过滤的信息。
-
根据规范建议的各种类型的过滤器：
- 身份验证过滤器（Authentication Filters）。
- 数据压缩过滤器（Data compression Filters）。
- 加密过滤器（Encryption Filters）。
- 触发资源访问事件过滤器。
- 图像转换过滤器（Image Conversion Filters）。
- 日志记录和审核过滤器（Logging and Auditing Filters）。
- MIME-TYPE 链过滤器（MIME-TYPE Chain Filters）。
- 标记化过滤器（Tokenizing Filters）。
- XSL/T 过滤器（XSL/T Filters），转换 XML 内容。
-
过滤器通过 Web 部署描述符（web.xml）中的 XML 标签来声明，然后映射到您的应用程序的部署描述符中的 Servlet 名称或 URL 模式。当Web容器启动Web应用程序时，它会为您在部署描述符中声明的每一个过滤器创建一个实例。
-
Filter的执行顺序与在web.xml配置文件中<Filter-mapping>配置顺序一致，一般把Filter配置在所有的Servlet之前。
二、Filter的实现及方法
- 定义一个过滤器可直接让一个类实现javax.servlet.Filter接口，Filter定义的方法如下：
| 序号 | 方法 | 描述 |
|---|---|---|
| 1 | public void doFilter (ServletRequest, ServletResponse, FilterChain) | 该方法完成实际的过滤操作，当客户端请求方法与过滤器设置匹配的URL时，Servlet容器将先调用过滤器的doFilter方法。FilterChain用户访问后续过滤器。 |
| 2 | public void init(FilterConfig filterConfig) | web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，读取web.xml配置，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（filter对象只会创建一次，init方法也只会执行一次）。开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。 |
| 3 | public void destroy() | Servlet容器在销毁过滤器实例前调用该方法，在该方法中释放Servlet过滤器占用的资源。 |
- doFilter()中有三个参数ServletRequest, ServletResponse, FilterChain从前两个参数可以看出来该接口可以实现对所有协议的过滤操作。
三、FilterConfig 使用
- Filter 的 init 方法中提供了一个 FilterConfig 对象。 如 web.xml 文件配置如下：
<filter>
<filter-name>自定义过滤器映射名</filter-name>
<filter-class>实现类的路径(包名算起)</filter-class>
<init-param>
<param-name>初始化参数名</param-name>
<param-value>初始化参数值</param-value>
......
</init-param>
</filter>
<filter-mapping>
<filter-name>和<filter-name>标签一样名字</filter-name>
<url-pattern>需要过滤的servlet（/*）</url-pattern>
</filter-mapping>
- 在 init 方法使用 FilterConfig 对象获取参数：
public void init(FilterConfig config) throws ServletException {
// 获取初始化参数
String site = config.getInitParameter(KEY);
// 输出初始化参数
System.out.println("初始化参数值 " + KEY);
}
三、实例
- 过滤器中我们可以根据 doFilte() 方法中的 request 对象获取表单参数信息，例如我们可以获取到请求的用户名和密码进行逻辑处理，也可以通过 response 对用户做出回应。比如如果验证用户名不正确，禁止用户访问 web 资源，并且向浏览器输出提示，告诉用户用户名或者密码不正确等等；
public void doFilter(ServletRequest req, ServletResponse resp,
FilterChain chain) throws IOException, ServletException {
//获取请求信息(测试时可以通过get方式在URL中添加name)
//http://localhost:8080/servlet_demo/helloword?name=123
String name = req.getParameter("name");
// 过滤器核心代码逻辑
System.out.println("过滤器获取请求参数:"+name);
System.out.println("第二个过滤器执行--网站名称：www.runoob.com");
if("123".equals(name)){
// 把请求传回过滤链
chain.doFilter(req, resp);
}else{
//设置返回内容类型
resp.setContentType("text/html;charset=GBK");
//在页面输出响应信息
PrintWriter out = resp.getWriter();
out.print("<b>name不正确，请求被拦截，不能访问web资源</b>");
System.out.println("name不正确，请求被拦截，不能访问web资源");
}
}
- 对请求和响应的字符过滤
- 创建实现Filter类
package taeyeon.com.servlet;
import javax.servlet.*;
import java.io.IOException;
public class FilterServlet implements Filter {
private String charSet;
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
servletRequest.setCharacterEncoding( this.charSet);
servletResponse.setCharacterEncoding( this.charSet);
filterChain.doFilter(servletRequest,servletResponse);
}
@Override
public void init(FilterConfig filterConfig) throws ServletException {
this.charSet= filterConfig.getInitParameter("code");
}
@Override
public void destroy() {
}
}
- 配置web.xml
<filter>
<filter-name>encoding1</filter-name>
<filter-class>taeyeon.com.servlet.FilterServlet</filter-class>
<init-param>
<param-name>code</param-name>
<param-value>UTF-8</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>encoding1</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
四、web.xml配置各节点说明
- <filter>指定一个过滤器。
- <filter-name>用于为过滤器指定一个名字，该元素的内容不能为空。
- <filter-class>元素用于指定过滤器的完整的限定类名。 -<init-param>元素用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。 在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。
- <filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径
- <filter-name>子元素用于设置filter的注册名称。该值必须是在<filter>元素中声明过的过滤器的名字
- <url-pattern>设置 filter 所拦截的请求路径(过滤器关联的URL样式)
- <servlet-name>指定过滤器所拦截的Servlet名称。
- <dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST。用户可以设置多个<dispatcher>子元素用来指定 Filter 对资源的多种调用方式进行拦截。
- <dispatcher>子元素可以设置的值及其意义：
- 当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。
- INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。
- FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。
- ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。