Skip to content

过滤器

过滤器(Filter)是向 Web 应用程序的请求和响应处理添加功能的Web服务组件

过滤器的工作原理：

过滤器工作原理

过滤器生命周期

过滤器生命周期的各个阶段:

  • 实例化

  • 初始化

  • 过滤

  • 销毁

HelloFilter
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
@WebFilter("/*")
public class HelloFilter extends HttpFilter implements Filter {
  public HelloFilter() {
    super();
  }

  public void init(FilterConfig fConfig) throws ServletException {
  }

  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
      throws IOException, ServletException {
    chain.doFilter(request, response);
  }

  public void destroy() {
  }
}
源代码
HelloFilter
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
import java.io.IOException;
import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.FilterConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.annotation.WebFilter;
import jakarta.servlet.http.HttpFilter;

@WebFilter("/*")
public class HelloFilter extends HttpFilter implements Filter {
  public HelloFilter() {
    super();
  }

  public void init(FilterConfig fConfig) throws ServletException {
  }

  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
      throws IOException, ServletException {
    chain.doFilter(request, response);
  }

  public void destroy() {
  }
}

过滤器定义

创建Filter分两步：

  • 创建Filter类

    • 实现Filter业务功能

  • URL映射

    • 建立Filter业务类与URL地址之间的映射关系

创建Filter类

SimpleFilter1
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
@WebFilter("/*")
public class SimpleFilter2 extends HttpFilter implements Filter {
  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
      throws IOException, ServletException {
    try {
      response.setContentType("text/html;charset=utf-8");
      PrintWriter out = response.getWriter();
      out.append("<p style='color: red;'>SimpleFilter2检查中...</p>");
      chain.doFilter(request, response);
      out.append("<p style='color: red;'>SimpleFilter2检查完成!</p>");
    } catch (Exception e) {
      System.out.println(e.getMessage());
    }
  }
}
源代码
SimpleFilter1
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
import java.io.IOException;
import java.io.PrintWriter;

import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.FilterConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.annotation.WebFilter;
import jakarta.servlet.http.HttpFilter;

public class SimpleFilter1 extends HttpFilter implements Filter {
  private FilterConfig filterConfig;

  public SimpleFilter1() {
    super();
  }

  public void init(FilterConfig fConfig) throws ServletException {
    this.filterConfig = fConfig;
  }

  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
      throws IOException, ServletException {
    try {
      response.setContentType("text/html;charset=utf-8");
      PrintWriter out = response.getWriter();
      out.append("<p style='color: blue;'>SimpleFilter1检查中...</p>");
      chain.doFilter(request, response);
      out.append("<p style='color: red;'>SimpleFilter1检查中完成!</p>");
    } catch (Exception e) {
      System.out.println(e.getMessage());
    }
  }

  public void destroy() {
  }
}

URL映射

Filter有两种映射方式：注解、web.xml

SimpleFilter2
1
2
3
@WebFilter("/*")
public class SimpleFilter2 extends HttpFilter implements Filter {
}
源代码
SimpleFilter2
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
import java.io.IOException;
import java.io.PrintWriter;

import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.FilterConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.annotation.WebFilter;
import jakarta.servlet.http.HttpFilter;

@WebFilter("/*")
public class SimpleFilter2 extends HttpFilter implements Filter {
  private FilterConfig filterConfig;

  public SimpleFilter2() {
    super();
  }

  public void init(FilterConfig fConfig) throws ServletException {
    this.filterConfig = fConfig;
  }

  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
      throws IOException, ServletException {
    try {
      response.setContentType("text/html;charset=utf-8");
      PrintWriter out = response.getWriter();
      out.append("<p style='color: red;'>SimpleFilter2检查中...</p>");
      chain.doFilter(request, response);
      out.append("<p style='color: red;'>SimpleFilter2检查完成!</p>");
    } catch (Exception e) {
      System.out.println(e.getMessage());
    }
  }

  public void destroy() {
  }
}
WEB-INF/web.xml
1
2
3
4
5
6
7
8
9
<filter>
  <filter-name>SimpleFilter1</filter-name>  <!-- 过滤器名 -->
  <filter-class>SimpleFilter1</filter-class><!-- 业务类 -->
</filter>

