【SpringBoot】之自定义 Filter 过滤器

目录

• 一、Filter 介绍
• 二、Filter 的拦截过程
• 三、自定义 Filter

一、Filter 介绍

---

Filter 过滤器主要用来过滤用户的请求，允许用户对请求进行前置处理和后置处理，比如实现 URL 级别的权限控制、过滤非法请求等等。Filter 过滤器是面向切面编程（AOP）的一种实现。

Filter 是依赖于 Servlet 容器，如果要自定义过滤器的话，需要实现 javax.Servlet.Filter 接口，接口中有 3 个关键的方法：

public interface Filter {

	/**
	 * 初始化过滤器后执行的操作
	 */
	public default void init(FilterConfig filterConfig) throws ServletException {
	}
	
	/**
	 * 对请求进行过滤操作
	 */
	public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException;
           
    /**
	 * 销毁过滤器前执行的操作
	 */
    public default void destroy() {
    }
}

这三个方法也是 Fiter 的生命周期方法：

• init() ：在构造器被调用后，紧接着被调用，用来初始化 Filter（Filter 对象只会创建一次，init 方法也只会执行一次）；
• doFilter() ：每一次拦截时都会调用，因此可以被多次重复调用；
• destroy() ：在过滤器被销毁前调用的方法，主要用来执行一些释放资源的操作。

二、Filter 的拦截过程

---

Filter 过滤器对请求拦截的过程为：

• 1、用户发送请求到 web 服务器后，请求会先到过滤器；
• 2、过滤器会对请求进行一些处理，比如过滤请求的参数、判断接口的访问权限等等；
• 3、执行其他过滤器，全部过滤器执行完毕后发送到 Controller 层执行用户请求；
• 4、用户请求执行完毕后回到过滤器进行 response 内容的处理；
• 5、最后返回给用户。

流程图如下：

三、自定义 Filter

---

自定义过滤器，需要实现 javax.Servlet.Filter 接口：

@Component
@Slf4j
public class MyFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("初始化过滤器：" + filterConfig.getFilterName());
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {

        HttpServletRequest httpRequest = (HttpServletRequest) request;
        HttpServletResponse httpResponse = (HttpServletResponse) response;

        // 对请求进行过滤操作处理
        log.info("MyFilter 开始对请求进去过滤操作！");
        String requestURI = httpRequest.getRequestURI();
        log.info("请求地址：" + requestURI);

        // 继续执行下一个 Filter，如果没有其他 Filter 的话就执行 Controller 层代码
        long startTime = System.currentTimeMillis();
        chain.doFilter(request, response);

        // 执行完用户请求后，回到这里对 response 响应内容做一些处理
        long endTime = System.currentTimeMillis();
        log.info("请求处理完毕，所花费时间为：" + (endTime - startTime) + "ms");
    }

    @Override
    public void destroy() {
        log.info("销毁过滤器 MyFilter");
    }

}

如果有多个自定义 Filter 的话，可以通过 @Order() 注解进行控制执行顺序，该注解中需要提供一个顺序值，数字越小表示越先执行，比如，@Order(1) 修饰的过滤器比 @Order(2) 修饰的过滤器先执行，但 response 返回的时候的执行顺序反过来。

TODO：获取响应内容并对其进行封装…