SpringBoot JSON全局日期格式轉(zhuǎn)換器實(shí)現(xiàn)方式

更新時(shí)間：2023年04月17日 11:10:37 作者：fengyehongWorld

這篇文章主要介紹了SpringBoot JSON全局日期格式轉(zhuǎn)換器,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

需求

前臺(tái)有日期字符串的數(shù)據(jù)，提交到后臺(tái)。后臺(tái)實(shí)體類(lèi)使用Date屬性接收。
日期字符串有多種格式，需要用一個(gè)轉(zhuǎn)換器將合法的日期字符串格式轉(zhuǎn)換為Date類(lèi)型。

分析

當(dāng)前臺(tái)的提交數(shù)據(jù)的Content-Type為application/json;charset=utf-8，后臺(tái)使用@RequestBody來(lái)接收數(shù)據(jù)的時(shí)候，使用此轉(zhuǎn)換方式。

一. 前期準(zhǔn)備

1.1 日期正則注解

用來(lái)標(biāo)記日期字符串所對(duì)應(yīng)的正則表達(dá)式

import java.lang.annotation.*;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface DatePattern {
	
    String value();
}

1.2 日期格式定數(shù)

指定所有支持的日期格式

public final class DateFormatPart {

	@DatePattern("^\\d{4}$")
	public static final String YYYY = "yyyy";

	@DatePattern("^\\d{4}\\d{2}$")
	public static final String YYYYMM = "yyyyMM";

	@DatePattern("^\\d{4}/\\d{2}$")
	public static final String YYYYMM_SLASH = "yyyy/MM";

	@DatePattern("^\\d{4}\\d{1,2}\\d{1,2}$")
	public static final String YYYYMMDD = "yyyyMMdd";

	@DatePattern("^\\d{4}/\\d{2}/\\d{2}$")
	public static final String YYYYMMDD_SLASH = "yyyy/MM/dd";

	@DatePattern("[0-9]+\\u5e74[0-9]+\\u6708[0-9]+\\u65e5$")
	public static final String YYYYMMDD_JP = "yyyy年MM月dd日";

    @DatePattern("^\\d{4}\\d{1,2}\\d{1,2} \\d{1,2}:\\d{1,2}:\\d{1,2}$")
	public static final String YYYYMMDD_HHMMSS = "yyyyMMdd HH:mm:ss";

    @DatePattern("^\\d{4}/\\d{2}/\\d{2} \\d{1,2}:\\d{1,2}:\\d{1,2}$")
	public static final String YYYYMMDD_HHMMSS_SLASH = "yyyy/MM/dd HH:mm:ss";
}

1.3 日期轉(zhuǎn)換工具類(lèi)

從日期格式定數(shù)類(lèi)中獲取所有的屬性值和該屬性上所標(biāo)記的正則注解，通過(guò)反射來(lái)映射為map。
如果有需要增刪的日期格式的話，只需要修改日期格式定數(shù)即可，便于維護(hù)。

import org.springframework.util.ObjectUtils;
import org.springframework.util.ReflectionUtils;

import java.lang.reflect.Field;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.*;

public final class DateUtil {

    // 日期格式 <==> 正則的map,使用LinkedHashMap可以避免按照順序匹配正則表達(dá)式
    private static final Map<String, String> datePatternMap = new LinkedHashMap<>();

    // 日期格式List
    private static final List<String> dateFormatList = new ArrayList<>();

    // 使用靜態(tài)代碼塊,可以保證只初始化一次
    static {

        Class<DateFormatPart> dateFormatClass = DateFormatPart.class;
        // 獲取所有的屬性
        Field[] fields = dateFormatClass.getFields();
        for (Field field : fields) {

            // 獲取屬性上的注解
            DatePattern annotation = field.getAnnotation(DatePattern.class);
            if (ObjectUtils.isEmpty(annotation)) {
                continue;
            }

            //  強(qiáng)制讓屬性可以訪問(wèn)
            ReflectionUtils.makeAccessible(field);

            // 日期格式化字符串
            String dateFormatStr = "";
            try {
                // 獲取當(dāng)前屬性所對(duì)應(yīng)的屬性值
                dateFormatStr = (String)field.get(dateFormatClass);
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }

            dateFormatList.add(dateFormatStr);

            // 將該屬性的屬性值和屬性上的正則表達(dá)式放到map中
            datePatternMap.put(dateFormatStr, annotation.value());
        }
    }
	
	// 用所有可能支持的格式將日期字符串轉(zhuǎn)換為Date格式
    public static Date formatDateStrToDateAllFormat(String dateStr) {

        if (ObjectUtils.isEmpty(dateStr)) {
            return null;
        }

        try {
            for (Map.Entry<String, String> mapEntry : datePatternMap.entrySet()) {
				
				// 如果當(dāng)前日期字符串不符合當(dāng)前正則的話
                if (!dateStr.matches(mapEntry.getValue())) {
                    continue;
                }

                return DateUtil.formatStringToDate(dateStr, mapEntry.getKey());
            }
        } catch (ParseException e) {
            return null;
        }

        return null;
    }
	
