SpringBoot系列教程web篇之过滤器Filter使用指南

web三大组件之一Filter，能够说是不少小伙伴学习java web时最先接触的知识点了，然而学得早不表明就用得多。基本上，若是不是让你从0到1写一个web应用（或者说即使从0到1写一个web应用），在你的平常业务开发中不太可能碰到须要手写Filter的场景

本文将简单介绍写什么是Filter，以及在SpringBoot中使用Filter的通常姿式与常见问题

原文查看: SpringBoot系列教程web篇之过滤器Filter使用指南

I. 背景

在正式开始以前，有必要先简单看一下什么是Filter（过滤器），以及这个有什么用

1. Filter说明

Filter，过滤器，属于Servlet规范，并非Spring独有的。其做用从命名上也能够看出一二，拦截一个请求，作一些业务逻辑操做，而后能够决定请求是否能够继续往下分发，落到其余的Filter或者对应的Servlet

简单描述下一个http请求过来以后，一个Filter的工做流程：

• 首先进入filter，执行相关业务逻辑
• 若断定通行，则进入Servlet逻辑，Servlet执行完毕以后，又返回Filter，最后在返回给请求方
• 断定失败，直接返回，不须要将请求发给Servlet

插播一句：上面这个过程，和AOP中的@Around环绕切面的做用差很少

2. 项目搭建

接下来咱们搭建一个web应用方便后续的演示，借助SpringBoot搭建一个web应用属于比较简单的活;

建立一个maven项目，pom文件以下

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.7</version>
    <relativePath/> <!-- lookup parent from update -->
</parent>

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
    <java.version>1.8</java.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.45</version>
    </dependency>
</dependencies>

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </pluginManagement>
</build>
<repositories>
    <repository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>https://repo.spring.io/milestone</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>
复制代码

II. Filter教程

1. 使用说明

在SpringBoot项目中，若是须要自定义一个Filter，并无什么特殊的地方，直接实现接口便可，好比下面一个输出请求日志的拦截器

@Slf4j
@WebFilter
public class ReqFilter implements Filter {
    public ReqFilter() {
        System.out.println("init reqFilter");
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest req = (HttpServletRequest) request;
        log.info("url={}, params={}", req.getRequestURI(), JSON.toJSONString(req.getParameterMap()));
        chain.doFilter(req, response);
    }

    @Override
    public void destroy() {
    }
}
复制代码

实现一个自定义的Filter容易，通常有两个步骤

• 实现 Filter 接口
• 在doFilter方法中添加业务逻辑，若是容许访问继续，则执行chain.doFilter(req, response);； 不执行上面这一句，则访问到此为止

接下来的一个问题就是如何让咱们自定义的Filter生效，在SpringBoot项目中，有两种常见的使用方式

• @WebFilter
• 包装Bean: FilterRegistrationBean

a. WebFilter

这个注解属于Servlet3+，与Spring也没有什么关系，因此问题来了，当我在Filter上添加了这个注解以后，Spring怎么让它生效呢?

• 配置文件中显示使用注解 @ServletComponentScan

@ServletComponentScan
@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }
}
复制代码

WebFilter经常使用属性以下，其中urlPatterns最为经常使用，表示这个filter适用于哪些url请求（默认场景下所有请求都被拦截）

属性名	类型	描述
filterName	String	指定过滤器的 name 属性，等价于
value	String[]	该属性等价于 urlPatterns 属性。可是二者不该该同时使用。
urlPatterns	String[]	指定一组过滤器的 URL 匹配模式。等价于 标签。
servletNames	String[]	指定过滤器将应用于哪些 Servlet。取值是 @WebServlet 中的 name 属性的取值，或者是 web.xml 中 的取值。
dispatcherTypes	DispatcherType	指定过滤器的转发模式。具体取值包括：ASYNC、ERROR、FORWARD、INCLUDE、REQUEST。
initParams	WebInitParam[]	指定一组过滤器初始化参数，等价于 标签。
asyncSupported	boolean	声明过滤器是否支持异步操做模式，等价于 标签。
description	String	该过滤器的描述信息，等价于 标签。
displayName	String	该过滤器的显示名，一般配合工具使用，等价于 标签。

