
本文详解如何借助 Jackson 的 @JsonFormat 与自定义 getter 方法,在序列化时动态生成符合客户端要求的格式化日期字符串(如 "dd/MM/yyyy HH:mm:ss"),避免冗余字段和手动格式化,实现简洁、可维护、零侵入的 JSON 序列化逻辑。
本文详解如何借助 jackson 的 `@jsonformat` 与自定义 getter 方法,在序列化时动态生成符合客户端要求的格式化日期字符串(如 `"dd/mm/yyyy hh:mm:ss"`),避免冗余字段和手动格式化,实现简洁、可维护、零侵入的 json 序列化逻辑。
在基于 Jackson 的 REST API 开发中,常遇到下游服务仅提供时间戳(epoch 毫秒值),而前端或第三方系统却要求以特定格式(如 "17/02/2023 13:56:56")展示日期。此时若在 POJO 中额外声明一个 String formattedDate 字段并试图用 @JsonFormat 注解它,不仅无效——因为 @JsonFormat 仅对 Date、LocalDateTime 等可序列化/反序列化的时间类型生效——还会引入数据冗余与同步风险。
✅ 正确做法是:保留单一权威时间字段(如 Date date),通过带 @JsonFormat 的公共 getter 方法动态导出格式化结果。Jackson 默认会将所有无参 public getter 视为可序列化属性(即 getFormattedDate() → JSON 字段 "formattedDate"),且该方法返回的 Date 对象将严格按注解规则格式化为字符串。
以下是推荐的实现方式(兼容 Lombok):
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import lombok.Data;
import lombok.Builder;
import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;
import java.util.Date;
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
@JsonIgnoreProperties(ignoreUnknown = true)
public class CalendarData {
// 核心时间字段:接收 epoch long 或 Date,Jackson 反序列化时自动处理
private Date date;
private String errorCode;
private String subErrorCode;
// ✅ 动态派生字段:不占用存储,仅用于序列化输出
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "dd/MM/yyyy HH:mm:ss")
public Date getFormattedDate() {
return this.date; // 直接返回原始 Date,由 Jackson 负责格式化
}
}? 关键要点说明:
- @JsonFormat 必须作用于 Date/LocalDateTime 等时间类型,不可用于 String 字段——否则注解被忽略,无法触发格式化。
- getFormattedDate() 是普通 getter,无需对应私有字段;Lombok 的 @Data 不会为其生成 setter 或字段,完全零耦合。
- 反序列化时,date 字段仍正常接收 long(epoch)或 ISO 字符串(需配置 ObjectMapper 支持),getFormattedDate() 不参与反序列化,避免歧义。
- 若需兼容 Java 8 时间 API,可将 Date 替换为 Instant 或 LocalDateTime,并配合 @JsonDeserialize/@JsonSerialize(如使用 JavaTimeModule)。
验证示例:
public static void main(String[] args) throws JsonProcessingException {
ObjectMapper mapper = new ObjectMapper();
// 启用对 Java 8 时间类型的默认支持(如使用 Instant)
// mapper.registerModule(new JavaTimeModule());
CalendarData data = CalendarData.builder()
.date(new Date()) // 当前时间
.errorCode("23")
.subErrorCode("42")
.build();
String json = mapper.writeValueAsString(data);
System.out.println(json);
}输出结果(精确匹配指定格式):
{
"date": 1676642216673,
"errorCode": "23",
"subErrorCode": "42",
"formattedDate": "17/02/2023 13:56:56"
}? 进阶提示:
- 如需统一全局日期格式,可在 ObjectMapper 初始化时配置:
mapper.setDateFormat(new SimpleDateFormat("dd/MM/yyyy HH:mm:ss"));但建议优先使用 @JsonFormat 进行字段级精准控制。
- 若必须保留 long date 原始字段(而非 Date),可通过 @JsonSetter + 自定义 setter 实现转换,但会增加复杂度,不推荐作为首选方案。
综上,利用 Jackson 的 getter 序列化机制 + @JsonFormat,是实现“单源时间、多格式输出”的最轻量、最标准、最可维护的方案——既符合单一职责原则,又充分发挥了框架能力,无需手写工具方法或 AOP 增强。










