Springboot 全局时间格式化操作

下面是关于Spring Boot全局时间格式化操作的完整攻略。

背景

Spring Boot是一个使用很方便的轻量级框架，它内置了很多常用的扩展功能。在实际应用中，我们经常需要对时间类型数据进行格式化处理，以满足业务需求。此时，全局时间格式化就成了必不可少的一个功能。

解决方案

方案一：在全局配置文件中配置时间格式

可以在application.properties或者application.yml中设置全局时间格式。例如：

application.properties

# 设置全局时间格式
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
# 设置全局时区
spring.jackson.time-zone=GMT+8

application.yml

# 设置全局时间格式
spring:
  jackson:
     date-format: "yyyy-MM-dd HH:mm:ss"
  # 设置全局时区
  jackson:
     time-zone: GMT+8

方案二：自定义时间格式转换器

可以自定义一个时间格式转换器，用来处理Java Date类型的时间数据。步骤如下：

1.创建一个时间格式转换器类，例如DateConverterConfig，并实现Converter<String, Date>接口。

@Configuration
public class DateConverterConfig implements Converter<String, Date> {

    private static final String DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";

    @Override
    public Date convert(String source) {
        if (StringUtils.isEmpty(source)) {
            return null;
        }
        try {
            SimpleDateFormat dateFormat = new SimpleDateFormat(DATE_TIME_FORMAT);
            return dateFormat.parse(source);
        } catch (Exception e) {
            throw new RuntimeException(String.format("parser %s to Date fail", source));
        }
    }
}

2.在启动类中添加@EnableWebMvc注解以启用Spring MVC，并添加addFormatters方法来注册时间格式转换器：

@SpringBootApplication
@EnableWebMvc
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @Bean
    public FormattingConversionService conversionService(){
        DefaultFormattingConversionService conversionService = new DefaultFormattingConversionService(false);
        conversionService.addConverter(new DateConverter());
        return conversionService;
    }

    @Bean
    public MethodValidationPostProcessor methodValidationPostProcessor(){
        return new MethodValidationPostProcessor();
    }

    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new DateConverter());
    }
}

这样，我们就可以全局使用这个时间格式转换器来处理Java Date类型的时间数据了，例如：

@RestController
@RequestMapping("/api")
public class ApiController {

    @GetMapping("/date")
    public String getDate(@RequestParam("date") Date date) {
        return "Date = " + date;
    }
}

假设我们以字符串形式传递时间参数，那么可以使用以下两种方式进行测试：

方式一：使用curl命令发送HTTP请求

curl -X GET "http://localhost:8080/api/date?date=2022-01-01%2000:00:00"

方式二：使用Postman发送HTTP请求

在Postman中，设置HTTP Method为GET，请求URL为http://localhost:8080/api/date，同时设置参数date的值为2022-01-01 00:00:00，点击Send按钮即可发送请求并查看响应结果。