b. FilterRegistrationBean

上面一种方式比较简单，后面会说到有个小问题，指定Filter的优先级比较麻烦，

下面是使用包装bean注册方式

@Bean
public FilterRegistrationBean<OrderFilter> orderFilter() {
    FilterRegistrationBean<OrderFilter> filter = new FilterRegistrationBean<>();
    filter.setName("reqFilter");
    filter.setFilter(new ReqFilter());
    // 指定优先级
    filter.setOrder(-1);
    return filter;
}
复制代码

2. 常见问题

上面整完，就能够开始测试使用过滤器了，在进入实测环节以前，先来看两个常见的问题

• Filter做为Servelt的组件，怎么与SpringBoot中的Bean交互
• 多个Filter之间的优先级怎么肯定

a. Filter依赖Bean注入问题

若是有小伙伴使用SpringMVC + web.xml方式来定义Filter，就会发现自定义的Filter中没法经过@Autowired方式来注入Spring的bean

我以前使用的是spring4 Servlet2+ ，存在上面的问题，若是有不一样观点请留言告诉我，感谢

SpringBoot中能够直接注入依赖的Bean，从上面的第二种注册方式能够看到，Spring将Filter封装成了一个Bean对象，所以能够直接注入依赖的Bean

下面定义一个AuthFilter，依赖了自定义的DemoBean

@Data
@Component
public class DemoBean {
    private long time;

    public DemoBean() {
        time = System.currentTimeMillis();
    }

    public void show() {
        System.out.println("demo bean!!! " + time);
    }
}


@Slf4j
@WebFilter
public class AuthFilter implements Filter {
    @Autowired
    private DemoBean demoBean;

    public AuthFilter() {
        System.out.println("init autFilter");
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        log.info("in auth filter! {}", demoBean);
        // 测试，用header中的 tx-demo 来判断是否为认证的请求
        HttpServletRequest req = (HttpServletRequest) request;
        String auth = req.getHeader("tx-demo");
        if ("yihuihui".equals(auth)) {
            // 只有认证的请求才容许访问，请求头中没有这个时，不执行下面的的方法，则表示请求被过滤了
            // 在测试优先级时打开下面的注释
            // chain.doFilter(request, response);
        } else {
            chain.doFilter(request, response);
        }
    }

    @Override
    public void destroy() {

    }
}
复制代码

b. 优先级指定

Filter的优先级指定，经过个人实际测试，@Order注解没有用，继承 Ordered接口也没有用，再不考虑web.xml的场景下，只能经过在注册Bean的时候指定优先级

实例以下，三个Filter，两个经过@WebFilter注解方式注册，一个经过FilterRegistrationBean方式注册

@Slf4j
@Order(2)
@WebFilter
public class AuthFilter implements Filter, Ordered {
  ...
}

@Slf4j
@Order(1)
@WebFilter
public class ReqFilter implements Filter, Ordered {
  ...
}

@Slf4j
public class OrderFilter implements Filter {
}

@ServletComponentScan
@SpringBootApplication
public class Application {
    @Bean
    public FilterRegistrationBean<OrderFilter> orderFilter() {
        FilterRegistrationBean<OrderFilter> filter = new FilterRegistrationBean<>();
        filter.setName("orderFilter");
        filter.setFilter(new OrderFilter());
        filter.setOrder(-1);
        return filter;
    }


    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }

}
复制代码

3. 测试

上面定义了三个Filter，咱们主要验证下优先级，若是@Order注解生效，那么执行的前后顺序应该是

OrderFilter -> ReqFilter -> AuthFilter

若是不是上面的顺序，那么说明@Order注解没有用

@RestController
public class IndexRest {
    @GetMapping(path = {"/", "index"})
    public String hello(String name) {
        return "hello " + name;
    }
}
复制代码