<filter-mapping>
  <filter-name>SimpleFilter1</filter-name>  <!-- 过滤器名 -->
  <url-pattern>/*</url-pattern> <!-- 映射地址 -->
</filter-mapping>
源代码
WEB-INF/web.xml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.jcp.org/xml/ns/javaee" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd" id="WebApp_ID" version="4.0">
  <display-name>HelloFilter</display-name>
  <welcome-file-list>
    <welcome-file>index.html</welcome-file>
    <welcome-file>index.jsp</welcome-file>
    <welcome-file>index.htm</welcome-file>
    <welcome-file>default.html</welcome-file>
    <welcome-file>default.jsp</welcome-file>
    <welcome-file>default.htm</welcome-file>
  </welcome-file-list>

  <filter>
    <filter-name>SimpleFilter1</filter-name>  <!-- 过滤器名 -->
    <filter-class>SimpleFilter1</filter-class><!-- 业务类 -->
  </filter>

  <filter-mapping>
    <filter-name>SimpleFilter1</filter-name>  <!-- 过滤器名 -->
    <url-pattern>/*</url-pattern> <!-- 映射地址 -->
  </filter-mapping>

</web-app>

过滤器链

FilterChain 接口用于调用过滤器链中的一系列过滤器

过滤器链

示例

创建一个Servlet(DoSomethingServlet)接收客户端语法，创建一个客户端页面(hi_filter.html)发送Servlet请求，创建两个过滤器(SimpleFilter1，SimpleFilter2)监听全部URL请求

DoSomethingServlet
1
2
3
4
5
6
7
8
9
@WebServlet("/DoSomthing")
public class DoSomethingServlet extends HttpServlet {
  protected void service(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {
    response.setContentType("text/html;charset=utf-8");
    PrintWriter out = response.getWriter();
    out.println("<p style='color:green;'>我做了一些事!<p>");
  }
}
源代码
DoSomethingServlet
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
import java.io.IOException;
import java.io.PrintWriter;

import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.servlet.annotation.WebServlet;

@WebServlet("/DoSomthing")
public class DoSomethingServlet extends HttpServlet {
  private static final long serialVersionUID = 1L;

  public DoSomethingServlet() {
    super();
  }

  protected void service(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {
    response.setContentType("text/html;charset=utf-8");
    PrintWriter out = response.getWriter();
    out.println("<p style='color:green;'>我做了一些事!<p>");
  }
}

demo/HelloFilter/src/main/webapp/hi_filter.html
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
<html>

<head>
  <meta charset="utf-8">
  <title> 新文档 </title>
</head>

<body>
  <h1>欢迎使用第一个过滤器示例</h1>
  <a href="/HelloFilter/DoSomthing">单击此处查看过滤器的效果</a>
</body>

</html>

SimpleFilter1
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
public class SimpleFilter1 extends HttpFilter implements Filter {
  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
      throws IOException, ServletException {
    try {
      response.setContentType("text/html;charset=utf-8");
      PrintWriter out = response.getWriter();
      out.append("<p style='color: blue;'>SimpleFilter1检查中...</p>");
      chain.doFilter(request, response);
      out.append("<p style='color: red;'>SimpleFilter1检查中完成!</p>");
    } catch (Exception e) {
      System.out.println(e.getMessage());
    }
  }
}
源代码
SimpleFilter1
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
import java.io.IOException;
import java.io.PrintWriter;

import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.FilterConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.annotation.WebFilter;
import jakarta.servlet.http.HttpFilter;

public class SimpleFilter1 extends HttpFilter implements Filter {
  private FilterConfig filterConfig;

  public SimpleFilter1() {
    super();
  }

  public void init(FilterConfig fConfig) throws ServletException {
    this.filterConfig = fConfig;
  }

  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
      throws IOException, ServletException {
    try {
      response.setContentType("text/html;charset=utf-8");
      PrintWriter out = response.getWriter();
      out.append("<p style='color: blue;'>SimpleFilter1检查中...</p>");
      chain.doFilter(request, response);
      out.append("<p style='color: red;'>SimpleFilter1检查中完成!</p>");
    } catch (Exception e) {
      System.out.println(e.getMessage());
    }
  }

  public void destroy() {
  }
}
SimpleFilter2
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
@WebFilter("/*")
public class SimpleFilter2 extends HttpFilter implements Filter {
  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
      throws IOException, ServletException {
    try {
      response.setContentType("text/html;charset=utf-8");
      PrintWriter out = response.getWriter();
      out.append("<p style='color: red;'>SimpleFilter2检查中...</p>");
      chain.doFilter(request, response);
      out.append("<p style='color: red;'>SimpleFilter2检查完成!</p>");
    } catch (Exception e) {
      System.out.println(e.getMessage());
    }
  }
}
源代码
SimpleFilter2
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
import java.io.IOException;
import java.io.PrintWriter;

import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.FilterConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.annotation.WebFilter;
import jakarta.servlet.http.HttpFilter;

@WebFilter("/*")
public class SimpleFilter2 extends HttpFilter implements Filter {
  private FilterConfig filterConfig;

  public SimpleFilter2() {
    super();
  }

  public void init(FilterConfig fConfig) throws ServletException {
    this.filterConfig = fConfig;
  }

  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
      throws IOException, ServletException {
    try {
      response.setContentType("text/html;charset=utf-8");
      PrintWriter out = response.getWriter();
      out.append("<p style='color: red;'>SimpleFilter2检查中...</p>");
      chain.doFilter(request, response);
      out.append("<p style='color: red;'>SimpleFilter2检查完成!</p>");
    } catch (Exception e) {
      System.out.println(e.getMessage());
    }
  }

  public void destroy() {
  }
}