重新认识Spring Boot（十五）过滤器和监听器

àì夳堔傛蜴生んèń 2022-12-30 08:14 121阅读 0赞

前言

参考书是 龙中华 《Spring Boot 实战派》

相关链接：

[https://blog.csdn.net/u013840066/article/details/104070447][https_blog.csdn.net_u013840066_article_details_104070447]

--------------------

很多Web项目中，都会用到过滤器（Filter），如参数过滤，防止SQL注入，防止页面攻击、空参数矫正，Token验证，Session验证，点击率统计等。

# 1、认识过滤器 #

##  1.1、为什么要使用过滤器 ##

在 Web开发中，常常会有这样的需求，在所有接口中去除用户输入的非法字符，以防止引起的业务异常，要实现这个功能，可以有很多方法。比如

*  在前端参数传入时进行校验，先过滤掉非法字符，然后，返回用户界面提示用户重新输入。
 *  后端接收前端没有过滤的数据，然后过滤到非法字符。
 *  理由Filter处理项目中所有非法字符。

很明显，前两种实现方法会存在重复代码，因为每个前端页面或者后端都需要处理，这样会导致代码极难维护，如果用过过滤器来实现，则只需用过滤器对所有接口进行过滤处理，这样非常方便。同时不会出现冗余代码。

##  1.2、使用Filter的步骤 ##

1、新建类，实现Filter的抽象类

2、重新init、doFilter、destroy方法

3、在Spring boot 入口中添加注解@ServletComponentScan，以注册Filter

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>在重写3个方法后，还可以进一步修改request参数使用的封装方式，比如：</td> 
  </tr> 
  <tr> 
   <td> <p>编写ParameterRequestWrapper类继承HTTPServletRequestWrapper类。</p> <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td> <p>编写ParameterRequestWrapper类构造器</p> </td> 
  </tr> 
  <tr> 
   <td> <p>在构造器中覆写父类构造器，并将Request.getParameterMap加入子类的成员变量</p> </td> 
  </tr> 
  <tr> 
   <td>编写addParam方法。</td> 
  </tr> 
  <tr> 
   <td>修改参数并调用ParameterRequestWrapper实例，并保存params</td> 
  </tr> 
  <tr> 
   <td>调用Filter方法中的Filterchain变量，已重新封装修改后的request</td> 
  </tr> 
 </tbody> 
</table>

详细用法见一下步骤

1、编写过滤器类，并通过注解@Order设置过滤器的执行顺序。

/*如果有 多个 FIlter ， 则序号越小，越早被执行*/
    @Order(value = 1)
    
    /*URL 过滤配置*/
    @WebFilter(filterName = "FilterDemo", urlPatterns = "/*")
    public class FilterDemo implements Filter {
    
        /*init 逻辑 该init将在服务器启动时被调用  */
        @Override
        public void init(FilterConfig filterConfig) throws ServletException {
            /*暂无添加*/
        }
    
        @Override
        public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    
        /* request 处理逻辑  response 封装逻辑  chain 重新写回request 和 response  */
            System.out.println("拦截器");
            filterChain.doFilter(servletRequest,servletResponse);
        }
    
    
        /*重写 destroy 方法 该逻辑在服务器关闭时被调用*/
        @Override
        public void destroy() {
    
        }
    }

2、在Spring Boot 入口中注册Filter

要在Spring Boot 入口类中注册Filter，只需要添加注解@ServletComponentScan。

--------------------

# 1.2、实现过滤器 #

## 1.2.1、新建拦截器类 ##

新建拦截器类FilterDemo1，然后在FilterDemo01中加入以下代码

