【原创】Spring Boot 过滤器、监听器、拦截器的使用

田维常

关注

发布于: 2020 年 11 月 04 日

关注公众号“Java 后端技术全栈”**

回复“面试”获取全套大厂面试资料

在开发中用到过滤器、监听器、拦截器的场景非常多，今天就来聊聊这三者在日常开发中是如何使用的。

概念和使用场景

监听器

listener 是 servlet 规范中定义的一种特殊类。用于监听 servletContext、HttpSession 和 servletRequest 等域对象的创建和销毁事件。

实现方式：实现接口javax.servlet.http.HttpSessionListener

其主要可用于以下方面：

统计在线人数和在线用户
系统启动时加载初始化信息
统计网站访问量
记录用户访问路径

过滤器

Filter 是 Servlet 技术中最实用的技术，Web 开发人员通过 Filter 技术，对 web 服务器管理的所有 web 资源。过滤器是在请求进入 tomcat 容器后，但请求进入 servlet 之前进行预处理的。请求结束返回也是，是在 servlet 处理完后，返回给前端之前。

例如 Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能
例如实现 URL 级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能

它主要用于对用户请求进行预处理，也可以对 HttpServletResponse 进行后处理。使用 Filter 的完整流程：Filter 对用户请求进行预处理，接着将请求交给 Servlet 进行处理并生成响应，最后 Filter 再对服务器响应进行后处理。过滤器只在 servlet 前后起作用，所以它既不能捕获异常，获得 bean 对象等

实现方式：实现接口javax.servlet.Filter

拦截器

拦截器中用于在某个方法或字段被访问之前，进行拦截然后，在之前或之后加入某些操作。比如日志，安全等。一般拦截器方法都是通过动态代理的方式实现。可以通过它来进行权限验证，或者判断用户是否登陆，或者是像 12306 判断当前时间是否是购票时间。通常在项目开发中基本上都会做一个异常统一拦截处理的地方。对比一下其实我们可以发现，过滤器能做的事拦截器都能做，二拦截器做的事过滤器不一定做的了。

实现方式：实现org.springframework.web.servlet.HandlerInterceptor

三者对比

拦截器和过滤器：过滤前->拦截前->action/controller 执行->拦截后->过滤后

为了让大家更好的理解，这里借用网上几张图：

实战

项目继续使用之前文章中用到的项目。

添加过滤器

