Java の DTO、POJO、record のソースを渡すと、Spring Boot の既定の Jackson 設定が出力するであろう JSON が得られます。キーは宣言されたフィールドから作り、@JsonProperty、@JsonIgnore、@JsonIgnoreProperties、static/transient による除外を反映します。
コントローラーのリクエスト/レスポンス DTO から Swagger の例やフロントエンド向けのサンプルペイロードを作るときや、Lombok の @Data クラスがどのキーを出力するかを確かめたいときに使えます。
static class、record、enum の宣言も同じ入力に含めると、それを参照するフィールドが構造つきで埋まります。ルート型 が 自動 のときは、他のクラスからフィールドの型として使われていないクラスが選ばれます。エンティティが互いに参照し合っている場合は、リストから目的のものを選んでください。@Schema(example = ...)、REST Docs のスニペット、MockMvc のリクエストボディに使います。@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) {}
}{
"memberId": 0,
"nick_name": "",
"grade": "SILVER",
"birthDate": "1970-01-01",
"addresses": [
{
"zipCode": "",
"city": "",
"primary": false
}
]
}password はクラスに付いた @JsonIgnoreProperties({"password"}) によって除外され、static final の serialVersionUID は出てきません。初期化子の Grade.SILVER を読み取るので、grade は enum の最初の定数ではなく "SILVER" になります。ネストした record Address はオブジェクトの配列に展開されています。
@JsonProperty("x") や @JsonProperty(value = "x") で上書きされます。@JsonIgnore のフィールド、クラスに付けた @JsonIgnoreProperties({...}) に挙げたキー、static や transient のフィールド。record のコンポーネント、ネストした static class の宣言、extends で継承したフィールド(親のフィールドが先)に対応しています。@JsonProperty("x") があれば文字列は x になります。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、配列は要素を1つ持ちます。Map<Long, V> のように数値キーのマップは "0"、それ以外は "key" をキーにします。手書きの example の値は、DTO にフィールドが増えるたびに実態とずれていきます。DTO のソースから JSON を生成し、そこから値を整えれば、キーの抜けや綴り間違いがなくなります。
@RequestBody の DTO から直接リクエスト JSON を作り、テストのテキストブロック(""")に貼り付けられます。@JsonProperty で変えたキー名もすでに反映されており、実際のバインドと一致します。
バックエンドのコードを読まないフロントエンドの開発者にも、Java のクラスを読み解いてもらう代わりに、エンドポイントの JSON 構造を直接渡せます。
= "guest"、= 100、= true)か enum 定数(= Grade.SILVER)のときに使います。new ArrayList<>() やメソッド呼び出しなどそれ以外のものは、型ごとの仮の値になります。getFullName() や boolean isVip() のように対応するフィールドのない getter は、Jackson と同じくプロパティとして追加し、その getter の @JsonIgnore/@JsonProperty も反映します。逆に getter のない private フィールドは、(Lombok の @Getter/@Data のように)見えるものとみなします。@JsonNaming(SnakeCaseStrategy.class)、spring.jackson.property-naming-strategy)や @JsonFormat の日付パターンは反映されません。@JsonValue メソッドは評価しないため、そうした enum も定数名(またはその @JsonProperty の名前)で表示されます。Page<T>/Slice<T> フィールドは要素の配列に簡略化されます。実際の Page のシリアライズ結果は content、pageable などを持つオブジェクトです。@Data や @Getter がアクセサーを生成する場合でも使えますか?使えます。キーは宣言されたフィールドから作るので、Lombok がコンパイル時に生成する getter や setter がソースになくても問題ありません。
LocalDateTime が数値の配列ではなく文字列になるのはなぜですか?Spring Boot は jackson-datatype-jsr310 を登録し、既定で WRITE_DATES_AS_TIMESTAMPS を無効にしているため ISO 文字列になります。サンプルもその既定に従っています。素の Jackson の ObjectMapper では、[1970,1,1,0,0] のような配列が出力されることがあります。
エンティティも同じフィールド構造なので問題なく解析できます。@OneToMany のような双方向の関連は無限ループになるため、一度だけ展開したあと null や空の配列で打ち切ります。Spring Boot JPA → JSON 専用のページもあります。
@JsonIgnore が setter や、既存フィールドの getter に付いている場合はどうなりますか?フィールド宣言のアノテーションは常に適用され、getter のアノテーションはその名前のフィールドがない場合にだけ適用されます。setter に付けた @JsonIgnore や、宣言済みフィールドの getter に付けたものは反映されないので、効果を見たい場合はフィールドに移してください。