Jackson surmontant les soulignés en faveur de Camel-Case

Je récupère une chaîne JSON sur Internet; comme la plupart des JSON que j'ai vu, il comprend de longues clés séparées par des traits de soulignement. Essentiellement, mon objectif est de désérialiser JSON en objets java, mais je n'utilise pas de traits de soulignement dans le code java.

Par exemple, je pourrais avoir une Userclasse avec un firstNamechamp dans camel-case, en même temps, j'ai besoin de dire à Jackson de mapper la first_nameclé de JSON au firstNamechamp de classe. C'est possible?

class User{
    protected String firstName;
    protected String getFirstName(){return firstName;}
}

Vous devez utiliser le @JsonPropertysur le champ pour lequel vous souhaitez modifier le mappage de nom par défaut.

class User{
    @JsonProperty("first_name")
    protected String firstName;
    protected String getFirstName(){return firstName;}
}

Pour plus d'informations: l' API

Vous pouvez configurer le ObjectMapperpour convertir la casse du chameau en noms avec un trait de soulignement:

objectMapper.setPropertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE);

Ou annotez une classe de modèle spécifique avec cette annotation:

@JsonNaming(PropertyNamingStrategy.SnakeCaseStrategy.class)

Avant Jackson 2.7, la constante était nommée:

PropertyNamingStrategy.CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES

Si c'est une application de démarrage à ressort, dans le fichier application.properties, utilisez simplement

spring.jackson.property-naming-strategy = SNAKE_CASE

Ou Annotez la classe de modèle avec cette annotation.

@JsonNaming (PropertyNamingStrategy.SnakeCaseStrategy.class)

Si vous le souhaitez pour une classe unique, vous pouvez utiliser PropertyNamingStrategy avec @JsonNaming , quelque chose comme ceci:

@JsonNaming(PropertyNamingStrategy.LowerCaseWithUnderscoresStrategy.class)
public static class Request {

    String businessName;
    String businessLegalName;

}

Sera sérialisé pour:

{
    "business_name" : "",
    "business_legal_name" : ""
}

Depuis Jackson 2.7le LowerCaseWithUnderscoresStrategydéconseillé en faveur de SnakeCaseStrategy, vous devez donc utiliser:

@JsonNaming(PropertyNamingStrategy.SnakeCaseStrategy.class)
public static class Request {

    String businessName;
    String businessLegalName;

}

Les réponses ci-dessus concernant @JsonPropertyet CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORESsont précises à 100%, bien que certaines personnes (comme moi) puissent essayer de le faire dans une application Spring MVC avec une configuration basée sur le code. Voici un exemple de code (que j'ai à l'intérieur Beans.java) pour obtenir l'effet souhaité:

@Bean
public ObjectMapper jacksonObjectMapper() {
    return new ObjectMapper().setPropertyNamingStrategy(
            PropertyNamingStrategy.CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES);
}

La meilleure pratique actuelle consiste à configurer Jackson dans le fichier application.yml(ou properties).

Exemple:

spring:
  jackson:
    property-naming-strategy: SNAKE_CASE

Si vous avez des exigences de configuration plus complexes, vous pouvez également configurer Jackson par programme.

import com.fasterxml.jackson.databind.PropertyNamingStrategy;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;

@Configuration
public class JacksonConfiguration {

    @Bean
    public Jackson2ObjectMapperBuilder jackson2ObjectMapperBuilder() {
        return new Jackson2ObjectMapperBuilder()
                .propertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE);
        // insert other configurations
    }

} 

Il y a quelques réponses ici indiquant les deux stratégies pour 2 versions différentes de la bibliothèque Jackson ci-dessous:

Pour Jackson 2.6. *

ObjectMapper objMapper = new ObjectMapper(new JsonFactory()); // or YAMLFactory()
objMapper.setNamingStrategy(
     PropertyNamingStrategy.CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES);

Pour Jackson 2.7. *

ObjectMapper objMapper = new ObjectMapper(new JsonFactory()); // or YAMLFactory()
objMapper.setNamingStrategy(
     PropertyNamingStrategy.SNAKE_CASE);