您现在的位置是:首页 >其他 >SpringMVC中使用LocalDateTime、LocalDate等参数作为入参数据转换问题网站首页其他

SpringMVC中使用LocalDateTime、LocalDate等参数作为入参数据转换问题

静水楼台x 2023-07-02 16:00:03
简介SpringMVC中使用LocalDateTime、LocalDate等参数作为入参数据转换问题

1、接收GET请求方式及POST请求表单方式时间类型传参,需要自定义参数转换器或者使用@ControllerAdvice配合@initBind,不设置的话表单方式会报以下错误:

        这种情况要和时间作为Json字符串时区别对待,因为前端json转后端pojo底层使用的是Json序列化Jackson工具(HttpMessgeConverter),而时间字符串作为普通请求参数传时,转换用的是Converter,两者有区别哦。

        在这种情况下,有如下几种方案: 

(1)使用Converter

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.convert.converter.Converter;
import org.springframework.http.converter.HttpMessageConverter;
 
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
 
@Configuration
public class DateConfig {
 
    @Bean
    public Converter<String, LocalDate> localDateConverter() {
        return new Converter<>() {
            @Override
            public LocalDate convert(String source) {
                return LocalDate.parse(source, DateTimeFormatter.ofPattern("yyyy-MM-dd"));
            }
        };
    }
 
    @Bean
    public Converter<String, LocalDateTime> localDateTimeConverter() {
        return new Converter<>() {
            @Override
            public LocalDateTime convert(String source) {
                return LocalDateTime.parse(source, DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
            }
        };
    }
 
}

以上两个bean会注入到spring mvc的参数解析器(好像叫ParameterConversionService),当传入的字符串要转为LocalDateTime类时,spring会调用该Converter对这个入参进行换。

(2)使用ControllerAdvice配合initBinder

@ControllerAdvice
public class GlobalExceptionHandler {
 
    @InitBinder
    protected void initBinder(WebDataBinder binder) {
        binder.registerCustomEditor(LocalDate.class, new PropertyEditorSupport() {
            @Override
            public void setAsText(String text) throws IllegalArgumentException {
                setValue(LocalDate.parse(text, DateTimeFormatter.ofPattern("yyyy-MM-dd")));
            }
        });
        binder.registerCustomEditor(LocalDateTime.class, new PropertyEditorSupport() {
            @Override
            public void setAsText(String text) throws IllegalArgumentException {
                setValue(LocalDateTime.parse(text, DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
            }
        });
        binder.registerCustomEditor(LocalTime.class, new PropertyEditorSupport() {
            @Override
            public void setAsText(String text) throws IllegalArgumentException {
                setValue(LocalTime.parse(text, DateTimeFormatter.ofPattern("HH:mm:ss")));
            }
        });
    }
}

 从名字就可以看出来,这是在controller做环切(这里面还可以全局异常捕获),在参数进入handler之前进行转换;转换为我们相应的对象。

(3)使用@DateTimeFormat注解

        和前面提到的一样,GET请求及POST表单方式也是可以用@DateTimeFormat来处理的,单独在controller接口参数或者实体类属性中都可以使用,比如@DateTimeFormat(pattern = "yyyy-MM-dd") Date originalDate。注意,如果使用了自定义参数转化器(Converter),Spring会优先使用该方式进行处理,即@DateTimeFormat注解不生效,两种方式是不兼容的。

参考文章:如何在Spring Boot应用中优雅的使用Date和LocalDateT - 自由资讯

2、JSON方式传参,json返回前端和@RequestBody注解接收参数

(1)如果日期是 LocalDate 类型,那么不论是前台传String格式日期给后台,还是后台返回格式化传给前端的日期,JacksonAutoConfiguration会自动处理。【注意】java 中 LocalDate 类型的数据在 swagger 上进行测试时,以json格式输入时格式为2018-07-09,需要特别注意的是,07和09是两位数字,不是一位数字。

(2)如果日期是LocalDateTime,那么前端到后端、后端返回给前端均需要我们进行处理。那么可以利用Jackson的json序列化和反序列化来做:

@Configuration
public class JacksonConfig {
 
    /** 默认日期时间格式 */
    public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";
    /** 默认日期格式 */
    public static final String DEFAULT_DATE_FORMAT = "yyyy-MM-dd";
    /** 默认时间格式 */
    public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss";
 
 
    @Bean
    public ObjectMapper objectMapper(){
        ObjectMapper objectMapper = new ObjectMapper();

        JavaTimeModule javaTimeModule = new JavaTimeModule();
        javaTimeModule.addSerializer(LocalDateTime.class,new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
        javaTimeModule.addSerializer(LocalDate.class,new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
        javaTimeModule.addSerializer(LocalTime.class,new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
        javaTimeModule.addDeserializer(LocalDateTime.class,new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)));
        javaTimeModule.addDeserializer(LocalDate.class,new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
        javaTimeModule.addDeserializer(LocalTime.class,new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
        objectMapper.registerModule(javaTimeModule).registerModule(new ParameterNamesModule());
        return objectMapper;
    }

    //或者如下
    /**
      * Json序列化和反序列化转换器,用于转换Post请求体中的json以及将我们的对象序列化为返回响应的json
    */
    @Bean
    public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
       return builder -> builder.serializerByType(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATETIME_PATTERN)))
         .serializerByType(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)))
         .serializerByType(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)))
         .deserializerByType(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATETIME_PATTERN)))
         .deserializerByType(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)))
         .deserializerByType(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
    }
 
}