/*如果有 多个 FIlter ， 则序号越小，越早被执行*/
    @Order(value = 1)
    
    /*URL 过滤配置*/
    @WebFilter(filterName = "FilterDemo", urlPatterns = "/*")
    public class FilterDemo01 implements Filter {
    
        /*init 逻辑 该init将在服务器启动时被调用  */
        @Override
        public void init(FilterConfig filterConfig) throws ServletException {
            /*暂无添加*/
        }
    
        @Override
        public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    
        /* request 处理逻辑  response 封装逻辑  chain 重新写回request 和 response  */
            System.out.println("拦截器");
            filterChain.doFilter(servletRequest,servletResponse);
        }
    
    
        /*重写 destroy 方法 该逻辑在服务器关闭时被调用*/
        @Override
        public void destroy() {
    
        }
    }

## 1.2.2、在入口开启Servlet支持 ##

直接在入口类添加“@ServletComponmentScan”即可。因为通过注解@WebFilter（urlPatterns=“/\*”）定义了URLPatterns的变量值为“\*”，代表所有的路径，所以，用户在访问本项目的任何路径的页面时，此过滤器都会在控制台输出

“拦截器”

--------------------

# 1.3、认识监听器 #

监听器（listener）用于监听web应用程序中某些对象或信息的创建，销毁，增加，修改，删除等动作，然后做出相应的响应处理，当对象的状态发生变化时，服务器自动调用监听器的方法，监听器多用于统计在线人数，在线用户，系统加载时初始化信息等。

Servlet中监听器分为以下3中类型

1、监听ServletContext，Request，Session作用域的创建和销毁。

*  ServletContextListener：监听ServletContext
 *  HTTPSessionListener：监听新的Session创建事件
 *  ServletRequestListener:监听ServletRequest的初始化和销毁。

2、监听ServletContext、Request、Session作用域中属性的变化（增加、修改、删除）

*  ServletContextAttributeListener:监听Servlet上下文参数的变化
 *  HttpSessionAttributeListener:监听HTTPSession参数的变化
 *  ServletRequestAttributeListener：监听ServletRequest参数的变化

3、监听HTTPSession中对象状态的改变（被绑定，解除绑定，钝化，活化）

*  HTTPSessionBindingListener：监听httpSession,并绑定和解除绑定。
 *  HttpSessionActivationListener：监听钝化和活动的HttpSession状态改变。

（钝化和活化参考的大佬的解答：[https://blog.csdn.net/codejas/article/details/79041006][https_blog.csdn.net_codejas_article_details_79041006]）

--------------------

# 1.4、实现监听器 #

##  1.4.1、创建监听类 ##

通过注解@WebListener标注此类是监听类

@WebListener
    public class ListenerDemo2 implements ServletContextListener {
    
    
        @Override
        public void contextInitialized(ServletContextEvent sce) {
            System.out.println("servletContext 初始化");
            System.out.println(sce.getServletContext().getServerInfo());
        }
    
        @Override
        public void contextDestroyed(ServletContextEvent sce) {
    
            System.out.println("servletContext销毁");
        }
    }

--------------------

## 1.4.2、开启监听器Bean 扫描 ##

在入口类上，添加注解@ServletComponentScan

启动项目后，在控制台会输出以下信息：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70][]

--------------------

pom依赖：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.demo</groupId>
        <artifactId>FilterTest</artifactId>
        <version>1.0-SNAPSHOT</version>
    
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.2.RELEASE</version>
            <relativePath/> 
        </parent>
    
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-devtools</artifactId>
                <scope>runtime</scope>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

--------------------

启动类：

@ServletComponentScan
    @SpringBootApplication
    public class FilterApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(FilterApplication.class, args);
        }
    
    }

--------------------

结尾：

做了两年开发，发现对Spring Boot 的认知上缺少了很多东西。因此想重新认识 Spring Boot 框架 仅此而已。

[https_blog.csdn.net_u013840066_article_details_104070447]: https://blog.csdn.net/u013840066/article/details/104070447
[https_blog.csdn.net_codejas_article_details_79041006]: https://blog.csdn.net/codejas/article/details/79041006
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI4MTk4MTgx_size_16_color_FFFFFF_t_70]: /images/20221120/5aa027faeefd43b0be3d23c672585004.png