浅谈JAVAWeb过滤器Filter

Filter简介 

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

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

Filter是如何实现拦截的 

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

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

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

Filter开发步骤 

Filter开发分为二个步骤 

1、编写java类实现Filter接口，并实现其doFilter方法

2、在 web.xml 文件中使用<filter>和<filter-mapping>元素对编写的filter类进行注册，并设置它所能拦截的资源 

在文件前先写下映射路径  @WebFilter("/*") 

<!--配置过滤器-->
<filter>
    <filter-name>FilterDemo01</filter-name>
    <filter-class>com.hbnu.filter.FilterDemo01</filter-class>
</filter>
<!--映射过滤器-->
<filter-mapping>
    <filter-name>FilterDemo01</filter-name>
    <!--/*表示拦截所有请求-->
    <url-pattern>/*</url-pattern>
</filter-mapping>

举个例子

package com.hbnu.filter;

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 java.io.IOException;

/**
 * @author 运气男孩
 * @date 2021-12-04 13:10
 */
public class FilterDemo01 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("过滤器初始化");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        // 对request和response进行一些预处理
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html;charset=UTF-8");

        System.out.println("FilterDemo01执行前！！！");
        chain.doFilter(request, response);  // 让目标资源执行，放行
        System.out.println("FilterDemo01执行后！！！");
    }

    @Override
    public void destroy() {
        System.out.println("过滤器销毁");
    }
}

Filter链 

在一个web应用中，可以开发编写多个Filter，这些Filter组合起来称之为一个Filter链 

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

Filter生命周期 

Filter的创建 

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

Filter的销毁 

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

用户在配置filter时，可以使用<init-param>为filter配置一些初始化参数，当web容器实例化Filter对象，调用其init方法时，会把封装了filter初始化参数的filterConfig对象传递进来。因此开发人员在编写filter时，通过filterConfig对象的方法，就可获得 

String getFilterName()：得到filter的名称 

String getInitParameter(String name)： 返回在部署描述中指定名称的初始化参数的值。如果不存在返回null 

Enumeration getInitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合 

public ServletContext getServletContext()：返回Servlet上下文对象的引用 

Filter注意点 

拦截路径配置 

1、具体资源路径： /index.jsp   只有访问index.jsp资源时，过滤器才会被执行 

2、拦截目录： /demo/*    访问/demo下的所有资源时，过滤器都会被执行 

3、后缀名拦截： *.jsp       访问所有后缀名为jsp资源时，过滤器都会被执行 

4、拦截所有资源：/*       访问所有资源时，过滤器都会被执行 

过滤器链(配置多个过滤器) 

执行顺序：如果有两个过滤器：过滤器A和过滤器B 

过滤器先后顺序问题 

1、注解配置：按照类名的字符串比较规则比较，值小的先执行 

如： AFilter 和 BFilter，AFilter就先执行了 

2、web.xml配置： <filter-mapping>谁定义在上边，谁先执行 

说了这么多，简单写个案例：登录验证 

需求如下：

• 访问web的资源。验证其是否登录 
• 如果登录了，则直接放行 
• 如果没有登录，则跳转到登录页面，提示“你尚未登录，请先登录" 

@WebFilter("/*")
public class LoginFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) req;
        String requestURI = request.getRequestURI();
        System.out.println(requestURI);
        String username = (String) request.getSession().getAttribute("username");
        if (requestURI.contains("/login.jsp") || requestURI.contains("/loginServlet") || requestURI.contains("/checkCodeServlet")) {
            chain.doFilter(req, resp);
        } else {
            if (username != null) {
                chain.doFilter(req, resp);
            } else {
                request.setAttribute("login_info", "您还未登录，请先登录");
                request.getRequestDispatcher("/login.jsp").forward(request, resp);
            }
        }
    }

    @Override
    public void destroy() {

    }
}

好了，关于此次JAVAweb的过滤器就说到这里了，如有不足之处，欢迎指正！

感恩能与大家在华为云遇见！希望能与大家一起在华为云社区共同成长。