SpringBoot日期格式转换之配置全局日期格式转换器的实例详解

在SpringBoot开发中，日期格式转换是一项非常重要的工作。如果不进行日期格式转换，会导致很多问题，比如接收到的时间格式不正确，数据库存储的时间也不正确等等。为了解决这些问题，我们可以通过配置全局日期格式转换器来实现。下面我们将详细讲解如何配置。

配置全局日期格式转换器的方式

第一种方式：通过继承WebMvcConfigurerAdapter实现

首先，我们需要创建一个日期格式转换器类，例如下面这个：

import org.springframework.core.convert.converter.Converter;

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;

public class DateConverter implements Converter<String, Date> {

    private final SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd");

    @Override
    public Date convert(String s) {
        try {
            return format.parse(s);
        } catch (ParseException e) {
            e.printStackTrace();
            return null;
        }
    }
}

该类实现了Converter接口，在convert方法中将字符串转换成日期格式。上面的例子是将字符串格式的日期转换成"yyyy-MM-dd"格式的日期。

然后，我们需要创建一个WebMvcConfigurerAdapter的子类，例如下面这个：

import org.springframework.context.annotation.Configuration;
import org.springframework.format.FormatterRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {

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

在该类的addFormatters方法中，我们将DateConverter注册到FormatterRegistry中，从而达到全局日期格式转换的目的。

第二种方式：通过实现WebMvcConfigurer接口实现

除了继承WebMvcConfigurerAdapter的方式，我们还可以实现WebMvcConfigurer接口来完成日期格式转换的配置：

import org.springframework.context.annotation.Configuration;
import org.springframework.format.FormatterRegistry;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
@EnableWebMvc
public class WebConfig2 implements WebMvcConfigurer {

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

验证全局日期格式转换器

我们可以通过编写一个Controller来验证全局日期格式转换器是否生效：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.util.Date;

@RestController
public class TestController {

    @GetMapping("/test")
    public Date test(@RequestParam("date") Date date) {
        return date;
    }
}

在该Controller中，我们设置了一个入参为Date类型的方法，并以字符串的形式将日期传入。由于我们已经配置了全局日期格式转换器，在SpringBoot启动时自动生效，因此程序会自动将传入的字符串转换成Date类型。

结论

通过上面的实例，我们已经成功地配置了全局日期格式转换器，并在Controller中验证了它的有效性。无论我们是采用第一种方式还是第二种方式，只要我们正确地配置即可达到全局日期格式转换的目的。