Filter 过滤器

最新推荐文章于 2023-05-22 16:26:16 发布

「已注销」

最新推荐文章于 2023-05-22 16:26:16 发布

阅读量176

点赞数 1

文章标签：服务器 javaee

本文链接：https://blog.youkuaiyun.com/Zxy_zzz/article/details/124793177

版权

本文介绍了JavaWeb的Filter过滤器，包括其作为JavaEE规范的角色、拦截请求和响应的功能、在web.xml中的配置步骤、Filter的生命周期、FilterConfig类的应用、FilterChain过滤器链的工作原理以及拦截路径的匹配方式（精确、目录、后缀名匹配）。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

FilterChain.doFilter() 方法的作用：

一、Filter 过滤器简介

Filter 过滤器是 JavaWeb 的三大组件之一。

JavaWeb 三大组件分别是Servlet 程序、Listener 监听器、Filter 过滤器。

Filter 过滤器是 JavaEE 的规范，也就是一个接口。

Filter 过滤器作用是拦截请求和过滤响应。

拦截请求常见的应用场景有权限检查、日记操作、事务管理等等。

Filter工作流程图：

二、Filter 过滤器的使用步骤

编写一个类去实现 Filter 接口，并实现过滤方法 doFilter()：

public class AdminFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
        HttpSession session = httpServletRequest.getSession();
        Object user = session.getAttribute("user");

        // 如果等于 null，说明还没有登录
        if (user == null) {
            servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest,servletResponse);
            return;
        }else {
            // 让程序继续往下访问用户的目标资源
            filterChain.doFilter(servletRequest,servletResponse);
        }

    }

    @Override
    public void destroy() {

    }
}

到 web.xml 中去配置 Filter 的拦截路径：

<filter>
        <filter-name>AdminFilter</filter-name>
        <filter-class>filter.AdminFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>AdminFilter</filter-name>
        <url-pattern>/admin/*</url-pattern>
    </filter-mapping>

编写LoginServlet 程序：

protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        response.setContentType("text/html; charset=UTF-8");

        String username = request.getParameter("username");
        String password = request.getParameter("password");

        if ("asd".equals(username) && "111".equals(password)){
            request.getSession().setAttribute("user",username);

            response.getWriter().write("登录成功");
        }else {
            request.getRequestDispatcher("/login.jsp").forward(request,response);
        }
    }

三、Filter的生命周期

构造器方法和init()方法在web工程启动时就会被执行，此时filter过滤器已经被创建。
每次拦截到请求时，就会执行doFilter()方法。
在停止web工程时，就会执行destroy()方法，此时会销毁filter过滤器。


public class AdminFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
        HttpSession session = httpServletRequest.getSession();
        Object user = session.getAttribute("user");

        // 如果等于 null，说明还没有登录
        if (user == null) {
            servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest,servletResponse);
            return;
        }else {
            // 让程序继续往下访问用户的目标资源
            filterChain.doFilter(servletRequest,servletResponse);
        }

    }

    @Override
    public void destroy() {

    }
}

四、FilterConfig类

FilterConfig 类是 Filter 过滤器的配置文件类。

Tomcat 每次创建 Filter 的时候，也会同时创建一个 FilterConfig 类，这里包含了 Filter 配置文件的配置信息。

FilterConfig 类的作用是获取 filter 过滤器的配置内容：

获取 Filter 的名称 filter-name 的内容
获取在 Filter 中 wen.xml 配置的 init-param 初始化参数
获取 ServletContext 对象

public void init(FilterConfig filterConfig) throws ServletException {

        //获取filter的名称 filter-name的内容
        System.out.println("filter-name的值是：" + filterConfig.getFilterName());
        //获取在web.xml中配置的init-param初始化参数
        System.out.println("初始化参数username的值是：" + filterConfig.getInitParameter("username"));
        System.out.println("初始化参数url的值是：" + filterConfig.getInitParameter("url"));
        //获取servletContext对象
        System.out.println(filterConfig.getServletContext());
    }

五、FilterChain过滤器链

FilterChain.doFilter() 方法的作用：

执行下一个Filter过滤器（如果有Filter）
执行目标资源

Filter过滤器的执行细节：

Filter1过滤器：

public class Filter1 implements Filter {
    public void destroy() {
    }

    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        System.out.println("Filter1前置代码");

        chain.doFilter(req, resp);

        System.out.println("Filter1后置代码");

    }

    public void init(FilterConfig config) throws ServletException {

    }

}

Filter2过滤器：

public class Filter2 implements Filter {
    public void destroy() {
    }

    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        System.out.println("Filter2前置代码");

        chain.doFilter(req, resp);

        System.out.println("Filter2后置代码");
    }

    public void init(FilterConfig config) throws ServletException {

    }
}