3、完整配置

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalTimeSerializer;
import org.apache.commons.lang3.StringUtils;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.convert.converter.Converter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
 
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;
import java.util.*;
 
/**
 * 前后端时间类型格式化处理及接收时间类型传参
 * 1、JSON方式传参,json返回前端和@RequestBody注解接收参数
 * 2、接收GET请求及POST表单方式时间类型传参,需要自定义参数转换器或者使用@ControllerAdvice配合@initBinder
 */
@Configuration
public class DateTimeConfig {
 
	/**
	 * 日期正则表达式
	 */
	public static final String DATE_REGEX = "[1-9]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])";
 
	/**
	 * 时间正则表达式
	 */
	public static final String TIME_REGEX = "(20|21|22|23|[0-1]\d):[0-5]\d:[0-5]\d";
 
	/**
	 * 日期和时间正则表达式
	 */
	public static final String DATE_TIME_REGEX = DATE_REGEX + "\s" + TIME_REGEX;
 
	/**
	 * 13位时间戳正则表达式
	 */
	public static final String TIME_STAMP_REGEX = "1\d{12}";
 
	/**
	 * 年和月正则表达式
	 */
	public static final String YEAR_MONTH_REGEX = "[1-9]\d{3}-(0[1-9]|1[0-2])";
 
	/**
	 * 年和月格式
	 */
	public static final String YEAR_MONTH_PATTERN = "yyyy-MM";
 
	/**
	 * DateTime格式化字符串
	 */
	public static final String DEFAULT_DATETIME_FORMAT = "yyyy-MM-dd HH:mm:ss";
 
	/**
	 * Date格式化字符串
	 */
	public static final String DEFAULT_DATE_FORMAT = "yyyy-MM-dd";
 
	/**
	 * Time格式化字符串
	 */
	public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss";
 
