将 JPA 实体 转换为 JSON!

输入 JPA 实体,即可生成示例 JSON!支持 JPA @Entity, Hibernate, Spring Boot。适用于 API 文档和测试请求体(sample JSON)。
JPA
结果
 

将 JPA 实体 转换为 JSON!

粘贴 Spring Boot JPA 的 @Entity 类,就能看到 controller 返回这些实体时,Jackson 生成的那种结构的示例 JSON。字段名、@JsonIgnore 和 @JsonProperty、从 @MappedSuperclass 继承的字段以及 Java 8 日期类型,都按 Spring Boot 默认的 Jackson 配置处理。

可以用于 REST Docs 或 Swagger 示例、Postman 请求体,或者检查在不经 DTO 直接暴露实体时,有哪些字段泄漏了出去。

使用方法

  1. 把实体类粘贴到 JPA 框中。import 和 Lombok 注解可以保留;父类、关联实体和 enum 也请一并放进来,这样它们的值才能被填充。
  2. 没有被其他类引用的类会成为根。实体之间互相引用时,选择 public 类。
  3. 把结果复制到测试或文档中。

示例

输入 (Java · JPA)
@MappedSuperclass
public abstract class BaseEntity {
    @Id @GeneratedValue
    private Long id;
    private LocalDateTime createdAt;
}

@Entity
public class Appointment extends BaseEntity {
    private LocalDate visitDate;
    private BigDecimal fee;
    @Enumerated(EnumType.STRING)
    private Status status;
    @ManyToOne(fetch = FetchType.LAZY)
    private Patient patient;

    public enum Status { BOOKED, DONE, CANCELED }
}

@Entity
class Patient extends BaseEntity {
    private String name;
    @JsonIgnore
    private String residentNumber;
    @OneToMany(mappedBy = "patient")
    private List<Appointment> appointments;
}
输出 (JSON)
{
  "id": 0,
  "createdAt": "1970-01-01T00:00:00",
  "visitDate": "1970-01-01",
  "fee": 0,
  "status": "BOOKED",
  "patient": {
    "id": 0,
    "createdAt": "1970-01-01T00:00:00",
    "name": "",
    "appointments": []
  }
}

Appointment 和 Patient 互相引用,所以 public 类 Appointment 是根,Patient.appointments 被截断为空数组,而不会无限循环。来自 BaseEntity 的 id 和 createdAt 排在最前面,residentNumber 因为 @JsonIgnore 而消失。LocalDateTime 是不带偏移的 ISO 字符串,enum 显示其第一个常量 "BOOKED"。

支持的功能

  • 跳过 static、transient 字段和 @JsonIgnore 字段,以及类级别 @JsonIgnoreProperties({"..."}) 中列出的名称。
  • @JsonProperty("doctor_name") 会重命名 JSON key。
  • 当父类(@MappedSuperclass 或任何 extends)在输入中时,它的字段排在最前面。
  • private Status status = Status.ACTIVE; 或 private int visits = 0; 这样的实体默认值会以该值显示;没有对应字段的计算型 getter(public int getAge())会作为额外的 key 出现,与 Jackson 的输出一致。
  • 日期输出遵循 Spring Boot 默认设置:LocalDate → 1970-01-01,LocalDateTime → 1970-01-01T00:00:00,java.util.Date → 1970-01-01T00:00:00.000+00:00。
  • BigDecimal、Long 等数值包装类型为 0,UUID 为全零的 UUID,byte[] 为 base64 字符串 "AA=="。
  • List/Set 为单元素数组,Map<Long, String> 为 key 相应的对象({"0": ""}),Optional<T> 拆开为内部的值。
  • 双向关联(@OneToMany 配合 @ManyToOne)在绕回的地方用 null 或空数组截断。

使用场景

Spring REST Docs 和 Swagger 示例

直接从实体生成 @Schema(example = ...) 或文档片段所需的 JSON,字段变化时再粘贴一次,文档就能保持同步。

检查暴露的实体

如果不经 DTO 直接返回实体,请检查密码或身份证号之类的字段是否出现在响应中。输出中的字段就是 Jackson 会序列化的字段。

MockMvc 请求体

把输出用作 mockMvc.perform(post("/appointments").content(...)) 的骨架,先去掉生成的 id 和时间戳,再填入值。

注意事项与限制

  • 真实的 Jackson 遇到双向关联会无限递归(StackOverflowError)。如果输出看起来被截断了,就说明该用 @JsonManagedReference/@JsonBackReference、@JsonIgnore 或 DTO 了。
  • Jackson 默认不会忽略 JPA 的 @Transient 注解,所以这类字段会保留在输出中;只有带 Java transient 关键字的字段才会被去掉。
  • FetchType.LAZY 关联在实际中可能因为是 Hibernate 代理而序列化失败;输出假定所有内容都已加载。
  • 类不在输入中的字段显示为 null,nullable、length 等 @Column 约束不会被应用。

常见问题

日期真的应该是字符串,而不是 [2024,1,1] 这样的数组吗?

Spring Boot 关闭了 WRITE_DATES_AS_TIMESTAMPS,所以 LocalDateTime 会写成 ISO 字符串。只注册了 JavaTimeModule 的手动创建的 ObjectMapper 则可能写成数组。

没有 Lombok 的 @Getter,所有字段也会显示吗?

本工具依据字段声明工作。真实的 Jackson 默认通过 getter(或 public 字段)序列化,所以没有 getter 的 private 字段可能不会出现在实际响应中。

MongoDB 的 @Document 类也能粘贴吗?

它们遵循同样的 Jackson 规则,但 ObjectId、@Field 等 MongoDB 特有的注意事项,请参阅 Spring Data MongoDB 转 JSON 页面。