SpringBoot日期格式轉換之配置全局日期格式轉換器的實例詳解

1. SpringBoot設置後臺向前臺傳遞Date日期格式

在springboot應用中，@RestController註解的json默認序列化中，日期格式默認爲：2020-12-03T15:12:26.000+00:00類型的顯示。

在實際顯示中，我們需要對其轉換成我們需要的顯示格式。

1.1 方式1：配置文件修改

配置文件配置application.yml：

spring:
 # 配置日期格式化
 jackson:
 date-format: yyyy-MM-dd HH:mm:ss #時間戳統一轉換爲指定格式
 time-zone: GMT+8 # 時區修改爲東8區

application.properties配置方式

spring.jackson.date-format=yyyy-MM-dd HH:mm:ss	#時間戳統一轉換爲指定格式
spring.jackson.time-zone=GMT+8	# 時區修改爲東8區

【注意】這裏需要修改時區time-zone：數據庫默認時區是格林尼治的時間，如果不設置，會比實際時間少8個小時（北京時間）。

1.2 方式2：在javabean實體類上加註解

 I. @JsonFormat註解

@JsonFormat註解用於屬性或方法上，將Date類型轉換爲我們需要的類型顯示。

//在pattern上設置自己需要的格式
	@JsonFormat(pattern="yyyy-MM-dd HH:mm:ss")
	private Date createTime;

II. @DateTimeFormat註解

在需要進行日期格式轉換的Date屬性上添加註解@DateTimeFormat(pattern = "需要轉換的格式")

//註解將yyyy-MM-dd的形式轉換爲Date數據
 @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
 private Date birthday;

III. @Temporal註解

通過@Temporal註解，實現日期格式轉換，它自帶屬性參數，比如：

 

@Temporal註解參數	作用
TemporalType.DATE	@Temporal(TemporalType.DATE)，會得到yyyy-MM-dd格式的日期形式。
TemporalType.TIME	@Temporal(TemporalType.TIME)，會得到HH:MM:SS格式的時間形式。
TemporalType.TIMESTAMP	@Temporal(TemporalType.TIMESTAMP)，會得到yyyy-MM-dd hh:MM:ss格式的日期時間形式。

@Temporal(TemporalType.TIMESTAMP)
private Date createTime;

2. SpringBoot配置全局日期格式轉換器

配置從頁面接收的String和json格式的日期轉換爲Date類型。

2.1 配置String類型表單傳參轉Date的轉換器

import org.springframework.core.convert.converter.Converter;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;


//Converter<S,T> S: 代表的是源,將要轉換的數據類型 T:目標類型,將會轉成什麼數據類型
@Component
public class GlobalFormDateConvert implements Converter<String, Date> {

 //靜態初始化定義日期字符串參數列表（需要轉換的）
 private static final List<String> paramList = new ArrayList<>();

 //靜態初始化可能初夏你的日期格式
 private static final String param1 = "yyyy-MM";
 private static final String param2 = "yyyy-MM-dd";
 private static final String param3 = "yyyy-MM-dd HH:mm";
 private static final String param4 = "yyyy-MM-dd HH:mm:ss";

 //靜態代碼塊，將日期參數加入到列表中
 static {
  paramList.add(param1);
  paramList.add(param2);
  paramList.add(param3);
  paramList.add(param4);
 }

 //自定義函數，將字符串轉Date 參1：傳入的日期字符串 參2：格式參數
 public Date parseDate(String source, String format) {
  System.out.println("parseDate轉換日期");
  Date date = null;
  try {
   //日期格式轉換器
   DateFormat dateFormat = new SimpleDateFormat(format);
   date = dateFormat.parse(source);
  } catch (Exception e) {
   e.printStackTrace();
  }
  return date;
 }


