【Spring MVC 系列】Spring MVC 中 Filter 配置的 6 种方式,看看你了解哪些

简介: Filter 简介过滤器 Filter 在 Servlet 2.3 版本中被首次提出,唯一的作用就是过滤,它不仅可以过滤请求,还可以过滤响应,当请求到达 Servlet 容器,会先经过 Filter ,然后再交给 Servlet,之后 Filter 还可以对 Servlet 的响应进一步处理。并且多个 Filter 还能形成一个链。使用图示表达如下。

Filter 简介


过滤器 Filter 在 Servlet 2.3 版本中被首次提出,唯一的作用就是过滤,它不仅可以过滤请求,还可以过滤响应,当请求到达 Servlet 容器,会先经过 Filter ,然后再交给 Servlet,之后 Filter 还可以对 Servlet 的响应进一步处理。并且多个 Filter 还能形成一个链。使用图示表达如下。


image.png


Filter 的特性使得 Filter 可以对请求或响应进行包装,修改请求头、请求体、响应头、响应体。由于请求先到达 Filter,Filter 还可以做一些全局性的工作,例如日志打印、登录校验等等。


Filter 生命周期


Filter 作为一个接口,具体实现由用户负责,先看这个接口的定义。


public interface Filter {
    public void init(FilterConfig filterConfig) throws ServletException;
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException;
    public void destroy();
}


Filter 中定义了三个方法。


init:这是 Filter 的初始化方法,这个方法只会被容器调用一次,方法参数 FilterConfig 表示 Filter 的配置,可以利用这个参数读取初始化参数、ServletContext 等。

doFilter:这是 Filter 处理请求的核心方法,当请求到达时容器先回调这个方法处理请求,除了 request、response,这个方法还可以拿到过滤器链 FilterChain 对象,只有调用了 FilterChain#doFilter方法,容器才会使用过滤器链中的下一个过滤器处理请求,如果当前 Filter 已经是链中的最后一个,则会交给 Servlet 处理。

destroy:容器停止时回调的方法,用于做一些资源清理的工作。

Spring MVC 内置 Filter

针对一些通用的场景,Spring MVC 内置了一些 Filter,下面看常用的有哪些。


CharacterEncodingFilter:用于设置请求体、响应体字符集的过滤器,使用这个过滤器可以统一字符编码,避免出现乱码现象。

CorsFilter:这是用来处理跨域的过滤器,请求到达这个过滤器时,会根据配置添加跨域相关的响应头。


FormContentFilter:对于请求方法为PUT、PATCH、DELETE,内容类型为表单application/x-www-form-urlencoded的请求,请求体中的参数无法通过 ServletRequest#getParameter 方法读取,这个过滤器对请求已经包装,以便可以通过 #getParameter 方法读取参数。

Spring MVC 中的 Filter 配置

自从 Spring MVC 提供拦截器 HandlerInterceptor 之后,过滤器 Filter 的一部分功能已经可以搬到拦截器了,但有时还是会不可避免的使用到过滤器,如跨域处理。因此需要自定义过滤器 Filter,并配置到 Servlet 容器中,Spring MVC 在不同的阶段也提供了不同的配置方案,具体来说主要有 6 种。


1. 配置文件 web.xml 配置


Spring MVC 基于 Servlet 规范,Spring 早期,Servlet 和 Filter 配置方式与传统的 Java Web 项目并没有任何区别,需要在 web.xml 配置 Filter 清单。示例如下。


<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
          http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    <filter>
        <filter-name>cors</filter-name>
        <filter-class>com.zzuhkp.mvc.CorsFilter</filter-class>
        <init-param>
            <param-name>allowedMethods</param-name>
            <param-value>GET,POST</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>cors</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>


2. @WebFilter 注解配置


Java 5 注解诞生后,Servlet 在 3.0 新引入了 @WebFilter 注解,用来替代 web.xml 文件中 Filter 的配置。Servlet 容器启动后会扫描类路径下的文件,遇到携带 @WebFilter 的注解后就会将这个类注册到容器中。因此在 Spring MVC 环境下也可以直接使用这个注解,和 xml 配置等同的注解配置如下。


