接口接收时间字符串参数并将其转换为Date类型时出现错误

nlw123

于 2024-06-21 17:33:19 发布

阅读量567

点赞数 3

文章标签： java spring json

本文链接：https://blog.csdn.net/nlw123/article/details/139866183

版权

在Spring应用程序中，如果接口接收一个时间字符串参数并将其转换为Date类型时出现错误，通常是因为字符串的格式与预期的日期格式不匹配，或者Spring没有正确配置日期格式化处理。

1.常见原因

1.1日期格式不匹配：

如果传递的日期字符串格式不符合Java解析日期的默认格式或指定格式，就会发生解析错误。

1.2缺少日期格式转换器：

Spring需要一个合适的日期格式转换器来将字符串转换为Date对象。如果没有配置合适的转换器，Spring无法正确地处理日期字符串。

2.解决方案

2.1使用@DateTimeFormat注解：

在控制器方法参数上使用@DateTimeFormat注解来指定日期格式。例如：

import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.web.bind.annotation.*;

@RestController
public class MyController {

    @GetMapping("/date")
    public String getDate(@RequestParam @DateTimeFormat(pattern = "yyyy-MM-dd") Date date) {
        // 使用 date 参数
        return date.toString();
    }
}

2.2配置全局日期格式化器：

配置一个全局的日期格式化器，Spring会自动使用它来转换日期字符串。例如，在Spring Boot应用程序中，可以在配置类中添加以下配置：

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

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addFormatter(new DateFormatter("yyyy-MM-dd"));
    }
}

2.3自定义日期转换器：

如果需要更灵活的日期处理，可以实现一个自定义转换器并注册它。例如：

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

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

@Component
public class StringToDateConverter implements Converter<String, Date> {

    private static final String DATE_FORMAT = "yyyy-MM-dd";

    @Override
    public Date convert(String source) {
        SimpleDateFormat formatter = new SimpleDateFormat(DATE_FORMAT);
        try {
            return formatter.parse(source);
        } catch (ParseException e) {
            throw new IllegalArgumentException("Invalid date format. Please use this pattern\"" + DATE_FORMAT + "\"");
        }
    }
}

然后，将这个转换器添加到Spring的转换器注册表中。

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

@Configuration
public class WebConfig implements WebMvcConfigurer {

    private final StringToDateConverter stringToDateConverter;

    public WebConfig(StringToDateConverter stringToDateConverter) {
        this.stringToDateConverter = stringToDateConverter;
    }

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

示例：完整的Spring Boot项目
以下是一个完整的Spring Boot示例项目，演示如何使用@DateTimeFormat来解析日期字符串：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.format.annotation.DateTimeFormat;
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;

@SpringBootApplication
public class DateParsingApplication {

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

@RestController
class DateController {

    @GetMapping("/date")
    public String getDate(@RequestParam @DateTimeFormat(pattern = "yyyy-MM-dd") Date date) {
        return "Parsed date: " + date;
    }
}