javaweb过滤器详解

2018年11月26日 990次阅读 0人点赞

什么是过滤器Filter

Filter也称之为过滤器，它是Servlet技术中最激动人心的技术，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。

Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截.

《javaweb过滤器详解》

Filter是如何实现拦截的？

Filter接口中有一个doFilter方法，当我们编写好Filter，并配置对哪个web资源进行拦截后，WEB服务器每次在调用web资源的service方法之前，都会先调用一下filter的doFilter方法，因此，在该方法内编写代码可达到如下目的：

  • 调用目标资源之前，让一段代码执行。
  • 是否调用目标资源（即是否让用户访问web资源）。
  • 调用目标资源之后，让一段代码执行。

web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对 象，它也提供了一个doFilter方法，开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方 法，即web资源就会被访问，否则web资源不会被访问。

在doFilter（）方法中，chain.doFilter()前的一般是对request执行的过滤操作，chain.doFilter后面的代码一般是对response执行的操作。

在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链。
web服务器根据Filter在web.xml文件中的注册顺序，决定先调用哪个Filter，当第一个Filter的doFilter方法被调用时，web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。在doFilter方法中，开发人员如果调用了FilterChain对象的doFilter方法，则web服务器会检查FilterChain对象中是否还有filter，如果有，则调用第2个filter，如果没有，则调用目标资源。

Filter的使用

使用一个Filter分为两个步骤
1、编写java类实现Filter接口，并实现其doFilter方法。
2、在 web.xml 文件中使用和元素对编写的filter类进行注册，并设置它所能拦截的资源。

过滤器设置

/**
 * 
 */
package 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;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.sun.net.httpserver.Filter.Chain;

/**
 * @author Administrator
 *
 */
public class CodeFilter implements Filter{

    @Override
    public void init(FilterConfig arg0) throws ServletException {

    }


    @Override
    public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain)
        throws IOException, ServletException {
    HttpServletRequest request=(HttpServletRequest)req;
    HttpServletResponse response = (HttpServletResponse)res;
    request.setCharacterEncoding("UTF-8");
    response.setContentType("text/html;charset=UTF-8");
    /*这句代码其实有两个作用：通知response以UTF-8输出和浏览器以UTF-8打开。
      即等价于response.setHeader("content-type", "text/html;charset=UTF-8");
      和response.setCharacterEncoding("UTF-8");两句代码。
     */

    System.out.println("编码过滤器放行前");
    //放行请求资源
    chain.doFilter(request, response);
    System.out.println("编码过滤器放行后");

    }


    @Override
    public void destroy() {

    }
}

web.xml注册Filter

<!-- 编码过滤器 -->
    <filter>
    <description>统一编码过滤器</description>
    <filter-name>CodeFilter</filter-name>
    <filter-class>filter.CodeFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>CodeFilter</filter-name>
        <url-pattern>*</url-pattern>
    </filter-mapping>

servlet代码如下

/**
 * 
 */
package web.filterTest;

import java.io.IOException;
import java.io.PrintWriter;
import java.net.URLDecoder;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @author Administrator
 *
 */
public class CodeServlet extends HttpServlet {

    public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    String query = URLDecoder.decode(request.getQueryString());
    System.out.println(query);
    PrintWriter out = response.getWriter();
    out.println("中文字符过滤器过滤后");
    out.flush();
    out.close();

    }

    public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {

    doGet(request, response);
    }

}

浏览器输入

http://127.0.0.1:8080/servlet/codeServlet?name=zhangsan&sex=男

返回结果

中文字符过滤器过滤后

控制台结果

编码过滤器放行前
name=zhangsan&sex=男
编码过滤器放行后

过滤器的生命周期

Filter的创建

Filter的创建和销毁由WEB服务器负责。 web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作，filter对象只会创建一次，init方法也只会执行一次。通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。

Filter的销毁

Web容器调用destroy方法销毁Filter。destroy方法在Filter的生命周期中仅执行一次。在destroy方法中，可以释放过滤器使用的资源。

FilterConfig接口

用户在配置filter时，可以使用为filter配置一些初始化参数，当web容器实例化Filter对象，调用其init方法时，会把封装了filter初始化参数的filterConfig对象传递进来。因此开发人员在编写filter时，通过filterConfig对象的方法，就可获得：
– String getFilterName()：得到filter的名称。
– String getInitParameter(String name)： 返回在部署描述中指定名称的初始化参数的值。如果不存在返回null.
– Enumeration getInitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合。
– public ServletContext getServletContext()：返回Servlet上下文对象的引用。

 @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    String filterName = filterConfig.getFilterName();
    System.out.println("过滤器的名字为："+filterName);
    }

启动服务器时会输出

过滤器的名字为：CodeFilter

web.xml中Filter的部署

Filter的部署分为两个步骤：
　　1、注册Filter
　　2、映射Filter

注册Filter

<description>用于添加描述信息，该元素的内容可为空，<description>可以不配置。

<filter-name>用于为过滤器指定一个名字，该元素的内容不能为空。

<filter-class>元素用于指定过滤器的完整的限定类名。

<init-param>元素用于为过滤器指定初始化参数，它的子元素<param-name>指定参数的名字，<param-value>指定参数的值。在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。如果过滤器不需要指定初始化参数，那么<init-param>元素可以不配置。


    <filter>
        <description>统一编码过滤器</description>
        <filter-name>CodeFilter</filter-name>
        <filter-class>filter.CodeFilter</filter-class>
        <init-param>
            <description>过滤器初始化参数1</description>
            <param-name>name</param-name>
            <param-value>zhangsan</param-value>
        </init-param>
        <init-param>
            <description>过滤器初始化参数2</description>
            <param-name>sex</param-name>
            <param-value>男</param-value>
        </init-param>
    </filter>

映射Filter

在web.xml文件中注册了Filter之后，还要在web.xml文件中映射Filter,规定过滤的规则

<filter-mapping>
        <filter-name>CodeFilter</filter-name>
        <url-pattern>*</url-pattern>
    </filter-mapping>

<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> 子元素可以设置的值及其意义：

1、REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。
2、INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。
3、FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。
4、ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。

参考

javaweb学习总结(四十二)——Filter(过滤器)学习
Java过滤器Filter使用详解

作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可
点赞
标签：

发表回复

您的电子邮箱地址不会被公开。 必填项已用*标注