如何使用SpringMVC的消息轉(zhuǎn)換器設(shè)置日期格式

更新時(shí)間：2024年07月08日 10:35:32 作者：openallzzz

這篇文章主要介紹了如何使用SpringMVC的消息轉(zhuǎn)換器設(shè)置日期格式問題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

SpringMVC消息轉(zhuǎn)換器設(shè)置日期格式

描述

在后端返回給前端的JSON數(shù)據(jù)中含有日期類型的字段時(shí)，如何指定該類型的日期的顯示格式。

解決方案

使用Spring MVC的消息轉(zhuǎn)換器即可。

1.添加配置類，并繼承 WebMvcConfigurationSupport 類，重寫 extendMessageConverters

  /**
   * 擴(kuò)展Spring MVC框架的消息轉(zhuǎn)換器
   * @param converters
   */
  @Override
  protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
      log.info("擴(kuò)展消息轉(zhuǎn)換器...");
      //創(chuàng)建一個(gè)消息轉(zhuǎn)換器對(duì)象
      MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
      //需要為消息轉(zhuǎn)換器對(duì)象設(shè)置一個(gè)對(duì)象轉(zhuǎn)換器，對(duì)象轉(zhuǎn)換器可以將Java對(duì)象序列化為JSON
      converter.setObjectMapper(new JacksonObjectMapper());
      //將自己的消息轉(zhuǎn)換器加入到相關(guān)容器中，并設(shè)置優(yōu)先級(jí)
      converters.add(0, converter);
  }

2.自定義對(duì)象轉(zhuǎn)換器 JacksonObjectMapper，設(shè)置對(duì)應(yīng)日期類型的轉(zhuǎn)換格式

/**
 * 對(duì)象映射器:基于jackson將Java對(duì)象轉(zhuǎn)為json，或者將json轉(zhuǎn)為Java對(duì)象
 * 將JSON解析為Java對(duì)象的過(guò)程稱為 [從JSON反序列化Java對(duì)象]
 * 從Java對(duì)象生成JSON的過(guò)程稱為 [序列化Java對(duì)象到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";
    public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss";

    public JacksonObjectMapper() {
        super();
        //收到未知屬性時(shí)不報(bào)異常
        this.configure(FAIL_ON_UNKNOWN_PROPERTIES, false);

        //反序列化時(shí)，屬性不存在的兼容處理
        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)));

        //注冊(cè)功能模塊 例如，可以添加自定義序列化器和反序列化器
        this.registerModule(simpleModule);
    }
}

隨后問題將會(huì)被解決。

SpringMVC使用自定義日期Converter日期轉(zhuǎn)換

在SpringMVC的配置文件中加入一下代碼

<mvc:annotation-driven conversion-service="conversionService"/>
<!--聲明自定義轉(zhuǎn)換器-->
<bean class="org.springframework.web.bind.support.ConfigurableWebBindingInitializer" id="webBindingInitializer">
    <property name="conversionService" ref="conversionService"/>
</bean>

<!--添加自定義日期轉(zhuǎn)換器-->
<bean class="org.springframework.format.support.FormattingConversionServiceFactoryBean" id="conversionService">
  <property name="converters">
      <list>
          <bean class="com.ssm.converter.DataConverter"></bean>
      </list>
  </property>
</bean>

編寫日期轉(zhuǎn)換的具體內(nèi)容

public class DataConverter implements Converter<String, Date> {
    //要遍歷的輸入字符串格式
    private SimpleDateFormat[] simpleDateFormats={
            new SimpleDateFormat("yyyy-MM-dd"),
            new SimpleDateFormat("yyyy/MM/dd"),
            new SimpleDateFormat("yyyy.MM.dd"),
            new SimpleDateFormat("yyyyMMdd"),
            new SimpleDateFormat("yyyy年MM月dd號(hào)"),
            new SimpleDateFormat("yyyy年MM月dd日")
    };
    //日期轉(zhuǎn)換的具體方法
    public Date convert(String source) {

        for (SimpleDateFormat simpleDateFormat : simpleDateFormats) {
            try {
                simpleDateFormat.setTimeZone(TimeZone.getTimeZone("GMT"));
                System.out.println(simpleDateFormat.parse(source));
                return  simpleDateFormat.parse(source);
            } catch (ParseException parseException) {
                //parseException.printStackTrace();直接進(jìn)入下一個(gè)字符串格式
                continue;
            }
        }
        try {
            throw new ParseException("日期轉(zhuǎn)換失敗",0);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }
}

拓展：

還可以使用在WebDataBinder上注冊(cè)一個(gè)CustomDataEditor,要用到@InitBinder

缺點(diǎn)只在本control里有效

或者在實(shí)體類的日期型屬性上加上@DataTimeFormat或@JsonFormat