import java.io.IOException;import javax.servlet.Filter;import javax.servlet.FilterChain;import javax.servlet.FilterConfig;import javax.servlet.ServletException;import javax.servlet.ServletRequest;import javax.servlet.ServletResponse;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import javax.servlet.http.HttpServletResponseWrapper;public class UserFilter implements Filter {    @Override    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {        System.out.println(servletRequest.getParameter("name"));        HttpServletRequest hrequest = (HttpServletRequest) servletRequest;        HttpServletResponseWrapper wrapper = new HttpServletResponseWrapper((HttpServletResponse) servletResponse);        //过滤URI存在部分关键字的        if (hrequest.getRequestURI().indexOf("/index") != -1 ||                hrequest.getRequestURI().indexOf("/online") != -1 ||                hrequest.getRequestURI().indexOf("/login") != -1                ) {            filterChain.doFilter(servletRequest, servletResponse);        } else {            wrapper.sendRedirect("/login");        }    }    @Override    public void destroy() {    }    @Override    public void init(FilterConfig filterConfig) throws ServletException {    }}

复制代码

自定义 Filter 还可以使用 Servlet3.0 的注解进行配置第三步的 @WebFilter 就是 3.0 的注解

1）启动类里面增加 @ServletComponentScan，进行扫描

2）新建一个 Filter 类，implements Filter，并实现对应的接口

3) @WebFilter 标记一个类为 filter，被 spring 进行扫描

urlPatterns：拦截规则，支持正则

4）控制 chain.doFilter 的方法的调用，来实现是否通过放行不放行，web 应用 resp.sendRedirect("/index.html");场景：权限控制、用户登录(非前端后端分离场景)等

添加监听器

监听器就会联想到监听器设计模式。就相当于于考试的时候，考官一直盯着你们，一旦有人有动静，考官就一直监督者你们，一旦有人作弊，考官马上将其拿下。

import javax.servlet.http.HttpSessionEvent;import javax.servlet.http.HttpSessionListener;public class UserHttpSessionListener implements HttpSessionListener {    //监控在线人数    public static int online = 0;    @Override    public void sessionCreated(HttpSessionEvent se) {        System.out.println("创建session");        online++;    }    @Override    public void sessionDestroyed(HttpSessionEvent se) {        System.out.println("销毁session");    }}

复制代码

添加拦截器

import org.springframework.web.servlet.HandlerInterceptor;import org.springframework.web.servlet.ModelAndView;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import java.io.PrintWriter;public class UserInterceptor implements HandlerInterceptor {    //进入controller方法之前    @Override    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {        System.out.println("preHandle被调用");        System.out.println(httpServletRequest.getParameter("username"));        if(httpServletRequest.getParameter("username").equals("zhangsan")) {            return true;           }else {            //如果false，停止流程，api被拦截            //通常验证是都登录，如果没有登录则进行登录操作            PrintWriter printWriter = httpServletResponse.getWriter();            printWriter.write("please login again!");            return false;        }    }    //调用完controller之后，视图渲染之前    @Override    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {        System.out.println("postHandle被调用");    }   //整个完成之后，通常用于资源清理    @Override    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {        System.out.println("afterCompletion被调用");    }}

复制代码

preHandle 方法是在我们的 controller 方法执行之前调用的。

添加配置类

package com.example.demo.config;import com.example.demo.filter.UserFilter;import com.example.demo.listener.UserHttpSessionListener;import org.springframework.boot.web.servlet.FilterRegistrationBean;import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;//主拦截器，根据拦截不同路径跳转不同自定义拦截器 @Configurationpublic class UserWebConfig implements WebMvcConfigurer {    @Override    public void addViewControllers(ViewControllerRegistry registry) {        registry.addViewController("/index").setViewName("login");    }    @SuppressWarnings({ "rawtypes", "unchecked" })    @Bean    public FilterRegistrationBean filterRegist() {        FilterRegistrationBean frBean = new FilterRegistrationBean();        frBean.setFilter(new UserFilter());        frBean.addUrlPatterns("/*");        System.out.println("filter");        return frBean;    }    @SuppressWarnings({ "rawtypes", "unchecked" })    @Bean    public ServletListenerRegistrationBean listenerRegistry() {        ServletListenerRegistrationBean srb = new ServletListenerRegistrationBean();        srb.setListener(new UserHttpSessionListener());        System.out.println("listener");        return srb;    }}

复制代码

测试类，写个 controller 来测试

package com.example.demo;import java.util.Date;import java.util.Map;import java.util.UUID;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpSession;import com.example.demo.listener.UserHttpSessionListener;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.PathVariable;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.ResponseBody;@Controllerpublic class UserController {    private final Logger logger = LoggerFactory.getLogger(UserController.class);    @GetMapping("/welcome")    public String welcome(Map<String, Object> model) {        model.put("time", new Date());        model.put("message", "hello world");        return "welcome";    }    @RequestMapping("/login")    @ResponseBody    public Object login() {        logger.info("-----login---");        return "login";    }    @RequestMapping("/index/{name}")    @ResponseBody    public Object index(@PathVariable String name, HttpServletRequest request) {        HttpSession session = request.getSession(true);        session.setAttribute(UUID.randomUUID().toString(), name);        return "index";    }    @RequestMapping("/online")    @ResponseBody    public Object online() {        return "当前在线人数：" + UserHttpSessionListener.online + "人";    }}