在Spring MVC中统一处理日期格式化的消息转换器

李少兄

于 2024-01-08 09:15:00 发布

阅读量449

点赞数 9

分类专栏： Spring MVC 文章标签： spring mvc java

本文链接：https://blog.csdn.net/wenxuankeji/article/details/135445228

版权

Spring MVC 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

概述

在使用Spring MVC开发Web应用时，经常需要对日期进行格式化处理。为了避免重复代码并统一处理日期格式化，我们可以扩展Spring MVC的消息转换器。

本文将介绍如何通过扩展消息转换器，在Spring MVC中统一处理日期的格式化。

解决方案

我们可以通过扩展消息转换器来配置日期的格式化规则，实现统一处理日期格式化的需求。

步骤一：创建配置类

首先，创建一个配置类，并添加@Configuration注解。

@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
    // 配置内容将在下一步中添加
}

步骤二：扩展消息转换器

在WebMvcConfig类中，重写configureMessageConverters方法，并调用父类的configureMessageConverters方法以保留默认的消息转换器。

@Override
protected void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    super.configureMessageConverters(converters);
    
    // 在这里添加自定义的消息转换器
    extendMessageConverters(converters);
}

步骤三：创建日期格式化的消息转换器

在extendMessageConverters方法中，创建一个日期格式化的消息转换器，并配置日期格式化规则。

	/**
     * 扩展Spring MVC框架的消息转化器
     * @param converters
     */
    protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        log.info("扩展消息转换器...");
        //创建一个消息转换器对象
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        //需要为消息转换器设置一个对象转换器，对象转换器可以将Java对象序列化为json数据
        converter.setObjectMapper(new JacksonObjectMapper());
        //将自己的消息转化器加入容器中
        converters.add(0,converter);
    }

在上述代码中，我们创建了一个MappingJackson2HttpMessageConverter对象，用于处理JSON数据的转换。然后，创建一个JacksonObjectMapper对象，并配置日期的格式化规则。

/**
 * 对象映射器:基于jackson将Java对象转为json，或者将json转为Java对象
 * 将JSON解析为Java对象的过程称为 [从JSON反序列化Java对象]
 * 从Java对象生成JSON的过程称为 [序列化Java对象到JSON]
 */
public class JacksonObjectMapper extends ObjectMapper {

    public static final String DEFAULT_DATE_FORMAT = "yyyy-MM-dd";
    //public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";
    public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm";
    public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss";

    public JacksonObjectMapper() {
        super();
        //收到未知属性时不报异常
        this.configure(FAIL_ON_UNKNOWN_PROPERTIES, false);

        //反序列化时，属性不存在的兼容处理
        this.getDeserializationConfig().withoutFeatures(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);

        SimpleModule simpleModule = new SimpleModule()
                .addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)))
                .addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)))
                .addDeserializer(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)))
                .addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)))
                .addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)))
                .addSerializer(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));

        //注册功能模块 例如，可以添加自定义序列化器和反序列化器
        this.registerModule(simpleModule);
    }

在JacksonObjectMapper类中，我们继承了ObjectMapper，并在构造方法中配置了日期的格式化规则。你可以根据需要修改日期格式化的具体规则，并添加其他自定义序列化器和反序列化器。

步骤四：应用配置类

为了使配置生效，需要将JacksonObjectMapper类加入Spring的容器中。

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Bean
    public JacksonObjectMapper jacksonObjectMapper() {
        return new JacksonObjectMapper();
    }
}

在WebMvcConfig类中，我们使用@Bean注解将JacksonObjectMapper类加入Spring容器中。

完成以上步骤后，Spring Boot将会使用我们配置的日期格式化消息转换器来统一处理日期的格式化。