在企业级应用程序开发中,日期是一个常见但又容易被忽视的问题。正确处理日期格式对于系统的正确性和用户体验至关重要。在本文中,我们将探讨两种常见的方式来处理日期格式:通过注解和通过扩展Spring MVC的消息转换器,以及它们各自的优缺点。
引言:日期在企业级应用中的重要性
在现代软件开发中,日期不仅仅是一个简单的数据类型。它们通常承载着时间戳、时区、格式等信息,因此,对日期进行正确处理变得至关重要。无论是从前端接收数据,还是向前端返回数据,我们都需要确保日期格式的一致性和正确性。
注解@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
这是处理日期格式的一种常见方法,特别适用于处理单个实体类的日期格式。通过在实体类的属性上添加 @JsonFormat
注解,我们可以指定日期的格式,如下所示:
public class User {
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private Date registrationDate;
}
优点:
-
简单直观:通过在实体类的属性上添加注解,可以直观地指定日期格式,使得代码易于理解和维护。
-
局部化:每个实体类都可以根据自身需要指定不同的日期格式,灵活性较高。
缺点:
-
重复性:如果多个实体类都需要相同的日期格式,就需要在每个实体类的属性上重复添加注解,增加了重复代码和维护成本。
-
耦合性:将日期格式的处理逻辑直接写在实体类中,使得实体类与日期格式处理逻辑耦合在一起,不利于解耦和复用。
有什么方法可以做到一劳永逸,设置一处让所有代码都可以在需要时转换格式?
消息转换器统一处理日期格式
另一种常见的方式是通过扩展Spring MVC的消息转换器来统一处理日期格式。我们可以创建一个自定义的消息转换器,然后在 WebMvcConfiguration
中注册它,如下所示:
在我们的WebMvcConfiguration配置类中,继承的WebMvcConfigurationSupport类
可以重写一个方法extendMessageConverters
/**
* 扩展SpringMVC框架消息转换器 ————统一给后端返回给前端的数据转换处理,如日期类型的
* @param converters
*/
@Override
protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
log.info("扩展消息转换器。。。");
// 创建一个消息转换器对象
MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
// 需要为消息转换器设置一个--对象转换器,对象转换器可以将java对象序列化为JSON数据
converter.setObjectMapper(new JacksonObjectMapper());
// 将自己的消息转换器加入容器converters中 参数0表示索引,让它排在前面优先
converters.add(0,converter);
}
其中需要为消息转换器设置一个对象转换器:new JacksonObjectMapper()
对象转换器是基于jackson将Java对象转为json,或者将json转为Java对象
其代码可以这样写:
public class JacksonObjectMapper extends ObjectMapper {
public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm";
public JacksonObjectMapper() {
super();
//收到未知属性时不报异常
this.configure(FAIL_ON_UNKNOWN_PROPERTIES, false);
//反序列化时,属性不存在的兼容处理
this.getDeserializationConfig().withoutFeatures(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
SimpleModule simpleModule = new SimpleModule()
.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)))
//注册功能模块 例如,可以添加自定义序列化器和反序列化器
this.registerModule(simpleModule);
}
}
在调试时可以看到,容器里从原来有的7个变成里8个,我们所添加的在第0个的位置👇
优点:
-
统一处理:通过扩展消息转换器,可以统一处理所有日期格式,无需在每个实体类中重复添加注解,提高了代码的复用性和可维护性。
-
解耦合:将日期格式处理逻辑从实体类中分离出来,降低了实体类与日期格式处理逻辑的耦合性,使得代码更加清晰和易于维护。
缺点:
-
全局化:消息转换器是全局性的配置,可能会影响到系统的其他部分,需要谨慎处理,避免意外影响。
-
不够灵活:消息转换器是全局性的配置,可能无法满足每个实体类不同的日期格式需求,需要权衡灵活性和统一性。
结论
在实际企业开发中,日期格式的处理方式需要根据具体的业务需求和系统架构来选择。对于单个实体类的日期格式处理,可以使用注解 @JsonFormat
来实现,简单直观;而对于全局性的日期格式处理,可以通过扩展消息转换器来实现,统一处理所有日期格式,降低耦合性,提高代码的复用性和可维护性。选择合适的日期格式处理方式,可以使系统更加健壮和易于维护,提高开发效率和用户体验。