SptingBoot过滤器Filter的使用详解

Filter

Filter属于Servlet规范，并不是Spring独有的。Filter主要用于拦截请求，做一些业务逻辑操作，然后可以决定请求是否可以继续往下分发，落到其他的Filter或者对应的Servlet。

Filter的工作流程

1. 进入filter，执行相关业务逻辑
2. 若判定失败，直接返回，不需要将请求发给Servlet
3. 若判定通行，进行入下一个filter
4. 如果全部filter通行，进入Servlet逻辑，Servlet执行完毕之后，又返回Filter，最后在返回给请求方

自定义Filter的使用方式

Spring中过滤器Filter不同使用方式都是通过：FilterRegistrationBean包装filter，最终注册到Servlet容器中。

1. @WebFilter+@ServletComponentScan

在SpringBootApplication上添加@ServletComponentScan注解，在Filter上添加@WebFilter注解。

该方式的缺点：无法设置过滤器之间的优先级。

@WebFilter+@ServletComponentScan方式无法通过@Order注解指定过滤器优先级：优先级使用默认值Ordered.LOWEST_PRECEDENCE（2147483647），相同优先级的情况下，根据名字先后顺序来决定。

使用方法

1. 在SpringBootApplication上使用@ServletComponentScan注解

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

2.在Filter上使用@WebFilter注解

@WebFilter(urlPatterns = {"/test3"})
public class MyFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        System.out.println("======= MyFilter =======");
        filterChain.doFilter(request,response);
    }
}

@WebFilter

@WebFilter用于将一个类声明为过滤器。

WebFilter注解的主要属性：

在SpringBoot项目中，@WebServlet、@WebFilter、@WebListener这三个注解默认是不会被扫描的，一般在SpringBootApplication上添加@ServletComponentScan注解，表示对这三个注解的扫描。

@ServletComponentScan可以实现將Servlet（控制器）、Filter（过滤器）、Listener（监听器）自动注册到Spring容器中，无需其他代码。

• Servlet：通过@WebServlet注解定义
• Filter：通过@WebFilter注解定义
• Listener：通过@WebListener注解定义

常见问题分析

1. 只使用@WebFilte：过滤器不生效

WebFilter属于注解属于Servlet3+，与Spring本身没有什么关系，所以Spring默认是不认识这个注解的。

2. @WebFilter+@Component：配置的过滤条件不生效 同上，Spring是不认识@WebFilter注解的，所以注解配置的任何属性都无意义（例如：指定过滤的url）。 该种方式其实就等同于只加了个@Component注解，此时过滤器能生效，但无过滤条件，会过滤所有url。

3. @WebFilter+@Component+@ServletComponentScan：过滤器会被调用两次

• 一次：@WebFilter+@ServletComponentScan，被SpringBean管理，过滤器生效，根据@WebFilter配置的属性过滤
• 二次：@Component，又被SpringBean管理一次，过滤器生效（和上面不是同一个bean），过滤全部url

4. @WebFilter+@Order+@ServletComponentScan：设置过滤器优先级无效

通过@WebFilter+@ServletComponentScan方式注册的，其生成的FilterRegistrationBean并没有检查@Order注解，所以@Order注解不生效。

2. @Component+@Order

通过在Filter上加@Component和@Order注解，即可被Spring管理，并可指定过滤器的执行顺序。

该方式的缺点：只能过滤所有URL，不能通过配置去过滤指定的 URL。

使用方法

@Order(100)
@Component
public class MyFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        System.out.println("======= MyFilter =======");
        filterChain.doFilter(request,response);
    }
}

3. FilterRegistrationBean（推荐）

直接通过配置类定义Filter的FilterRegistrationBean，交给SpringBean容器管理。

该方式既能通过配置去过滤指定的 URL，也能指定过滤器之间的优先级。

使用方法

public class MyFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        System.out.println("======= MyFilter =======");
        filterChain.doFilter(request,response);
    }
}

@Configuration
public class FilterConfig {
    @Bean
    public FilterRegistrationBean<MyFilter> filterRegistrationBean() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(myFilter());
        registration.setName("myFilter");
        registration.addUrlPatterns("/test3");
        registration.setOrder(100);
        return registration;
    }
    @Bean
    public MyFilter myFilter() {
        return new MyFilter();
    }
}

到此这篇关于SptingBoot过滤器Filter的使用详解的文章就介绍到这了,更多相关SptingBoot过滤器内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

最新评论