Filter与Listener

忘是亡心i 2023-07-15 15:15 9阅读 0赞

### 目录 ###

*  Filter
 *   *  1、Filter概念
     *  2、Filter快速入门
     *  3、Filter细节：
     *   *  1）web.xml配置
         *  2）Filter执行流程
         *  3）Filter生命周期方法
         *  4）Filter配置详解
         *   *  拦截路径配置
             *  拦截方式配置
             *   *  (1)注解配置
                 *  (2)web.xml配置
         *  5）Filter链(配置多个Filter)
     *  4、Filter案例
     *   *  案例1 登录验证
         *  案例2 敏感词汇过滤
 *  Listener
 *   *  1、Listener概念
     *  2、ServletContextListener

JavaWeb三大组件，除了Servlet之外，还有Filter与Listener。

# Filter #

## 1、Filter概念 ##

生活中的过滤器：净水器，空气净化器，土匪…  
web中的过滤器：当某个**请求**将访问服务器的资源时，过滤器可以将请求拦截下来，完成一些特殊的功能。  
Filter的作用：一般用于完成通用的操作，如：登录验证、统一编码处理、敏感字符过滤…  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o3MTQ0MDU0ODk_size_16_color_FFFFFF_t_70]

## 2、Filter快速入门 ##

步骤：  
1. 定义一个类，实现接口Filter  
2. 复写方法  
3. 配置拦截路径

*  web.xml方式
 *  注解方式

代码（注解方式）：

package com.zhu.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() { 
    
        }
    }

启动tomcat，访问index.jsp，可以看到在请求被放行前，控制台执行了打印语句。  
![在这里插入图片描述][20200317150727560.png]

## 3、Filter细节： ##

### 1）web.xml配置 ###

注解配置之外的另一种配置方式。

<filter>
          <filter-name>demo1</filter-name>
          <filter-class>com.zhu.filter.FilterDemo1</filter-class>
    </filter>
      
    <filter-mapping>
          <filter-name>demo1</filter-name>
    		
          <url-pattern>/*</url-pattern>
    </filter-mapping>

### 2）Filter执行流程 ###

1.  执行过滤器
2.  执行放行后的资源
3.  回来执行过滤器放行代码之后的代码

### 3）Filter生命周期方法 ###

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

### 4）Filter配置详解 ###

#### 拦截路径配置 ####

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

#### 拦截方式配置 ####

可决定：**资源以何种方式被访问时，过滤器会生效**。

##### (1)注解配置 #####

设置dispatcherTypes属性，有如下几种：  
1. REQUEST：默认值。浏览器直接请求资源  
2. FORWARD：转发访问资源  
3. INCLUDE：包含访问资源  
4. ERROR：错误跳转资源  
5. ASYNC：异步访问资源

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o3MTQ0MDU0ODk_size_16_color_FFFFFF_t_70 1]  
若要配置多种方式下拦截都生效，可以用大括号：

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

##### (2)web.xml配置 #####

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

<filter-mapping>
          <filter-name>demo1</filter-name>
    	
          <url-pattern>/*</url-pattern>
          
          <dispatcher>REQUEST</dispatcher>
    </filter-mapping>

### 5）Filter链(配置多个Filter) ###

*  执行顺序：如果有两个过滤器：过滤器1和过滤器2
    
    1.  过滤器1
    2.  过滤器2
    3.  资源执行
    4.  过滤器2
    5.  过滤器1

显然是遵循原路返回的原则。

*  过滤器先后顺序问题：
    
    1.  注解配置：按照类名的字符串比较规则比较，值小的先执行
        
         *  如： AFilter 和 BFilter，AFilter就先执行了。
    2.  web.xml配置： 谁定义在上边，谁先执行

## 4、Filter案例 ##

### 案例1 登录验证 ###

*  需求：
    
    1.  访问case1案例的资源，验证其是否登录。
    2.  如果登录了，直接放行。
    3.  如果没有登录，则跳转到登录页面，提示"您尚未登录，请先登录"。
 *  分析：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o3MTQ0MDU0ODk_size_16_color_FFFFFF_t_70 2]
 *  实现：

/** * 登录验证的过滤器 */
    @WebFilter("/*")
    public class LoginFilter implements Filter { 
    
    
        public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException { 
            System.out.println(req);
            //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{ 
                //不包含，需要验证用户是否登录
                //3.从获取session中获取user
                Object user = request.getSession().getAttribute("user");
                if(user != null){ 
                    //登录了。放行
                    chain.doFilter(req, resp);
                }else{ 
                    //没有登录。跳转登录页面
    
                    request.setAttribute("login_msg","您尚未登录，请登录");
                    request.getRequestDispatcher("/login.jsp").forward(request,resp);
                }
            }
    
    
            // chain.doFilter(req, resp);
        }
    
        public void init(FilterConfig config) throws ServletException { 
    
        }
    
        public void destroy() { 
        }
    
    }

### 案例2 敏感词汇过滤 ###

*  需求：

1.  对案例录入的数据进行敏感词汇过滤
2.  敏感词汇参考《敏感词汇.txt》
3.  如果是敏感词汇，替换为 \*\*\* ，使得request.getParameter（）获取出来的String是被替换后的