	// 通過(guò)指定的格式將日期字符串轉(zhuǎn)換為Date類(lèi)型
    public static Date formatStringToDate(String dateStr, String format) throws ParseException {

        if (ObjectUtils.isEmpty(dateStr) || !dateFormatList.contains(format)) {
            return null;
        }

        SimpleDateFormat time = new SimpleDateFormat(format);
        return time.parse(dateStr);
    }
}

二. 方式1-繼承DateDeserializer類(lèi)，重寫(xiě)_parseDate方法

該方式的要點(diǎn)是通過(guò)繼承DateDeserializer類(lèi)，然后重寫(xiě)_parseDate方法實(shí)現(xiàn)轉(zhuǎn)換功能
自定義的GlobalDateDeserializer類(lèi)需要添加到自定義的SimpleModule模塊中，然后將模塊添加到ObjectMapper中，通過(guò)jackson來(lái)實(shí)現(xiàn)轉(zhuǎn)換。
通過(guò)設(shè)置ObjectMapper對(duì)象的setDateFormat方法來(lái)實(shí)現(xiàn)后臺(tái)數(shù)據(jù)返回到前臺(tái)時(shí)的Date轉(zhuǎn)String的默認(rèn)格式。

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.json.PackageVersion;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.deser.std.DateDeserializers.DateDeserializer;
import com.fasterxml.jackson.databind.module.SimpleModule;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;

import java.io.IOException;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;

@Configuration
public class CustomConfig {

    /*
     * 自定義的全局的日期轉(zhuǎn)換解析類(lèi),需要繼承jackson包中的DateDeserializer
     * 因?yàn)榇祟?lèi)不會(huì)在別的地方使用了,因此直接使用內(nèi)部類(lèi)聚合到自定義的配置文件中
     */
    private static final class GlobalDateDeserializer extends DateDeserializer {

        @Override
        protected Date _parseDate(JsonParser jp, DeserializationContext context) throws IOException {

            return DateUtil.formatDateStrToDateAllFormat(jp.getText());
        }
    }

    @Bean("objectMapper")
    @Primary
    @ConditionalOnMissingBean
    public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {

        // 創(chuàng)建jackson對(duì)象
        ObjectMapper jackson = builder.createXmlMapper(false).build();

        /*
         * DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES
         * 在進(jìn)行序列化或者反序列化的時(shí)候,
         * JSON字符串中有一個(gè)字段,但是我們的對(duì)象沒(méi)有這個(gè)字段的時(shí)候,該怎么處理
         * 設(shè)置為true的時(shí)候,會(huì)拋出異常
         * 設(shè)置為false,忽略異常繼續(xù)處理
         */
        jackson.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        // 禁用默認(rèn)的「yyyy-MM-dd'T'HH:mm:ss.SSS」UTC類(lèi)型
        jackson.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);

         /*
         * 設(shè)置序列化時(shí)的默認(rèn)格式,即后臺(tái)返回?cái)?shù)據(jù)到前臺(tái)的時(shí)候,
         * Date類(lèi)型數(shù)據(jù)需要轉(zhuǎn)換為的字符串格式
         * 如果不進(jìn)行指定的話,默認(rèn)使用 yyyy-MM-dd'T'HH:mm:ss.SSS 格式
         */
        DateFormat dateFormat = new SimpleDateFormat(DateFormatPart.YYYYMMDD_HHMMSS_SLASH);
        jackson.setDateFormat(dateFormat);

        // 創(chuàng)建一個(gè)模塊,指定該模塊是用來(lái)解析 Date.class 類(lèi)型數(shù)據(jù)的
        SimpleModule newModule = new SimpleModule("GlobalDateDeserializer", PackageVersion.VERSION);
        // 將我們創(chuàng)建的全局日期轉(zhuǎn)換類(lèi)添加到模塊中,指定轉(zhuǎn)換Date類(lèi)型
        newModule.addDeserializer(Date.class, new CustomConfig.GlobalDateDeserializer());
        // 將該模塊添加到j(luò)ackson中
        jackson.registerModule(newModule);

        return jackson;
    }
}

三. 方式2-繼承StdDateFormat類(lèi)，重寫(xiě)方法

parse方法用來(lái)將日期字符串轉(zhuǎn)換為Date(前臺(tái)向后臺(tái)傳數(shù)據(jù))
format方法用來(lái)將Date格式的數(shù)據(jù)轉(zhuǎn)換為指定格式的字符串(后臺(tái)向前臺(tái)傳數(shù)據(jù))。

import java.text.FieldPosition;
import java.text.ParsePosition;
import java.text.SimpleDateFormat;
import java.util.Date;

import com.fasterxml.jackson.databind.util.StdDateFormat;

public class GlobalJsonDateConvert extends StdDateFormat {

    // 靜態(tài)初始化final，共享
    public static final GlobalJsonDateConvert instance = new GlobalJsonDateConvert();