@WebFilter(urlPatterns = "/*", initParams = {@WebInitParam(name = "allowedMethods", value = "GET,POST")})
public class CorsFilter implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        chain.doFilter(request, response);
    }
}


3. ServletContainerInitializer 配置


除了常规的 Servlet 规范中的 xml 和 @WebFilter 配置方式, Servlet 3.0 规范还提供了一个 ServletContainerInitializer 接口,Servlet 容器启动后会扫描类路径,标注了 @HandlesTypes 注解的 ServletContainerInitializer 接口实现将会被回调。因此,在 Spring MVC 中也可以利用这个特性添加 Filter,具体代码如下。


@HandlesTypes({})
public class FilterInitializer implements ServletContainerInitializer {
    @Override
    public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException {
        FilterRegistration.Dynamic dynamic = ctx.addFilter("cors", new CorsFilter());
        dynamic.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), true, "/*");
        dynamic.setInitParameter("allowedMethods","GET,POST");
    }
}


4. WebApplicationInitializer 配置


Spring 3.1 版本利用了上述 Servlet 规范中 ServletContainerInitializer 的特性,提供了这个接口的实现 SpringServletContainerInitializer,并在实现中回调了 Spring 提供的 WebApplicationInitializer 接口。因此,Spring MVC 环境也可以直接实现 WebApplicationInitializer 来手动配置 Filter。注意:只需要实现接口,无需特定配置,Servlet 容器会把这个类告诉 SpringServletContainerInitializer。示例代码如下。


public class CorsWebApplicationInitializer implements WebApplicationInitializer {
    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        FilterRegistration.Dynamic dynamic = servletContext.addFilter("cors", new CorsFilter());
        dynamic.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), true, "/*");
        dynamic.setInitParameter("allowedMethods", "GET,POST");
    }
}


5. Spring Bean 配置


除了普通 Spring MVC 环境下的配置,Spring Boot 环境中,Spring Boot 1.4 及之后版本下还可以直接将 Filter 注册为 Bean,Filter Bean 将应用到所有的请求中。示例代码如下。


@Component
public class CorsFilter implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        chain.doFilter(request, response);
    }
}


6. FilterRegistrationBean 配置


FilterRegistrationBean 同样是 Spring Boot 1.4 版本提出的一个新类型,这个类允许指定过滤的请求路径,将这个类配置为 Bean 即可。示例代码如下。


@Configuration
public class MvcConfig {
    @Bean
    public FilterRegistrationBean<CorsFilter> filterRegistrationBean() {
        FilterRegistrationBean<CorsFilter> bean = new FilterRegistrationBean<>(new CorsFilter());
        bean.addUrlPatterns("/*");
        bean.addInitParameter("allowedMethods", "GET,POST");
        return bean;
    }
}


总结

本文主要对 Filter 的概念做了简单介绍,并介绍了几种 Spring MVC 内置的 Filter,最后介绍了 6 种在 Spring MVC 配置 Filter 的方式,其中 web.xml、@WebFilter、ServletContainerInitializer、WebApplicationInitializer 这 4 种配置方式适用于普通的 Spring MVC 环境,Filter Bean 配置、FilterRegistrationBean Bean 配置 适用于 Spring Boot 环境下的 Spring MVC,读者需要加以留意。


