WebMvcConfigurerAdapter 及其替代方案

WebMvcConfigurerAdapter 作用

WebMvcConfigurerAdapter 是 Spring 内部的一种配置方式，采用 JavaBean 的形式代替传统的 XML 配置文件形式，用于对 Spring MVC 框架进行个性化定制。它的主要作用是通过配置类来替代传统的 XML 文件，简化配置过程。在 Spring 5.0 以后，WebMvcConfigurerAdapter 被废弃，取而代之的是通过实现 WebMvcConfigurer 接口或继承 WebMvcConfigurationSupport 类来进行配置。

WebMvcConfigurerAdapter 的替代方案

在 Spring 5.0 之后，WebMvcConfigurerAdapter 被废弃，主要有两种替代方案：

实现 WebMvcConfigurer 接口：这种方法是官方推荐的，通过实现 WebMvcConfigurer 接口中的相关方法，可以灵活地进行配置，不会影响 Spring Boot 的自动配置特性。例如，可以选择性地实现需要的方法，而不必覆盖所有方法。

继承 WebMvcConfigurationSupport 类：这种方法相当于覆盖了 Spring Boot 自动配置中的所有方法，需要手动重写每一个方法，例如 addResourceHandlers 方法，才能确保静态资源能够正常访问。这种方法在项目复杂度较高的情况下可能有用，但通常不推荐，因为容易出现意料之外的错误。

使用示例

实现 WebMvcConfigurer 接口

以下是一个实现 WebMvcConfigurer 接口的示例，用于添加拦截器和跨域配置：

@Configuration
public class WebAppConfig implements WebMvcConfigurer {
    @Bean
    public HandlerInterceptor getLoginInterceptor() {
        return new LoginInterceptor();
    }
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(getLoginInterceptor())
                .addPathPatterns("/**")
                .excludePathPatterns("/error")
                .excludePathPatterns("/static/*");
    }
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/**")
                .addResourceLocations("classpath:/static/");
    }
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedOrigins("*")
                .allowCredentials(true)
                .allowedMethods("GET", "POST", "PUT", "DELETE")
                .maxAge(3600);
    }
}

继承 WebMvcConfigurationSupport 类

以下是一个继承 WebMvcConfigurationSupport 类的示例，用于覆盖默认的资源处理方法：

@Configuration
public class WebAppConfig extends WebMvcConfigurationSupport {
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**")
                .addResourceLocations("classpath:/META-INF/resources/")
                .addResourceLocations("classpath:/resources/")
                .addResourceLocations("classpath:/static/")
                .addResourceLocations("classpath:/public/");
        super.addResourceHandlers(registry);
    }
}

处理日期时间序列化

在 Spring Boot 中，默认的日期序列化行为可能会将日期转换为 UTC 格式。如果需要将日期转换为 ISO 8601 格式，可以在 application.properties 文件中添加以下配置：

spring.jackson.serialization.write-dates-as-timestamps=true
spring.jackson.time-zone=GMT+8

过滤器配置

在 Spring Boot 中，可以通过实现 Filter 接口和 FilterRegistrationBean 类来配置过滤器。以下是一个使用 @WebFilter 注解配置过滤器的示例：

@WebFilter(urlPatterns = "/webapi/*", filterName = "authFilter")
public class AuthFilter implements Filter {
    // Filter 的实现细节
}

如果需要注册多个过滤器，可以通过 FilterRegistrationBean 类设置它们的执行顺序：

@Bean
public FilterRegistrationBean authFilterRegistration() {
    FilterRegistrationBean registration = new FilterRegistrationBean(new AuthFilter());
    registration.addUrlPatterns("/webapi/*");
    registration.setOrder(1); // 设置执行顺序
    return registration;
}

注意事项

实现接口的方法选择性：在实现 WebMvcConfigurer 接口时，只需要实现需要的方法，无需覆盖所有方法，这样可以避免因覆盖不当而导致的潜在问题。

多个过滤器的执行顺序：在注册多个过滤器时，需要通过 FilterRegistrationBean 的 setOrder 方法设置它们的执行顺序，数字越小，优先级越高。

过滤器的使用场景：过滤器适合在请求前后进行一些通用操作，如编码解码、日志记录等，适合于更粗粒度的拦截。

通过以上方法，可以灵活地对 Spring Boot 应用进行配置，充分发挥 Spring 的强大配置能力。

转载地址：http://jxpez.baihongyu.com/

你可能感兴趣的文章

WebMvcConfigurerAdapter 及 其 替代方案