Springboot集成过滤器Filter和监听器Listener

介绍

在进行项目开发时，我们经常需要用到Filter和Listener，下面我们基于注解模式对二者进行实操介绍。在介绍之前，我们先编写一个测试方法，方便后面验证效果；

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.HashMap;
import java.util.Map;

@Controller
public class TestController {

    @RequestMapping("/test")
    @ResponseBody
    public Map<String, Object> getMsg(){
        Map<String, Object> map = new HashMap<>();
        map.put("result", "response msg");
        return map;
    }

}

基于注解模式的Filter

实现自定义过滤器的关键点

1、实现Filter接口；

2、引入@WebFilter注解；

3、指定过滤器filterName名称

4、配置过滤请求类型urlPatterns；（这里只配置了上文的/test请求，实际可根据需求配置多个，如{"*.do","*.jsp"}等）

5、在doFilter()中编写处理逻辑；

package com.example.demo.config;


import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

/**
 * 自定义过滤器（注解方式）
 */
@WebFilter(filterName = "MyFilter", urlPatterns = {"/test"})
public class MyFilter 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("********** filter start **********");
        filterChain.doFilter(servletRequest, servletResponse);
        System.out.println("********** filter end **********");
    }

    @Override
    public void destroy() {

    }
}

启动应用，在浏览器中输入：http://localhost:8080/test，看到控制台输出如下日志，说明过滤器已经生效了。

2020-04-22 22:32:20.570  INFO 11388 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring DispatcherServlet 'dispatcherServlet'
2020-04-22 22:32:20.571  INFO 11388 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Initializing Servlet 'dispatcherServlet'
2020-04-22 22:32:20.577  INFO 11388 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Completed initialization in 6 ms
********** filter start **********
********** filter end **********

Process finished with exit code -1

基于注解模式的Listenser

实现自定义监听器的关键点

1、实现ServletContextListener接口；

2、引入@WebListener注解；

3、在contextInitialized()编写处理逻辑；

package com.example.demo.config;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;

/**
 *  自定义监听器（注解方式）
 */
@WebListener
public class MyListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("***** init MyListener *****");
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {

    }
}

启动应用，在浏览器中输入：http://localhost:8080/test，看到控制台输出如下日志，说明监听器已经生效了。

2020-04-22 22:32:14.103  INFO 11388 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2020-04-22 22:32:14.103  INFO 11388 --- [           main] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 991 ms
***** init MyListener *****
2020-04-22 22:32:14.287  INFO 11388 --- [           main] o.s.s.concurrent.ThreadPoolTaskExecutor  : Initializing ExecutorService 'applicationTaskExecutor'
2020-04-22 22:32:14.422  INFO 11388 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''