1.标准日期格式转换
2.非json请求时间戳转换
3.json请求时间戳转换
4.序列化扩展
5.swagger支持
本文基于jdk8。
1.标准日期格式转换本类型是指前端传递类似"yyyy-MM-dd HH:mm:ss"格式字符串，后端以 LocalDateTime类型接收。
spring默认的使用jackson，故添加maven依赖，可参考官方文档：
<dependency>
<groupId>com.fasterxml.jackson.module</groupId>
<artifactId>jackson-module-parameter-names</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jdk8</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
</dependency>
添加一个配置类
@Configuration
public class DateConfiguration {
@Bean
public ObjectMapper objectMapper(){
return new ObjectMapper()
.registerModule(new ParameterNamesModule())
.registerModule(new Jdk8Module())
.registerModule(new JavaTimeModule());
}
}
基础配置完成，使用时在对应字段添加@DateTimeFormat 进行反序列化或者@JsonFormat序列化。
2.非json请求时间戳转换本类型指在前端非json请求，传递参数为时间戳，然后转为LocalDateTime。
可在上文基础上添加配置,示例如下:
@Configuration
public class DateConfiguration {
@Bean
public ObjectMapper objectMapper(){
return new ObjectMapper()
.registerModule(new ParameterNamesModule())
.registerModule(new Jdk8Module())
.registerModule(new JavaTimeModule());
}
@Bean
public Formatter<LocalDateTime> localDateTimeFormatter() {
return new Formatter<LocalDateTime>() {
@Override
public LocalDateTime parse(String text, Locale locale) {
return Instant
.ofEpochMilli(Long.parseLong(text))
.atZone(ZoneOffset.ofHours(8))
.toLocalDateTime();
}
@Override
public String print(LocalDateTime object, Locale locale) {
return DateTimeFormatter.ISO_DATE.format(object);
}
};
}
}
3.json请求时间戳转换
本类型指在前端json请求，传递参数为时间戳，然后转为LocalDateTime。
1.自定义解析注解
@Retention (RetentionPolicy.RUNTIME)
@JacksonAnnotationsInside
@JsonDeserialize(using = CustomLocalDateTimeDeserializer.class)
public @interface StampToLocalDateTime {
}
2.自定义解析类
public class CustomLocalDateTimeDeserializer extends JsonDeserializer<LocalDateTime> {
@Override
public LocalDateTime deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException{
if (StringUtils.isEmpty(jsonParser.getText())) {
return null;
}
return Instant
.ofEpochMilli(Long.parseLong(jsonParser.getText()))
.atZone(ZoneOffset.ofHours(8))
.toLocalDateTime();
}
}
在需要使用的字段添加@StampToLocalDateTime即可。示例如下
public class DemoReq {
@StampToLocalDateTime
private LocalDateTime signTime;
}
4.序列化扩展
有时返回前端数据，要包装下信息(比如返回全路径地址及某些参数),直接硬编码不够优雅。这时可以通过序列化操作，实现ContextualSerializer接口,要进行一些额外操作，。
1.自定义注解
@Retention (RetentionPolicy.RUNTIME)
@JacksonAnnotationsInside
@JsonSerializer(using = FullUrlSerializer.class)
public @interface FullUrl {
String value() default "";
}
2.自定义序列类
public class FullUrlSerializer extends JsonSerializer<String> implements ContextualSerializer {
private String params;
@Value("${domain}")
private String domain;
public FullUrlSerializer() {
}
public FullUrlSerializer(String params) {
this.params = params;
}
@Override
public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property) throws JsonMappingException {
if (property == null) {
return prov.findNullValueSerializer(null);
}
if (Objects.equals(property.getType().getRawClass(), String.class)) {
FullUrl fullUrl = property.getAnnotation(FullUrl.class);
if (fullUrl == null) {
fullUrl = property.getContextAnnotation(FullUrl.class);
}
if (fullUrl != null) {
return new FullUrlSerializer(fullUrl.value());
}
}
return prov.findValueSerializer(property.getType(), property);
}
@Override
public void serialize(String value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
String url = "";
if (!StringUtils.isEmpty(value)) {
url = domain.concat(value);
if (!StringUtils.isEmpty(params)) {
url.contains(params);
}
}
gen.writeString (url);
}
}
5.swagger支持
要使swagger支持LocalDateTime等类型可以设置directModelSubstitute,示例如下:
@Configuration
public abstract class SwaggerConfiguration {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.directModelSubstitute(LocalDateTime.class,String.class)
.directModelSubstitute(LocalDate.class, String.class)
.directModelSubstitute(LocalTime.class, String.class)
.directModelSubstitute(ZonedDateTime.class,String.class)
.build();
}
}
以上为个人经验，希望能给大家一个参考，也希望大家多多支持易知道(ezd.cc)。
