将 Java 类转换为 JSON!

粘贴 Java class·record 代码即可生成示例 JSON!支持 Jackson @JsonProperty, @JsonIgnore, Lombok。适用于 API 文档和测试请求体(sample JSON)。
Java
结果
 

将 Java 类转换为 JSON!

把 Java DTO、POJO 或 record 源码交给它,就能得到 Spring Boot 默认 Jackson 配置下最可能生成的 JSON。key 来自声明的字段,并应用 @JsonProperty、@JsonIgnore、@JsonIgnoreProperties 以及 static/transient 的排除规则。

可以根据 controller 的请求或响应 DTO 生成 Swagger 示例或给前端的示例 payload,也可以单纯用来检查 Lombok @Data 类会输出哪些 key。

使用方法

  1. 直接粘贴 DTO 源码。import、Lombok 注解、构造函数和方法都可以保留。
  2. 把嵌套的 static class、record 和 enum 声明放进同一个输入,引用它们的字段才会按其结构填充。
  3. 根类型 设为 自动 时,会选择没有被其他类用作字段类型的类。实体之间互相引用时,请从列表中选择想要的那个。
  4. 把输出复制到 @Schema(example = ...)、REST Docs 片段或 MockMvc 请求体中。

示例

输入 (Java)
@Data
@JsonIgnoreProperties({"password"})
public class MemberResponse {
    private Long memberId;
    @JsonProperty("nick_name")
    private String nickname;
    private String password;
    private Grade grade = Grade.SILVER;
    private LocalDate birthDate;
    private List<Address> addresses;
    private static final long serialVersionUID = 1L;

    public enum Grade { BRONZE, SILVER, GOLD }

    public record Address(String zipCode, String city, boolean primary) {}
}
输出 (JSON)
{
  "memberId": 0,
  "nick_name": "",
  "grade": "SILVER",
  "birthDate": "1970-01-01",
  "addresses": [
    {
      "zipCode": "",
      "city": "",
      "primary": false
    }
  ]
}

password 被类级别的 @JsonIgnoreProperties({"password"}) 去掉,static final 的 serialVersionUID 根本不会出现。初始值 Grade.SILVER 会被读取,所以 grade 是 "SILVER" 而不是 enum 的第一个常量。嵌套的 record Address 展开为对象数组。

支持的功能

  • 字段名作为 key,可被 @JsonProperty("x") 或 @JsonProperty(value = "x") 覆盖。
  • 排除:@JsonIgnore 字段、类级别 @JsonIgnoreProperties({...}) 中列出的 key,以及 static 或 transient 字段。
  • 支持 Java 16+ 的 record 组件、嵌套的 static class 声明,以及通过 extends 继承的字段(父类字段在前)。
  • enum 字段以字符串形式取第一个常量,或字段初始值中指定的常量;常量上的 @JsonProperty("x") 会把字符串改为 x。
  • 日期遵循 Spring Boot 默认的 Jackson 输出:LocalDateTime → 1970-01-01T00:00:00,LocalDate → 1970-01-01,Instant/OffsetDateTime/ZonedDateTime → 以 Z 结尾的 ISO 字符串,java.util.Date/Timestamp → 1970-01-01T00:00:00.000+00:00。
  • BigDecimal、Long 等数值包装类型变成 0,Optional<T> 拆开为 T,byte[] 变成 Base64 字符串,UUID 和 MongoDB 的 ObjectId 会得到格式正确的值。
  • List、Set 和数组得到一个示例元素;Map<Long, V> 这样 key 为数值的 map 使用 "0",否则使用 "key"。

使用场景

填写 springdoc / Swagger 示例

手写的 example 值每当 DTO 增加字段就会过时。从 DTO 源码生成 JSON,再在此基础上打磨值,就不会有遗漏或拼错的 key。

MockMvc 或 RestAssured 测试的请求体

直接根据 @RequestBody 的 DTO 生成请求 JSON,粘贴到测试中的文本块(""")里。用 @JsonProperty 改名的 key 已经应用,与实际绑定一致。

与前端共享响应结构

不读后端代码的前端开发者可以直接拿到接口的 JSON 结构,而不必去解读 Java 类。

注意事项与限制

  • 字段初始值为字面量(= "guest"、= 100、= true)或 enum 常量(= Grade.SILVER)时会被采用;new ArrayList<>() 或方法调用等其他情况则退回到该类型的占位值。
  • 没有对应字段的 getter,如 getFullName() 或 boolean isVip(),会像 Jackson 那样作为属性加入,并遵循该 getter 上的 @JsonIgnore/@JsonProperty。反过来,没有 getter 的 private 字段被假定为可见(如同使用了 Lombok 的 @Getter/@Data)。
  • 不会应用全局命名规则(@JsonNaming(SnakeCaseStrategy.class)、spring.jackson.property-naming-strategy)和 @JsonFormat 日期格式。
  • 不会对 enum 上的 @JsonValue 方法求值,所以这类 enum 仍显示常量(或其 @JsonProperty 名称)。
  • Spring Data 的 Page<T>/Slice<T> 字段被简化为元素数组;实际的 Page 序列化结果是包含 content、pageable 等的对象。

常见问题

访问器由 Lombok 的 @Data 或 @Getter 生成时也能用吗?

能。key 是根据声明的字段构建的,所以 Lombok 在编译时生成的 getter 和 setter 不需要出现在源码中。

为什么 LocalDateTime 是字符串而不是数字数组?

Spring Boot 默认注册 jackson-datatype-jsr310 并关闭 WRITE_DATES_AS_TIMESTAMPS,因此输出 ISO 字符串;示例遵循这一默认设置。单纯的 Jackson ObjectMapper 则可能写成 [1970,1,1,0,0] 这样的数组。

能粘贴 JPA 实体吗?

实体的字段结构相同,所以能正常解析。@OneToMany 等双向关联会形成循环,因此只展开一次,之后用 null 或空数组截断。另外也有专门的 Spring Boot JPA → JSON 页面。

如果 @JsonIgnore 写在 setter 上,或写在已有字段的 getter 上会怎样?

字段声明上的注解总是生效;getter 上的注解只有在不存在同名字段时才生效。写在 setter 上或已声明字段的 getter 上的 @JsonIgnore 不会被应用,请把它移到字段上以查看效果。