目录
相关文章
|
缓存 安全 Java
《深入理解Spring》过滤器(Filter)——Web请求的第一道防线
Servlet过滤器是Java Web核心组件,可在请求进入容器时进行预处理与响应后处理,适用于日志、认证、安全、跨域等全局性功能,具有比Spring拦截器更早的执行时机和更广的覆盖范围。
|
前端开发 Java 微服务
《深入理解Spring》:Spring、Spring MVC与Spring Boot的深度解析
Spring Framework是Java生态的基石,提供IoC、AOP等核心功能;Spring MVC基于其构建,实现Web层MVC架构;Spring Boot则通过自动配置和内嵌服务器,极大简化了开发与部署。三者层层演进,Spring Boot并非替代,而是对前者的高效封装与增强,适用于微服务与快速开发,而深入理解Spring Framework有助于更好驾驭整体技术栈。
|
SQL Java 数据库连接
Spring、SpringMVC 与 MyBatis 核心知识点解析
我梳理的这些内容,涵盖了 Spring、SpringMVC 和 MyBatis 的核心知识点。 在 Spring 中,我了解到 IOC 是控制反转,把对象控制权交容器;DI 是依赖注入,有三种实现方式。Bean 有五种作用域,单例 bean 的线程安全问题及自动装配方式也清晰了。事务基于数据库和 AOP,有失效场景和七种传播行为。AOP 是面向切面编程,动态代理有 JDK 和 CGLIB 两种。 SpringMVC 的 11 步执行流程我烂熟于心,还有那些常用注解的用法。 MyBatis 里,#{} 和 ${} 的区别很关键,获取主键、处理字段与属性名不匹配的方法也掌握了。多表查询、动态
511 0
|
Java API Spring
在 Spring 配置文件中配置 Filter 的步骤
【10月更文挑战第21天】在 Spring 配置文件中配置 Filter 是实现请求过滤的重要手段。通过合理的配置,可以灵活地对请求进行处理,满足各种应用需求。还可以根据具体的项目要求和实际情况,进一步深入研究和优化 Filter 的配置,以提高应用的性能和安全性。
|
搜索推荐 Java Spring
Spring Filter深度解析
【10月更文挑战第21天】Spring Filter 是 Spring 框架中非常重要的一部分,它为请求处理提供了灵活的控制和扩展机制。通过合理配置和使用 Filter,可以实现各种个性化的功能,提升应用的安全性、可靠性和性能。还可以结合具体的代码示例和实际应用案例,进一步深入探讨 Spring Filter 的具体应用和优化技巧,使对它的理解更加全面和深入。
|
SQL Java 数据库连接
对Spring、SpringMVC、MyBatis框架的介绍与解释
Spring 框架提供了全面的基础设施支持,Spring MVC 专注于 Web 层的开发,而 MyBatis 则是一个高效的持久层框架。这三个框架结合使用,可以显著提升 Java 企业级应用的开发效率和质量。通过理解它们的核心特性和使用方法,开发者可以更好地构建和维护复杂的应用程序。
1137 29
|
缓存 前端开发 Java
【Java面试题汇总】Spring,SpringBoot,SpringMVC,Mybatis,JavaWeb篇(2023版)
Soring Boot的起步依赖、启动流程、自动装配、常用的注解、Spring MVC的执行流程、对MVC的理解、RestFull风格、为什么service层要写接口、MyBatis的缓存机制、$和#有什么区别、resultType和resultMap区别、cookie和session的区别是什么?session的工作原理
【Java面试题汇总】Spring,SpringBoot,SpringMVC,Mybatis,JavaWeb篇(2023版)
|
Java 数据库连接 Spring
后端框架入门超详细 三部曲 Spring 、SpringMVC、Mybatis、SSM框架整合案例 【爆肝整理五万字】
文章是关于Spring、SpringMVC、Mybatis三个后端框架的超详细入门教程,包括基础知识讲解、代码案例及SSM框架整合的实战应用,旨在帮助读者全面理解并掌握这些框架的使用。
后端框架入门超详细 三部曲 Spring 、SpringMVC、Mybatis、SSM框架整合案例 【爆肝整理五万字】
|
前端开发 Java 应用服务中间件
我以为我对Spring MVC很了解,直到我遇到了...
所有人都知道Spring MVC是是开发的,却鲜有人知道Spring MVC的理论基础来自于1978 年提出MVC模式的一个老头子,他就是Trygve Mikkjel Heyerdahl Reenskaug,挪威计算机科学家,名誉教授。Trygve Reenskaug的MVC架构思想早期用于图形用户界面(GUI) 的软件设计,他对MVC是这样解释的。MVC 被认为是解决用户控制大型复杂数据集问题的通用解决方案。最困难的部分是为不同的架构组件想出好的名字。模型-视图-编辑器是第一个。
495 1
我以为我对Spring MVC很了解,直到我遇到了...
|
前端开发 Java 应用服务中间件
【Spring】Spring MVC的项目准备和连接建立
【Spring】Spring MVC的项目准备和连接建立
342 2