文章目录
- 前言
- 一、使用format()方法
- 二、使用注解@JsonFormat
- 三、使用消息转换器
- 1.定义用户类
- 2.重写DateSerializer 方法
- 3.定义对象映射器:
- 4.定义消息转换器
- 5.调用测试
- 总结
前言
当涉及到日期格式化时,了解正确的方式和最佳实践是至关重要的。
日期格式化是将日期转换为特定格式的过程,以便在应用程序开发中更好地展示、存储或交互。
以下内容展示常用的三种方式
一、使用format()方法
在Java中,你可以使用java.time.format.DateTimeFormatter类来格式化日期,并将格式化后的日期字符串返回给前端。
以下是一个示例:
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;public class DateFormattingExample {public static void main(String[] args) {LocalDate date = LocalDate.now();DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd");String formattedDate = date.format(formatter);System.out.println(formattedDate);// 输出类似于 "2023-08-06" 的日期字符串}
}
在上述示例中,我们使用LocalDate来表示当前日期,然后创建一个DateTimeFormatter对象,
指定了期望的日期格式模式(例如,"yyyy-MM-dd"代表年、月、日)。
通过format()方法,我们将日期格式化为字符串,并将其打印出来。
二、使用注解@JsonFormat
首先,确保你的项目中引入了Spring Boot和相关的依赖。
在你的实体类中,可以使用注解@JsonFormat来指定日期字段的格式化方式。
例如:
先定义一个用户类:
import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;import java.util.Date;@Data
public class User {private Long Id;private String name;@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")private Date createDate;@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")private Date updateDate;
}
测试调用返回User对象:
import com.example.result.Result;
import org.springframework.web.bind.annotation.*;import java.util.Date;@RestController
public class UserWebTest {@GetMapping("/getUser")public Result<?> aa(){User user = new User();user.setId(1L);user.setName("jljlm");user.setCreateDate(new Date());user.setUpdateDate(new Date());return Result.success(user);}}
结果:
三、使用消息转换器
使用消息转换器(MessageConverter)来格式化日期步骤如下:
1.定义用户类
import lombok.Data;
import java.util.Date;@Data
public class User {private Long Id;private String name;private Date createDate;private Date updateDate;
}
2.重写DateSerializer 方法
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;public class DateSerializer extends JsonSerializer<Date> {private final SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");@Overridepublic void serialize(Date date, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {String formattedDate = formatter.format(date);jsonGenerator.writeString(formattedDate);}
}
3.定义对象映射器:
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.deser.std.DateDeserializers;
import com.fasterxml.jackson.databind.module.SimpleModule;
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 java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;
import java.util.Date;import static com.fasterxml.jackson.databind.DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES;/*** 对象映射器:基于jackson将Java对象转为json,或者将json转为Java对象* 将JSON解析为Java对象的过程称为 [从JSON反序列化Java对象]* 从Java对象生成JSON的过程称为 [序列化Java对象到JSON]*/
public class JacksonObjectMapper extends ObjectMapper {public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";public JacksonObjectMapper() {super();//收到未知属性时不报异常this.configure(FAIL_ON_UNKNOWN_PROPERTIES, false);//反序列化时,属性不存在的兼容处理this.getDeserializationConfig().withoutFeatures(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);SimpleModule simpleModule = new SimpleModule().addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT))).addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT))).addDeserializer(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT))).addDeserializer(Date.class,new DateDeserializers.DateDeserializer()).addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT))).addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT))).addSerializer(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT))).addSerializer(Date.class, new DateSerializer());//注册功能模块 例如,可以添加自定义序列化器和反序列化器this.registerModule(simpleModule);}
4.定义消息转换器
import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;import java.util.List;/*** 配置类,注册web层相关组件*/
@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {/*** 扩展Spring MVC框架的消息转化器* @param converters*/protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {log.info("扩展消息转换器...");//创建一个消息转换器对象MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();//需要为消息转换器设置一个对象转换器,对象转换器可以将Java对象序列化为json数据converter.setObjectMapper(new JacksonObjectMapper());//将自己的消息转化器加入容器中converters.add(0,converter);}
}
5.调用测试
import com.example.result.Result;
import org.springframework.web.bind.annotation.*;import java.util.Date;@RestController
public class UserWebTest {@GetMapping("/getUser")public Result<?> aa(){User user = new User();user.setId(1L);user.setName("jljlm");user.setCreateDate(new Date());user.setUpdateDate(new Date());return Result.success(user);}}
结果如下:
总结
@作者:加辣椒了吗?
简介:憨批大学生一枚,喜欢在博客上记录自己的学习心得,也希望能够帮助到你们!