Servlet 之 Filter

作者: AlphaHinex | 来源:发表于2021-10-17 15:37 被阅读0次

Servlet学习6--过滤器
Servlet 之 Filter
传统 Servlet 应用
Interceptor和Filter区别
拦截器
javaee 02 servlet
2022-03-21 Web基础知识（7）- Servlet (
006_JavaWeb中的过滤器Filter的使用
JavaWeb（十五）Filter
Java Web开发中的过滤器(Filter)

原文地址：https://wyiyi.github.io/amber/2021/10/01/filter/

cover

description: "Filter 不仅能前置处理 Request，也能后置处理 Response，不过后置处理时，要注意 Response 一旦被提交了，就不能再被修改了"
date: 2021.10.17 10:34
categories:
- Java
tags: [Servlet]
keywords: Servlet, filter, response is commited

原文地址：https://wyiyi.github.io/amber/2021/10/01/filter/

Servlet 作为Java Web 的基础，在 Servlet API 中提供了一个 Filter 接口，Filter，又称过滤器。
所谓过滤器顾名思义是用来过滤的，可以从客户端向服务端发送请求进行过滤，也可以对服务器返回响应进行处理。

image

根据上面的流程可以看出，Filter的作用就是在用户请求到达Servlet之前，进行拦截。在拦截到用户的请求后，我们可以实现一些自定义的业务逻辑。
例如：实现URL级别的权限访问控制（最常用）、字符编码、登录限制、过滤敏感词汇、文件压缩，跨域设置等一些高级功能。

生命周期

Filter 与 Servlet 一样都是由服务器负责创建和销毁的，Filter 只会被创建和销毁一次，doFilter 可以执行多次。

在 Web 应用程序启动时，服务器会根据程序的 web.xml 文件中的配置信息调用 init() 方法初始化 Filter。
初始化后，过滤器会对请求进行拦截并调用 doFilter() 方法。
在应用程序关闭时，调用 destroy() 方法销毁 Filter。

应用

将 Java 类实现 javax.servlet.Filter 接口，重写 doFilter() 方法（init()，destroy() 也可重写）

public class AFilter implements Filter {
   @Override
   public void init(FilterConfig filterConfig) {}

   @Override
   public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) {}

   @Override
   public void destroy() {}
}

一、注册 Filter 方式