 //convert轉換方法 ，s是將會傳遞過來的日期的字符串
 @Override
 public Date convert(String source) {

  System.out.println("convert日期格式轉換器");
  if(StringUtils.isEmpty(source)){
   return null;
  }
  source = source.trim(); //去除首尾空格
  DateFormat dateFormat = new SimpleDateFormat(param1);

  //正則表達式判斷是哪一種格式參數
  if (source.matches("^\\d{4}-\\d{1,2}$")) {
   return parseDate(source, paramList.get(0));
  } else if (source.matches("^\\d{4}-\\d{1,2}-\\d{1,2}$")) {
   return parseDate(source, paramList.get(1));
  } else if (source.matches("^\\d{4}-\\d{1,2}-\\d{1,2} {1}\\d{1,2}:\\d{1,2}$")) {
   return parseDate(source, paramList.get(2));
  } else if (source.matches("^\\d{4}-\\d{1,2}-\\d{1,2} {1}\\d{1,2}:\\d{1,2}:\\d{1,2}$")) {
   return parseDate(source, paramList.get(3));
  } else {
   throw new IllegalArgumentException("還未定義該種字符串轉Date的日期轉換格式 --> 【日期格式】：" + source);
  }
 }
}

2.2 配置Json數據轉Date的全局日期轉換器

import java.text.FieldPosition;
import java.text.ParsePosition;
import java.text.SimpleDateFormat;
import java.util.Date;
import com.fasterxml.jackson.databind.util.StdDateFormat;
import org.springframework.util.StringUtils;

public class GlobalJsonDateConvert extends StdDateFormat {

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

 //覆蓋parse(String)這個方法即可實現
 @Override
 public Date parse(String dateStr, ParsePosition pos) {
  return getDate(dateStr, pos);
 }

 @Override
 public Date parse(String dateStr) {
  ParsePosition pos = new ParsePosition(0);
  return getDate(dateStr, pos);
 }

 private Date getDate(String dateStr, ParsePosition pos) {
  System.out.println("json格式日期轉換");
  SimpleDateFormat sdf = null;
  if (StringUtils.isEmpty(dateStr)) {
   return null;
  } else if (dateStr.matches("^\\d{4}-\\d{1,2}$")) {
   sdf = new SimpleDateFormat("yyyy-MM");
   return sdf.parse(dateStr, pos);
  } else if (dateStr.matches("^\\d{4}-\\d{1,2}-\\d{1,2}$")) {
   sdf = new SimpleDateFormat("yyyy-MM-dd");
   return sdf.parse(dateStr, pos);
  } else if (dateStr.matches("^\\d{4}-\\d{1,2}-\\d{1,2} {1}\\d{1,2}:\\d{1,2}$")) {
   sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm");
   return sdf.parse(dateStr, pos);
  } else if (dateStr.matches("^\\d{4}-\\d{1,2}-\\d{1,2} {1}\\d{1,2}:\\d{1,2}:\\d{1,2}$")) {
   sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
   return sdf.parse(dateStr, pos);
  } else if (dateStr.length() == 23) {
   sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS");
   return sdf.parse(dateStr, pos);
  }
  return super.parse(dateStr, pos);
 }

 @Override
 public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition){
  SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  return sdf.format(date, toAppendTo, fieldPosition);
 }

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

2.3 配置bean交給Spring管理

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.xgf.online_mall.convert.GlobalFormDateConvert;
import com.xgf.online_mall.convert.GlobalJsonDateConvert;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.ConversionServiceFactoryBean;
import org.springframework.core.convert.ConversionService;
import org.springframework.core.convert.converter.Converter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;

import java.util.ArrayList;
import java.util.List;
import java.util.HashSet;
import java.util.Set;


@Configuration
public class WebConfig {

 //JSON格式 全局日期轉換器配置
 @Bean
 public MappingJackson2HttpMessageConverter getMappingJackson2HttpMessageConverter() {
  MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter = new MappingJackson2HttpMessageConverter();
  //設置日期格式
  ObjectMapper objectMapper = new ObjectMapper();
  objectMapper.setDateFormat(GlobalJsonDateConvert.instance);
  objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
  mappingJackson2HttpMessageConverter.setObjectMapper(objectMapper);
  //設置中文編碼格式
  List<MediaType> list = new ArrayList<MediaType>();
  list.add(MediaType.APPLICATION_JSON_UTF8);
  mappingJackson2HttpMessageConverter.setSupportedMediaTypes(list);
  return mappingJackson2HttpMessageConverter;
 }

 //表單格式 全局日期轉換器

 @Bean
 @Autowired
 public ConversionService getConversionService(GlobalFormDateConvert globalDateConvert){
  ConversionServiceFactoryBean factoryBean = new ConversionServiceFactoryBean();
  Set<Converter> converters = new HashSet<>();
  converters.add(globalDateConvert);
  factoryBean.setConverters(converters);
  return factoryBean.getObject();
 }
}

贊 2