JSON のサンプルを貼り付けると、Jackson ですぐにデシリアライズできる Java のクラスまたは record が得られます。ネストしたオブジェクトは同じファイル内の別クラスになり、配列は List<T> になります。
Spring Boot で手打ちしがちな DTO、つまり RestTemplate、WebClient、Feign クライアントのレスポンス型や、外部 API へのリクエストボディに使えます。Java 16 以降なら record を出力でき、コードベースですでに Lombok を使っているなら Lombok オプションで同じスタイルにそろえられます。
型名 に DTO の名前を入力します。public になるのは最初のクラスだけなので、ファイル名と合わせてください。スタイル で class(getter/setter 付き)か record を選びます。class の場合、Lombok にチェックを入れると getter/setter が @Data、@NoArgsConstructor、@AllArgsConstructor に置き換わります。.java ファイルに貼り付け、パッケージ宣言を追加します。{
"id": 1296269,
"full_name": "octocat/Hello-World",
"private": false,
"stargazers_count": 80,
"owner": { "login": "octocat", "site_admin": false },
"topics": ["api", "demo"]
}import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.List;
public class Repository {
private Integer id;
@JsonProperty("full_name") private String fullName;
@JsonProperty("private") private Boolean private_;
@JsonProperty("stargazers_count") private Integer stargazersCount;
private Owner owner;
private List<String> topics;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getFullName() {
return fullName;
}
public void setFullName(String fullName) {
this.fullName = fullName;
}
public Boolean getPrivate() {
return private_;
}
public void setPrivate(Boolean private_) {
this.private_ = private_;
}
public Integer getStargazersCount() {
return stargazersCount;
}
public void setStargazersCount(Integer stargazersCount) {
this.stargazersCount = stargazersCount;
}
public Owner getOwner() {
return owner;
}
public void setOwner(Owner owner) {
this.owner = owner;
}
public List<String> getTopics() {
return topics;
}
public void setTopics(List<String> topics) {
this.topics = topics;
}
}
class Owner {
private String login;
@JsonProperty("site_admin") private Boolean siteAdmin;
public String getLogin() {
return login;
}
public void setLogin(String login) {
this.login = login;
}
public Boolean getSiteAdmin() {
return siteAdmin;
}
public void setSiteAdmin(Boolean siteAdmin) {
this.siteAdmin = siteAdmin;
}
}
full_name のような snake_case のキーは、@JsonProperty を介して fullName フィールドに対応付けられます。private は Java のキーワードなのでフィールドは private_ になりましたが、アクセサーは getPrivate()/setPrivate() のままです。owner オブジェクトは同じファイル内の Owner クラスに切り出されています。
class か、イミュータブルな record。@Data、@NoArgsConstructor、@AllArgsConstructor と import を追加し、アクセサーのコードを省きます。@JsonProperty は、フィールド名が JSON のキーと異なる箇所にだけ import とともに追加します。Integer、Long、Double、Boolean)を使うので、JSON の null も追加の手間なく収まります。Long に、型が混在する値は Object になります。class や default のようなキーワードのキーには末尾に _ が付き、数字で始まるキーには n の接頭辞が付きます。// Root: List<RootItem> というコメントと要素のクラスを出力します。決済、地図、メッセージング API のドキュメントにあるサンプルレスポンスを貼り付け、生成されたクラスを restTemplate.getForObject(url, PaymentResponse.class) に渡します。ネストが深いほど、手書きに比べてフィールドの書き漏れを防げます。
読むだけのレスポンスなら、record のほうが短く setter もありません。Jackson 2.12 以降は record の正規コンストラクターを通してデシリアライズします。
フィクスチャの JSON ファイルしか残っていないレガシープロジェクトでも、フィクスチャを入力すればフィールド構成がわかり、DTO の最初の下書きが得られます。
null として入るだけで、省略可能であることを示す印は付きません。必須の値を検証するなら @NotNull などを自分で付けてください。@JsonIgnoreProperties(ignoreUnknown = true) や FAIL_ON_UNKNOWN_PROPERTIES の無効化を検討してください。String で出力されます。LocalDateTime や OffsetDateTime に対応付けるには jackson-datatype-jsr310 モジュールが必要です。record を選ぶと、record には不要なため Lombok のチェックボックスは非表示になります。public ではなく、同じファイル内のパッケージプライベートなクラスです。他のパッケージから使う場合は別ファイルに分けてください。isXxx ではなく getXxx なのはなぜですか?フィールドの型がプリミティブの boolean ではなくラッパーの Boolean だからです。Jackson は長らく、isXxx のアクセサーをプリミティブの boolean に対してしか認識してこなかったため、どのバージョンの Jackson でも同じようにバインドされるよう getXxx を使っています。
record の出力でも @JsonProperty は残りますか?残ります。名前を変えたコンポーネントは @JsonProperty("full_name") String fullName と書かれます。Jackson 2.12 以降なら正規コンストラクターを通して値が入ります。
spring.jackson.property-naming-strategy=SNAKE_CASE を設定すれば、アノテーションを消せますか?グローバルな SNAKE_CASE 戦略なら、アノテーションなしで full_name ↔ fullName が対応します。ただし private_ のようにキーワードのせいで変わった名前は戦略の対象外なので、そのアノテーションは残してください。
Gson は @JsonProperty を無視します。class の出力で @SerializedName に置き換えれば同じ構造が Gson でも動きます。record は Gson 2.10 から対応しています。