Filter：过滤器

概念

生活中的过滤器：净水器, 空气净化器，土匪、

web中的过滤器：当访问服务器的资源时，过滤器可以将请求拦截下来，完成一些特殊的功能。

过滤器的作用：一般用于完成通用的操作。如：登录验证、统一编码处理、敏感字符过滤…

快速入门：

步骤：

  1. 定义一个类，实现接口Filter
  2. 复写方法
  3. 配置拦截路径
    • 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
package com.uestc.web.filter;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

@WebFilter("/*")//访问所有资源之前，都会执行该过滤器
public class FilterDemo1 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filterDemo1被执行了。。。");
        //放行
        filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {

    }
}

过滤器细节：

web.xml配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">
        <filter>
            <filter-name>demo1</filter-name>
            <filter-class>com.uestc.web.filter.FilterDemo1</filter-class>
        </filter>
        <filter-mapping>
            <filter-name>demo1</filter-name>
            <!-- 拦截路径 -->
            <url-pattern>/*</url-pattern>
        </filter-mapping>
</web-app>

过滤器执行流程

  1. 执行过滤器

  2. 执行放行后的资源

  3. 回来执行过滤器放行代码下边的代码

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    package com.uestc.web.filter;
    import javax.servlet.*;
    import javax.servlet.annotation.WebFilter;
    import java.io.IOException;
    @WebFilter("/*")//访问所有资源之前，都会执行该过滤器
    public class FilterDemo2 implements Filter {
        @Override
        public void init(FilterConfig filterConfig) throws ServletException {

        }
        @Override
        public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
            //对request对象请求消息增强
            System.out.println("filterDemo2被执行了。。。");
            //放行
            filterChain.doFilter(servletRequest,servletResponse);
    		//对response对象的响应消息增强
            System.out.println("filterDemo2回来了。。。");
        }
        @Override
        public void destroy() {
        }
    }

过滤器生命周期方法

  1. init:在服务器启动后，会创建Filter对象，然后调用init方法。只执行一次。用于加载资源
  2. doFilter:每一次请求被拦截资源时，会执行。执行多次
  3. destroy:在服务器关闭后，Filter对象被销毁。如果服务器是正常关闭，则会执行destroy方法。只执行一次。用于释放资源

过滤器配置详解

拦截路径配置：

  1. 具体资源路径： /index.jsp 只有访问index.jsp资源时，过滤器才会被执行
  2. 拦截目录： /user/* 访问/user下的所有资源时，过滤器都会被执行
  3. 后缀名拦截： *.jsp 访问所有后缀名为jsp资源时，过滤器都会被执行
  4. 拦截所有资源：/* 访问所有资源时，过滤器都会被执行

拦截方式配置：

资源被访问的方式

注解配置：

设置dispatcherTypes属性

  1. REQUEST：默认值。浏览器直接请求资源
  2. FORWARD：转发访问资源
  3. INCLUDE：包含访问资源
  4. ERROR：错误跳转资源
  5. ASYNC：异步访问资源

示例演示：

  1. 新建过滤器FilterDemo3 并设置dispatcherTypes属性为REQUEST

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    package com.uestc.web.filter;
    import javax.servlet.*;
    import javax.servlet.annotation.WebFilter;
    import java.io.IOException;
    //浏览器直接请求index.jsp资源是，该该过滤器会被执行
    @WebFilter( value="/index.jsp", dispatcherTypes = DispatcherType.REQUEST)
    public class FilterDemo3 implements Filter {
        public void destroy() {
        }
        public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
            System.out.println("FilterDemo3执行了。。。");
            chain.doFilter(req, resp);
        }
        public void init(FilterConfig config) throws ServletException {
        }
    }

  1. 新建ServletDemo1并对index.jsp进行转发

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    package com.uestc.web.servlet;
    import javax.servlet.ServletException;
    import javax.servlet.annotation.WebServlet;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import java.io.IOException;
    @WebServlet("/user/servletDemo1")
    public class ServletDemo1 extends HttpServlet {
        protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
            request.getRequestDispatcher("/index.jsp").forward(request,response);
        }
        protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
            this.doPost(request,response);
        }
    }

    效果展示：

    • 当直接访问index.jsp的时候，过滤器被执行了

    • 当访问/user/servletDemo1时候，过滤器没有执行

同理可得：当设置dispatcherTypes属性为FORWARD的时候

  • 当直接访问index.jsp的时候，过滤器不会执行

  • 当访问/user/servletDemo1时候，过滤器执行

    如果想要同时index.jsp和转发资源的时候过滤器都执行，那么我们只需要dispatcherTypes设置成数组形式

    1
    @WebFilter( value="/index.jsp", dispatcherTypes = {DispatcherType.REQUEST,DispatcherType.`FORWARD`})

web.xml配置

设置<dispatcher></dispatcher>标签即可

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

执行顺序：

如果有两个过滤器：过滤器1和过滤器2

  1. 过滤器1
  2. 过滤器2
  3. 资源执行
  4. 过滤器2
  5. 过滤器1

过滤器先后顺序问题：

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

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

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

案例：

案例1_登录验证

需求

  1. 访问day17_case案例的资源。验证其是否登录
  2. 如果登录了，则直接放行。
  3. 如果没有登录，则跳转到登录页面，提示”您尚未登录，请先登录”。

分析

代码实现：

新建LoginFilter

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
package com.uestc.web.filter;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
@WebFilter("/*")
public class LoginFilter implements Filter {
    public void destroy() {
    }

    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        //0.强制转换
        HttpServletRequest request=(HttpServletRequest) req;
        //1.获取资源的请求路径
        String uri=request.getRequestURI();
        //2.判断是否包含登录相关的资源路径,注意排除css/js/图片/验证码等资源
        if(uri.contains("/login.jsp")|| uri.contains("/loginServlet") || uri.contains("/css/") || uri.contains("/js/") || uri.contains("/fonts/")|| uri.contains("/checkCodeServlet")){
            //包含，用户就是想登录，放行
            chain.doFilter(req, resp);
        }else{
            //不包含，需要验证用户是否登录
            Object uesr=request.getSession().getAttribute("login_user");
            if(uesr!=null){
                //登录了，放行
                chain.doFilter(req,resp);
            }else{
                //没有登录，跳转登录界面
                request.setAttribute("login_msg","您尚未登录，请登录");
                request.getRequestDispatcher("/login.jsp").forward(request,resp);
            }
        }
    }
    public void init(FilterConfig config) throws ServletException {

    }

}

案例2_敏感词汇过滤

需求：

1. 对day17_case案例录入的数据进行敏感词汇过滤
            2. 敏感词汇参考《敏感词汇.txt》
                        3. 如果是敏感词汇，替换为 ***

分析：

1. 对`request`对象进行**增强**。增强获取参数相关方法
2. 放行。传递代理对象

增强对象的功能：
设计模式：一些通用的解决固定问题的方式

  1. 装饰模式
  2. 代理模式

代码实现：

  1. 创建过滤器SensitiveWordFilter

    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
    41
    42
    43
    44
    45
    46
    47
    48
    49
    package com.uestc.web.filter;
    @WebFilter("/*")
    public class SensitiveWordFilter implements Filter {
        public void destroy() {
        }
        public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
            //1.创建代理对象，增强getParameter方法
            ServletRequest proxy_req=(ServletRequest)Proxy.newProxyInstance(req.getClass().getClassLoader(), req.getClass().getInterfaces(), new InvocationHandler() {
                @Override
                public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                    //增强getParameter方法
                    //判断是否是getParameter方法
                    if(method.getName().equals("getParameter")){
                        //增强返回值
                        String value=(String)method.invoke(req, args);
                        if(value!=null){
                            for(String str:list){
                                if(value.contains(str)){
                                    value=value.replace(str,"***");
                                }
                            }
                        }
                        return value;
                    }
                    return method.invoke(req, args);
                }
            });
            chain.doFilter(proxy_req, resp);
        }
        private List<String> list=new ArrayList<String>();//敏感词汇list集合
        public void init(FilterConfig config) throws ServletException {
            try {
                //1.获取文件的真实路径
                ServletContext context=config.getServletContext();
                String realpath=context.getRealPath("/WEB-INF/classes/敏感词汇.txt");
                //2.读取文件
                BufferedReader br=new BufferedReader(new FileReader(realpath));
                //3.将文件的每一行数据添加到list
                String line=null;
                while((line=br.readLine())!=null){
                    list.add(line);
                }
                br.close();
                System.out.println(list);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

  2. 创建测试Testservlet

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    package com.uestc.web.servlet;
    @WebServlet("/testServlet")
    public class TestServlet extends HttpServlet {
        @Override
        protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
            String name=req.getParameter("name");
            String msg=req.getParameter("msg");
            System.out.println(name+msg);
        }
        @Override
        protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
            this.doPost(req,resp);
        }
    }

    效果展示：

    ![image-20201113150837968](C:\Users\Liu Fei\AppData\Roaming\Typora\typora-user-images\image-20201113150837968.png)