Filter介绍，运行顺序，实例

Posted 2020-09-13 yutingliuyl

Filter介绍

Filter可觉得是Servlet的一种“变种”，它主要用于对用户请求进行预处理，也能够对HttpServletResponse进行后处理，是个典型的处理链。

它与Servlet的差别在于：它不能直接向用户生成响应。

完整的流程是：Filter对用户请求进行预处理，接着将请求交给Servlet进行处理并生成响应，最后Filter再对server响应进行后处理。

Filter有例如以下几个用处。

• 在HttpServletRequest到达Servlet之前，拦截客户的HttpServletRequest。
• 依据须要检查HttpServletRequest，也能够改动HttpServletRequest头和数据。

• 在HttpServletResponse到达client之前，拦截HttpServletResponse。
• 依据须要检查HttpServletResponse。也能够改动HttpServletResponse头和数据。

Filter有例如以下几个种类。

• 用户授权的Filter：Filter负责检查用户请求，依据请求过滤用户非法请求。
• 日志Filter：具体记录某些特殊的用户请求。
• 负责解码的Filter：包含对非标准编码的请求解码。
• 能改变XML内容的XSLT Filter等。
• Filter可负责拦截多个请求或响应。一个请求或响应也可被多个请求拦截。

创建一个Filter仅仅需两个步骤：

• 建Filter处理类。
• web.xml文件里配置Filter。

                  

         

以下先介绍一个简单的记录日志的Filter。这个Filter负责拦截全部的用户请求，并将请求的信息记录在日志中。

LogFilter过滤器类

package com.ljq.servlet;

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;

public class LogFilter implements Filter {
    // FilterConfig可用于訪问Filter的配置信息
    private FilterConfig config;

    // 实现初始化方法
    public void init(FilterConfig config) {
        this.config = config;
    }

    // 实现销毁方法
    public void destroy() {
        this.config = null;
    }

    // 运行过滤的核心方法
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        // ---------以下代码用于对用户请求运行预处理---------
        // 获取ServletContext对象。用于记录日志
        ServletContext context = this.config.getServletContext();
        long before = System.currentTimeMillis();
        System.out.println("開始过滤...");
        // 将请求转换成HttpServletRequest请求
        HttpServletRequest hrequest = (HttpServletRequest) request;
        // 记录日志
        context.log("Filter已经截获到用户的请求地址： " + hrequest.getServletPath());
        // Filter仅仅是链式处理，请求依旧放行到目的地址
        chain.doFilter(request, response);
        
        // ---------以下代码用于对server响应运行后处理---------
        long after = System.currentTimeMillis();
        // 记录日志
        context.log("过滤结束");
        // 再次记录日志
        context.log("请求被定位到" + hrequest.getRequestURI() + "所花的时间为: "
                + (after - before));
    }

}

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
    http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
    <filter>
        <filter-name>LogFilter</filter-name>
        <filter-class>com.ljq.servlet.LogFilter</filter-class>
    </filter>

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

    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
</web-app>

上面程序实现了doFilter()方法，实现该方法就可实现对用户请求进行预处理，也可实现对server响应进行后处理——它们的分界线为是否调用了chain.doFilter()。运行该方法之前，即对用户请求进行预处理；运行该方法之后，即对server响应进行后处理。

在上面的请求Filter中。仅在日志中记录请求的URL，对全部的请求都运行chain.doFilter (request,reponse)方法，当Filter对请求过滤后，依旧将请求发送到目的地址。假设须要检查权限，能够在Filter中依据用户请求 的HttpSession，推断用户权限是否足够。假设权限不够。直接调用重定向就可以。无须调用chain.doFilter(request,reponse)方法。

          

          

以下是一个实例：

package com.ljq.servlet;

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.HttpSession;

public class AuthorityFilter implements Filter {
    private FilterConfig config;
    
    // 实现初始化方法
    public void init(FilterConfig config) {
        this.config = config;
    }

    // 实现销毁方法
    public void destroy() {
        this.config = null;
    }

    // 运行过滤的核心方法
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        // 获取该Filter的配置參数
        String encoding = config.getInitParameter("encoding");
        String login = config.getInitParameter("login");
        
        // 设置request编码用的字符集
        request.setCharacterEncoding(encoding); 
        HttpServletRequest req = (HttpServletRequest) request;
        HttpSession session = req.getSession();
        // 获取客户请求的路径
        String requestPath = req.getServletPath();
        
        
        // 假设session范围的user为null，即表明没有登录
        // 且用户请求的既不是登录页面，也不是处理登录的页面
        if (session.getAttribute("user") == null
                && !requestPath.endsWith(login)) {
            // forward到登录页面
            request.setAttribute("tip", "您还没有登录");
            request.getRequestDispatcher(login).forward(request, response);
        }
        // 放行请求
        else {
            chain.doFilter(request, response);
        }
    }
}

上面Filter的doFilter方法里2行斜体字代码用于获取Filter的配置參数，而程序中粗体字代码则是此Filter的核心，①号代码 按配置參数设置了request编码所用的字符集，接下来的粗体字代码推断session范围内是否有user属性——没有该属性即觉得没有登录。假设既没有登录，并且请求地址也不是登录页，系统直接跳转到登录页面。

在web.xml文件里配置该Filter，使用init-param元素为该Filter配置參数，init-param可接受例如以下两个子元素：

param-name：指定參数名。

param-value：指定參数值。

该Filter的配置片段例如以下：

web.xml

<?
xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
    http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
    <!-- 定义Filter -->
    <filter>
        <filter-name>authority</filter-name>
        <filter-class>com.ljq.servlet.AuthorityFilter</filter-class>
        <!-- 以下3个init-param元素配置了3个參数 -->
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <init-param>
            <param-name>login</param-name>
            <param-value>/login.jsp</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>authority</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>


    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
</web-app>

上面配置片段中粗体字代码为该Filter指定了2个配置參数，指定login为/login.jsp。这表明：假设没有登录该应用，普通用户仅仅能訪问/login.jsp。仅仅有当用户登录该应用后才可自由訪问其它页面。