1、通过传统的 web.xml 方式注册。

   <filter>
      <filter-name>AFilter</filter-name>
          <filter-class>com.amber.demo.filter.AFilter</filter-class>
   </filter>
   <filter-mapping>
      <filter-name>AFilter</filter-name>
      <url-pattern>/*</url-pattern>
   </filter-mapping>

2、注解方式： @WebFilter，该方式是 web3.0 提供的注解，代替在 web.xml 文件中配置 filter，简化了开发。

@WebFilter(urlPatterns = "/*")
public class AFilter implements Filter {
   // 同上...
}

三、FilterChain 的 chain.doFilter

image

1、在 chain.doFilter 中使用 @WebFilter 注解，会按照类名的字典顺序执行

@Component
@WebFilter(filterName = "aFilter", value = "/*")
public class AFilter implements Filter {
   private static final Logger LOGGER = LoggerFactory.getLogger(AFilter.class);
   
   @Override
   public void init(FilterConfig filterConfig) {
       LOGGER.info("Filter初始化,只初始化一次...");
   }

   @Override
   public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
       LOGGER.info("拦截前执行...");
       chain.doFilter(request,response);
       LOGGER.info("拦截后执行...");
   }

   @Override
   public void destroy() {
       LOGGER.info("Filter销毁...");
   }
  // BFilter、CFilter 同上
}

以 AFilter、BFilter、CFilter 为例，执行的过滤器的顺序输出为：

2021-09-17 14:53:41.116  INFO 2024 --- [nio-8040-exec-1] com.amber.demo.filter.AFilter: A 拦截前执行...
2021-09-17 14:53:41.117  INFO 2024 --- [nio-8040-exec-1] com.amber.demo.filter.BFilter: B 拦截前执行...
2021-09-17 14:53:41.117  INFO 2024 --- [nio-8040-exec-1] com.amber.demo.filter.CFilter: C 拦截前执行...
2021-09-17 14:53:42.230  INFO 2024 --- [nio-8040-exec-1] com.amber.demo.filter.CFilter: C 拦截后执行...
2021-09-17 14:53:42.230  INFO 2024 --- [nio-8040-exec-1] com.amber.demo.filter.BFilter: B 拦截后执行...
2021-09-17 14:53:42.230  INFO 2024 --- [nio-8040-exec-1] com.amber.demo.filter.AFilter: A 拦截后执行...

2、调整 FilterChain 的执行顺序

由于注解@WebFilter的源码（如下）中没有参数指定顺序，但是在Spring中提供了 @Order 注解可以指定Filter的执行顺序。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface WebFilter {
   String description() default "";

   String displayName() default "";

   WebInitParam[] initParams() default {};

   String filterName() default "";

   String smallIcon() default "";

   String largeIcon() default "";

   String[] servletNames() default {};

   String[] value() default {};

   String[] urlPatterns() default {};

   DispatcherType[] dispatcherTypes() default {DispatcherType.REQUEST};

   boolean asyncSupported() default false;
}

@Order 注解： Order 值越小执行优先级越高。(注意：filterName 的值首字母小写，否则顺序会不生效)

@Order(-1)
@WebFilter(filterName = "aFilter", value = "/*")
@Component
public class AFilter implements Filter {
  // 方法同上
}

新增配置文件，通过 FilterRegistrationBean 实例注册并定义Order的属性（注意：过滤器的Bean类的注解只保留@Component）

@Configuration
public class ComponentFilterOrderConfig {

   @Bean
   public FilterRegistrationBean filterBeanOne() {
       FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
       filterRegistrationBean.setFilter(new AFilter());
       filterRegistrationBean.addUrlPatterns("/*");
       filterRegistrationBean.setOrder(3);
       return filterRegistrationBean;
   }

   @Bean
   public FilterRegistrationBean filterBeanTwo() {
       FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
       filterRegistrationBean.setFilter(new BFilter());
       filterRegistrationBean.addUrlPatterns("/*");
       filterRegistrationBean.setOrder(2);
       return filterRegistrationBean;
   }

   @Bean
   public FilterRegistrationBean filterBeanThree() {
       FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
       filterRegistrationBean.setFilter(new CFilter());
       filterRegistrationBean.addUrlPatterns("/*");
       filterRegistrationBean.setOrder(1);
       return filterRegistrationBean;
   }
}

@Component
public class AFilter implements Filter {
  ... AFilter、BFilter、CFilter 同上...
}

执行的过滤器的顺序输出为：

2021-09-22 09:58:50.537  INFO 2816 --- [nio-8040-exec-1] com.amber.demo.filter.CFilter  : C 拦截后执行...
2021-09-22 09:58:50.537  INFO 2816 --- [nio-8040-exec-1] com.amber.demo.filter.BFilter  : B 拦截后执行...
2021-09-22 09:58:50.537  INFO 2816 --- [nio-8040-exec-1] com.amber.demo.filter.AFilter  : A 拦截后执行...
2021-09-22 09:58:50.537  INFO 2816 --- [nio-8040-exec-1] com.amber.demo.filter.AFilter  : A 拦截后执行...
2021-09-22 09:58:50.537  INFO 2816 --- [nio-8040-exec-1] com.amber.demo.filter.BFilter  : B 拦截后执行...
2021-09-22 09:58:50.537  INFO 2816 --- [nio-8040-exec-1] com.amber.demo.filter.CFilter  : C 拦截后执行...

3、设置请求或响应(Request、Response)