	/**
	 * LocalDate转换器,用于转换RequestParam和PathVariable参数
	 */
	@Bean
	public Converter<String, LocalDate> localDateConverter() {
		return new Converter<String, LocalDate>() {
			@SuppressWarnings("NullableProblems")
			@Override
			public LocalDate convert(String source) {
				if (StringUtils.isEmpty(source)) {
					return null;
				}
				return LocalDate.parse(source, DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT));
			}
		};
	}
 
	/**
	 * LocalDateTime转换器,用于转换RequestParam和PathVariable参数
	 */
	@Bean
	public Converter<String, LocalDateTime> localDateTimeConverter() {
		return new Converter<String, LocalDateTime>() {
			@SuppressWarnings("NullableProblems")
			@Override
			public LocalDateTime convert(String source) {
				if (StringUtils.isEmpty(source)) {
					return null;
				}
				return LocalDateTime.parse(source, DateTimeFormatter.ofPattern(DEFAULT_DATETIME_FORMAT));
			}
		};
	}
 
	/**
	 * LocalTime转换器,用于转换RequestParam和PathVariable参数
	 */
	@Bean
	public Converter<String, LocalTime> localTimeConverter() {
		return new Converter<String, LocalTime>() {
			@SuppressWarnings("NullableProblems")
			@Override
			public LocalTime convert(String source) {
				if (StringUtils.isEmpty(source)) {
					return null;
				}
				return LocalTime.parse(source, DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT));
			}
		};
	}
 
	/**
	 * Date转换器,用于转换RequestParam和PathVariable参数
	 */
	@Bean
	public Converter<String, Date> dateConverter() {
		return new Converter<String, Date>() {
			@SuppressWarnings("NullableProblems")
			@Override
			public Date convert(String source) {
				if (StringUtils.isEmpty(source)) {
					return null;
				}
				if (source.matches(TIME_STAMP_REGEX)) {
					return new Date(Long.parseLong(source));
				}
				DateFormat format;
				if (source.matches(DATE_TIME_REGEX)) {
					format = new SimpleDateFormat(DEFAULT_DATETIME_FORMAT);
				} else if (source.matches(DATE_REGEX)) {
					format = new SimpleDateFormat(DEFAULT_DATE_FORMAT);
				} else if (source.matches(YEAR_MONTH_REGEX)) {
					format = new SimpleDateFormat(YEAR_MONTH_PATTERN);
				} else {
					throw new IllegalArgumentException();
				}
				try {
					return format.parse(source);
				} catch (ParseException e) {
					throw new RuntimeException(e);
				}
			}
		};
	}
 
	/**
	 * Json序列化和反序列化转换器,用于转换Post请求体中的json以及将我们的对象序列化为返回响应的json
	 */
	@Bean
	public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() {
		MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
		ObjectMapper objectMapper = new ObjectMapper();
		// 指定时区
		objectMapper.setTimeZone(TimeZone.getTimeZone("GMT+8:00"));
		// 日期类型字符串处理
		objectMapper.setDateFormat(new SimpleDateFormat(DEFAULT_DATETIME_FORMAT));
 
		// Java8日期日期处理
		JavaTimeModule javaTimeModule = new JavaTimeModule();
		javaTimeModule.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATETIME_FORMAT)));
		javaTimeModule.addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
		javaTimeModule.addSerializer(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
		javaTimeModule.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATETIME_FORMAT)));
		javaTimeModule.addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)));
		javaTimeModule.addDeserializer(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
		objectMapper.registerModule(javaTimeModule);
 
		converter.setObjectMapper(objectMapper);
		return converter;
	}
    //或者如下
    /*@Bean
    public Jackson2ObjectMapperBuilderCustomizer jsonCustomizer() {
        return builder -> {
            builder.serializerByType(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATETIME_FORMAT)));
            builder.deserializers(new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATETIME_FORMAT)));
        };
    }*/
 
}

【注意】 上面的四个Converter不能用lambda表达式代替,否则项目启动不起来,详细见这3篇文章:spring环境下构建自定义Converter使用lambda表达式代替匿名内部类时启动异常_unable to determine source type <s> and target typ_cnfinch的博客-CSDN博客

【SpringBoot】添加Converter解析器中使用lambda表达式代替匿名内部类是启动报错: does the class parameterize those types?_道一哥哥的博客-CSDN博客

关于java:使用lambda表达式代替匿名内部类时,Spring无法确定泛型类型 | 码农家园

Lambda替换匿名内部类引起的问题_谷雨、的博客-CSDN博客 

【补充知识】 泛型擦除会导致spring注入失败:【Java】 泛型擦除_java泛型擦出_ElegantCodingWH的博客-CSDN博客

参考文章:

关于springboot时间类型参数前后端传值问题_localdatetime前端怎么传_29097561的博客-CSDN博客

Spring中使用LocalDateTime、LocalDate等参数作为入参数据转换问题_spring localdatetime_tyjlearning的博客-CSDN博客

风语者!平时喜欢研究各种技术,目前在从事后端开发工作,热爱生活、热爱工作。