*  分析：

1.  对request对象进行增强。增强获取参数相关方法（getParameter）。
2.  放行。传递代理对象  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o3MTQ0MDU0ODk_size_16_color_FFFFFF_t_70 3]

*  增强对象的功能  
    上面分析需要我们对request对象进行增强，那么如何达到这一目的呢？我们可以通过设计模式来实现。

> 设计模式：一些通用的解决固定问题的方式

1.  装饰模式
2.  代理模式
    
     *  概念：
        
        1.  真实对象：被代理的对象
        2.  代理对象：
        3.  代理模式：代理对象代理真实对象，达到增强真实对象功能的目的
     *  实现方式：
        
        1.  静态代理：有一个类文件描述代理模式
        2.  动态代理：在内存中形成代理类
            
             *  实现步骤：
                
                1.  代理对象和真实对象实现相同的接口
                2.  代理对象 = Proxy.newProxyInstance();
                3.  使用代理对象调用方法。
                4.  增强方法
             *  增强方式：
                
                1.  增强参数列表
                2.  增强返回值类型
                3.  增强方法体执行逻辑

*  实现：

/** * 敏感词汇过滤器 */
    @WebFilter("/*")
    public class SensitiveWordsFilter implements Filter { 
        private List<String> list = new ArrayList<String>();//敏感词汇集合
    
        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.replaceAll(str,"***");
                                }
                            }
                        }
                        
                        return  value;
                    }
    
                    //判断方法名是否是 getParameterMap
    
                    //判断方法名是否是 getParameterValue
    
                    return method.invoke(req,args);
                }
            });
    
            //2.放行
            chain.doFilter(proxy_req, resp);
        }
        
        public void init(FilterConfig config) throws ServletException { 
    
            try{ 
                //1.获取文件真实路径
                ServletContext servletContext = config.getServletContext();
                String realPath = servletContext.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();
            }
    
        }
     
        public void destroy() { 
        }
    
    }

# Listener #

## 1、Listener概念 ##

web的三大组件之一。

*  事件监听机制  
    事件 ：一件事情  
    事件源 ：事件发生的地方  
    监听器 ：一个对象  
    注册监听：将事件、事件源、监听器绑定在一起。 当事件源上发生某个事件后，执行监听器代码。

## 2、ServletContextListener ##

一个接口（监听器），监听ServletContext对象的创建和销毁（事件源就是tomcat），有两个方法：

*  void contextDestroyed(ServletContextEvent sce) ：ServletContext对象被销毁之前会调用该方法
 *  void contextInitialized(ServletContextEvent sce) ：ServletContext对象创建后会调用该方法

使用步骤：  
1. 定义一个类，实现ServletContextListener接口  
2. 复写方法  
3. 配置:两种方式,xml与注解

*  web.xml

<listener>
          <listener-class>com.zhu.listener.ContextLoaderListener</listener-class>
       </listener>
    
       
       <context-param>
          <param-name>contextConfigLocation</param-name>
          <param-value>/WEB-INF/classes/applicationContext.xml</param-value>
       </context-param>

*  注解  
    @WebListener

@WebListener
    public class ContextLoaderListener implements ServletContextListener { 
    
        /** * 监听ServletContext对象创建的。ServletContext对象服务器启动后自动创建。 * * 在服务器启动后自动调用 * @param servletContextEvent */
        @Override
        public void contextInitialized(ServletContextEvent servletContextEvent) { 
            //加载资源文件
            //1.获取ServletContext对象
            ServletContext servletContext = servletContextEvent.getServletContext();
    
            //2.加载资源文件
            String contextConfigLocation = servletContext.getInitParameter("contextConfigLocation");
    
            //3.获取真实路径
            String realPath = servletContext.getRealPath(contextConfigLocation);
    
            //4.加载进内存
            try{ 
                FileInputStream fis = new FileInputStream(realPath);
                System.out.println(fis);
            } catch (Exception e){ 
                e.printStackTrace();
            }
            System.out.println("ServletContext对象被创建了。。。");
        }
    
        /** * 在服务器关闭后，ServletContext对象被销毁。当服务器正常关闭后该方法被调用 * @param servletContextEvent */
        @Override
        public void contextDestroyed(ServletContextEvent servletContextEvent) { 
            System.out.println("ServletContext对象被销毁了。。。");
        }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o3MTQ0MDU0ODk_size_16_color_FFFFFF_t_70]: /images/20230528/0bee444ebbb94afda73f9532176b2a70.png
[20200317150727560.png]: /images/20230528/4f2f37221543428d846e25c8039b2d3d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o3MTQ0MDU0ODk_size_16_color_FFFFFF_t_70 1]: /images/20230528/b9021b7c6a584d38870d1c3f5ba41961.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o3MTQ0MDU0ODk_size_16_color_FFFFFF_t_70 2]: /images/20230528/1daeac82cda94c9380b3288ec90a6896.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o3MTQ0MDU0ODk_size_16_color_FFFFFF_t_70 3]: /images/20230528/1be3c2916a404793a47fc26da8937d40.png