Collez un exemple JSON et obtenez des classes ou des records Java que Jackson peut désérialiser immédiatement. Les objets imbriqués deviennent des classes supplémentaires dans le même fichier, et les tableaux deviennent des List<T>.
Utilisez-le pour les DTO que vous taperiez sinon à la main dans Spring Boot : types de réponse pour les clients RestTemplate, WebClient ou Feign, ou corps de requête pour des API tierces. Sur Java 16+, vous pouvez générer des records, et si votre base de code utilise déjà Lombok, l'option Lombok garde la sortie dans le même style.
Nom du type. Seule la première classe est public : faites-la correspondre au nom du fichier.class (avec getters/setters) ou record sous Style.class, cochez Lombok pour remplacer les getters/setters par @Data, @NoArgsConstructor et @AllArgsConstructor..java et ajoutez votre déclaration de package.{
"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;
}
}
Les clés snake_case comme full_name sont associées à un champ fullName via @JsonProperty. private étant un mot-clé Java, le champ est devenu private_ tandis que ses accesseurs restent getPrivate()/setPrivate(), et l'objet owner a été extrait dans une classe Owner du même fichier.
class classique avec getters/setters, ou un record immuable.@Data, @NoArgsConstructor, @AllArgsConstructor avec leurs imports et supprime le code des accesseurs.@JsonProperty n'est ajouté que là où le nom du champ diffère de la clé JSON, avec son import.Integer, Long, Double, Boolean), donc un null JSON passe sans travail supplémentaire.Long ; les valeurs de types mélangés deviennent Object.class ou default, reçoivent un _ final ; les clés commençant par un chiffre reçoivent un préfixe n.// Root: List<RootItem> et la classe d'élément.Collez l'exemple de réponse de la doc d'une API de paiement, de cartographie ou de messagerie et passez la classe générée à restTemplate.getForObject(url, PaymentResponse.class). Plus l'imbrication est profonde, plus vous évitez d'oublier des champs par rapport à une saisie manuelle.
Pour des réponses que vous ne faites que lire, un record est plus court et n'a pas de setters ; Jackson 2.12+ désérialise via le constructeur canonique du record.
Dans un projet legacy où seuls des fichiers JSON de fixtures existent, injectez-en un pour voir la disposition des champs et obtenir un premier jet du DTO.
null dans le type wrapper ; rien ne le marque comme optionnel. Ajoutez @NotNull ou équivalent vous-même si vous validez les valeurs obligatoires.@JsonIgnoreProperties(ignoreUnknown = true) ou la désactivation de FAIL_ON_UNKNOWN_PROPERTIES.String. Les mapper vers LocalDateTime ou OffsetDateTime nécessite le module jackson-datatype-jsr310.record masque la case Lombok, les records n'en ayant pas besoin.public. Séparez-les dans leurs propres fichiers si d'autres packages en ont besoin.getXxx et non isXxx ?Le type du champ est le wrapper Boolean, pas le primitif boolean. Jackson ne reconnaît depuis longtemps les accesseurs isXxx que pour le boolean primitif : getXxx est donc utilisé pour que la propriété se lie de la même manière quelle que soit la version de Jackson.
record conserve-t-elle @JsonProperty ?Oui, les composants renommés sont écrits @JsonProperty("full_name") String fullName. Jackson 2.12 ou ultérieur les remplit via le constructeur canonique.
spring.jackson.property-naming-strategy=SNAKE_CASE, puis-je supprimer les annotations ?Avec une stratégie SNAKE_CASE globale, full_name ↔ fullName se mappe sans annotations. Les noms modifiés à cause de mots-clés, comme private_, ne sont pas couverts par la stratégie : gardez ces annotations-là.
Gson ignore @JsonProperty. Remplacez-le par @SerializedName dans la sortie class et la même structure fonctionne avec Gson ; les records sont pris en charge à partir de Gson 2.10.