（上文截图源码来自: org.apache.catalina.core.ApplicationFilterFactory#createFilterChain）

上面是测试时关键链路的断点截图，从数组中能够看出 AuthFilter的优先级大于ReqFilter， 下面实际的输出也说明了@Order注解不能指定Filter的优先级（不知道为何网络上有大量使用Order来指定Filer优先级的文章!!!）

接下来咱们的问题就是WebFilter注解来注册的Filter的优先级是怎样的呢，咱们依然经过debug来看，关键代码路径为: org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext#selfInitialize

• OrderFiler是咱们手动注册并设置优先级为-1
• ReqFilter, AuthFilter经过 WebFillter方式注册，默认优先级为2147483647，相同优先级的状况下，根据名字前后顺序来决定

III. 小结

本文主要介绍了过滤器Filter的使用方式，以及常见的两个问题解答，文中内容穿插了一点源码的分析截图，并未深刻，若有兴趣的同窗能够根据文中提的几个关键位置探索一番

下面简单小结下文中内容

1. Filter使用

自定义Filter的实现

• 实现Filter接口
• doFilter方法中，显示调用chain.doFilter(request, response);表示请求继续；不然表示请求被过滤

注册生效

• @ServletComponentScan自动扫描带有@WebFilter注解的Filter
• 建立Bean: FilterRegistrationBean 来包装自定义的Filter

2. IoC/DI

在SpringBoot中Filter能够和通常的Bean同样使用，直接经过Autowired注入其依赖的Spring Bean对象

3. 优先级

经过建立FilterRegistrationBean的时候指定优先级，以下

@Bean
public FilterRegistrationBean<OrderFilter> orderFilter() {
    FilterRegistrationBean<OrderFilter> filter = new FilterRegistrationBean<>();
    filter.setName("orderFilter");
    filter.setFilter(new OrderFilter());
    filter.setOrder(-1);
    return filter;
}
复制代码

此外格外注意, @WebFilter声明的Filter，优先级为2147483647(最低优先级)

• @Order注解不能指定Filter优先级
• @Order注解不能指定Filter优先级
• @Order注解不能指定Filter优先级

IV. 其余

web系列博文

• 191012-SpringBoot系列教程web篇之自定义异常处理HandlerExceptionResolver
• 191010-SpringBoot系列教程web篇之全局异常处理
• 190930-SpringBoot系列教程web篇之40四、500异常页面配置
• 190929-SpringBoot系列教程web篇之重定向
• 190913-SpringBoot系列教程web篇之返回文本、网页、图片的操做姿式
• 190905-SpringBoot系列教程web篇之中文乱码问题解决
• 190831-SpringBoot系列教程web篇之如何自定义参数解析器
• 190828-SpringBoot系列教程web篇之Post请求参数解析姿式汇总
• 190824-SpringBoot系列教程web篇之Get请求参数解析姿式汇总
• 190822-SpringBoot系列教程web篇之Beetl环境搭建
• 190820-SpringBoot系列教程web篇之Thymeleaf环境搭建
• 190816-SpringBoot系列教程web篇之Freemaker环境搭建
• 190421-SpringBoot高级篇WEB之websocket的使用说明
• 190327-Spring-RestTemplate之urlencode参数解析异常全程分析
• 190317-Spring MVC之基于java config无xml配置的web应用构建
• 190316-Spring MVC之基于xml配置的web应用构建
• 190213-SpringBoot文件上传异常之提示The temporary upload location xxx is not valid

项目源码

• 工程：github.com/liuyueyi/sp…
• 项目：github.com/liuyueyi/sp…

1. 一灰灰Blog

尽信书则不如，以上内容，纯属一家之言，因我的能力有限，不免有疏漏和错误之处，如发现bug或者有更好的建议，欢迎批评指正，不吝感激

下面一灰灰的我的博客，记录全部学习和工做中的博文，欢迎你们前去逛逛

• 一灰灰Blog我的博客 blog.hhui.top
• 一灰灰Blog-Spring专题博客 spring.hhui.top