    // 日期字符串解析為日期
    @Override
    public Date parse(String dateStr, ParsePosition pos) {
        return getDate(dateStr);
    }

    @Override
    public Date parse(String dateStr) {
        return getDate(dateStr);
    }
	
	// 使用自定義的日期轉(zhuǎn)換工具類(lèi)將所有可能支持的日期字符串轉(zhuǎn)換為Date格式
    private Date getDate(String dateStr) {
        return DateUtil.formatDateStrToDateAllFormat(dateStr);
    }
    
	/*
   	 * 設(shè)置序列化時(shí)的默認(rèn)格式,即后臺(tái)返回?cái)?shù)據(jù)到前臺(tái)的時(shí)候,
     * Date類(lèi)型數(shù)據(jù)需要轉(zhuǎn)換為的字符串格式
     * 如果不進(jìn)行指定的話,默認(rèn)使用 yyyy-MM-dd'T'HH:mm:ss.SSS 格式
     */
    @Override
    public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition){
        SimpleDateFormat sdf = new SimpleDateFormat(DateFormatPart.YYYYMMDD_HHMMSS_SLASH);
        return sdf.format(date, toAppendTo, fieldPosition);
    }

    @Override
    public GlobalJsonDateConvert clone() {
        super.clone();
        return new GlobalJsonDateConvert();
    }
}

3.1 MappingJackson2HttpMessageConverter方式

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;

@Configuration
public class CustomConfig {

    // JSON格式 全局日期轉(zhuǎn)換器配置
    @Bean
    public MappingJackson2HttpMessageConverter createMappingJackson2HttpMessageConverter() {

        /*
         * 通過(guò)MappingJackson2HttpMessageConverter得到的ObjectMapper,
         * 已經(jīng)默認(rèn)把 DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES 給關(guān)閉了
         */
        MappingJackson2HttpMessageConverter jacksonConverter = new MappingJackson2HttpMessageConverter();
        jacksonConverter.getObjectMapper().setDateFormat(GlobalJsonDateConvert.instance);

        return jacksonConverter;
    }
}

3.2 ObjectMapper方式

通過(guò)Jackson2ObjectMapperBuilder創(chuàng)建ObjectMapper對(duì)象，然后將我們定義的轉(zhuǎn)換器GlobalJsonDateConvert放到ObjectMapper對(duì)象中

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;

@Configuration
public class CustomConfig {

    @Bean("objectMapper")
    @Primary
    @ConditionalOnMissingBean
    public ObjectMapper objectMapper(Jackson2ObjectMapperBuilder builder) {
		
        ObjectMapper objectMapper = builder.build();
        objectMapper.setDateFormat(GlobalJsonDateConvert.instance);
        return objectMapper;
    }
}

3.3 Jackson2ObjectMapperBuilder方式

將我們定義的轉(zhuǎn)換器GlobalJsonDateConvert放到Jackson2ObjectMapperBuilder對(duì)象中

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;

@Configuration
public class CustomConfig {

    @Bean
    public Jackson2ObjectMapperBuilder objectMapper() {

        Jackson2ObjectMapperBuilder jackson2ObjectMapperBuilder = new Jackson2ObjectMapperBuilder();
        jackson2ObjectMapperBuilder.dateFormat(GlobalJsonDateConvert.instance);
        return jackson2ObjectMapperBuilder;
    }
}

四. 效果

?前臺(tái)JS

// 向后臺(tái)傳輸?shù)膉son數(shù)據(jù)
const jsonData = {
	// ??待處理的日期字符串?dāng)?shù)據(jù)
    birthday: '2027年12月12日',
    nameAA: 'jiafeitian',
    hobby: '吃飯'
};

$.ajax({
    url: url,
    type: 'POST',
    // 對(duì)象轉(zhuǎn)換為json字符串
    data: JSON.stringify(jsonData),
    contentType: "application/json;charset=utf-8",
    success: function (data, status, xhr) {
        console.log(data);
    }
});

?后臺(tái)Form

import lombok.Data;
import java.util.Date;

@Data
public class Test15Form {

    private String name;

    private String hobby;

    private String address;
	
	// 用來(lái)接收的Date類(lèi)型的數(shù)據(jù)
    private Date birthday;
}

??可以看到前臺(tái)提交的日期字符串被轉(zhuǎn)換為Date格式了

五. 總結(jié)

方式一中的1種方法和方式二中的3種方法，共計(jì)4中方法都可以實(shí)現(xiàn)全局日期格式轉(zhuǎn)換器。
要點(diǎn)就是自定義日期轉(zhuǎn)換的工具類(lèi)用來(lái)處理各種可能的日期格式，并且將此工具類(lèi)放到Jackson中的ObjectMapper對(duì)象中，上述4中方法的本質(zhì)都是如此。

到此這篇關(guān)于SpringBoot JSON全局日期格式轉(zhuǎn)換器的文章就介紹到這了,更多相關(guān)SpringBoot JSON日期格式轉(zhuǎn)換內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: