web-dev-qa-db-fra.com

Sérialisation personnalisée Jackson JSON pour certains champs

Existe-t-il un moyen d’utiliser le processeur JSON de Jackson pour effectuer une sérialisation personnalisée au niveau du champ? Par exemple, je voudrais avoir la classe

public class Person {
    public String name;
    public int age;
    public int favoriteNumber;
}

sérialisé vers le JSON suivant:

{ "name": "Joe", "age": 25, "favoriteNumber": "123" }

Notez que age = 25 est codé sous la forme nombre, tandis que favoriteNumber = 123 est codé sous la forme chaîne. Hors de la boîte Jackson marshalls int à un nombre. Dans ce cas, je veux que favoriteNumber soit codé sous forme de chaîne.

javajsonserializationjackson
81
Steve Kuo

Vous pouvez implémenter un sérialiseur personnalisé comme suit:

public class Person {
    public String name;
    public int age;
    @JsonSerialize(using = IntToStringSerializer.class, as=String.class)
    public int favoriteNumber:
}


public class IntToStringSerializer extends JsonSerializer<Integer> {

    @Override
    public void serialize(Integer tmpInt, 
                          JsonGenerator jsonGenerator, 
                          SerializerProvider serializerProvider) 
                          throws IOException, JsonProcessingException {
        jsonGenerator.writeObject(tmpInt.toString());
    }
}

Java devrait gérer pour vous l'autoboxing de int à Integer.

91
Kevin Bowersox

Jackson-databind (au moins 2.1.3) fournit des éléments spéciaux ToStringSerializer (com.fasterxml.jackson.databind.ser.std.ToStringSerializer)

Exemple:

public class Person {
    public String name;
    public int age;
    @JsonSerialize(using = ToStringSerializer.class)
    public int favoriteNumber:
}
49
werupokz

Ajouter un @JsonProperty _ getter annoté, qui retourne un String, pour le champ favoriteNumber:

public class Person {
    public String name;
    public int age;
    private int favoriteNumber;

    public Person(String name, int age, int favoriteNumber) {
        this.name = name;
        this.age = age;
        this.favoriteNumber = favoriteNumber;
    }

    @JsonProperty
    public String getFavoriteNumber() {
        return String.valueOf(favoriteNumber);
    }

    public static void main(String... args) throws Exception {
        Person p = new Person("Joe", 25, 123);
        ObjectMapper mapper = new ObjectMapper();
        System.out.println(mapper.writeValueAsString(p)); 
        // {"name":"Joe","age":25,"favoriteNumber":"123"}
    }
}
11
João Silva

jackson-annotations fournit @JsonFormat qui peut gérer de nombreuses personnalisations sans avoir à écrire le sérialiseur personnalisé.

Par exemple, demander une forme STRING pour un champ de type numérique affichera la valeur numérique sous forme de chaîne

public class Person {
    public String name;
    public int age;
    @JsonFormat(shape = JsonFormat.Shape.STRING)
    public int favoriteNumber;
}

se traduira par la sortie souhaitée

{"name":"Joe","age":25,"favoriteNumber":"123"}
8
Oleg Estekhin

avec l'aide de @ JsonView nous pouvons choisir les champs des classes de modèle à sérialiser qui répondent aux critères minimaux (nous devons définir les critères), tout comme nous pouvons avoir une classe de base avec 10 propriétés mais seulement 5 propriétés. être sérialiser ce qui est nécessaire pour le client seulement

Définissez nos vues en créant simplement la classe suivante:

public class Views
{
    static class Android{};
    static class IOS{};
    static class Web{};
}

Classe modèle annotée avec vues:

public class Demo 
{
    public Demo() 
    {
    }

@JsonView(Views.IOS.class)
private String iosField;

@JsonView(Views.Android.class)
private String androidField;

@JsonView(Views.Web.class)
private String webField;

 // getters/setters
...
..
}

Maintenant, nous devons écrire un convertisseur JSON personnalisé en élargissant simplement la classe HttpMessageConverter à partir du printemps comme suit:

    public class CustomJacksonConverter implements HttpMessageConverter<Object> 
    {
    public CustomJacksonConverter() 
        {
            super();
        //this.delegate.getObjectMapper().setConfig(this.delegate.getObjectMapper().getSerializationConfig().withView(Views.ClientView.class));
        this.delegate.getObjectMapper().configure(MapperFeature.DEFAULT_VIEW_INCLUSION, true);
        this.delegate.getObjectMapper().setSerializationInclusion(Include.NON_NULL);

    }

    // a real message converter that will respond to methods and do the actual work
    private MappingJackson2HttpMessageConverter delegate = new MappingJackson2HttpMessageConverter();

    @Override
    public boolean canRead(Class<?> clazz, MediaType mediaType) {
        return delegate.canRead(clazz, mediaType);
    }

    @Override
    public boolean canWrite(Class<?> clazz, MediaType mediaType) {
        return delegate.canWrite(clazz, mediaType);
    }

    @Override
    public List<MediaType> getSupportedMediaTypes() {
        return delegate.getSupportedMediaTypes();
    }

    @Override
    public Object read(Class<? extends Object> clazz,
            HttpInputMessage inputMessage) throws IOException,
            HttpMessageNotReadableException {
        return delegate.read(clazz, inputMessage);
    }

    @Override
    public void write(Object obj, MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException 
    {
        synchronized(this) 
        {
            String userAgent = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest().getHeader("userAgent");
            if ( userAgent != null ) 
            {
                switch (userAgent) 
                {
                case "IOS" :
                    this.delegate.getObjectMapper().setConfig(this.delegate.getObjectMapper().getSerializationConfig().withView(Views.IOS.class));
                    break;
                case "Android" :
                    this.delegate.getObjectMapper().setConfig(this.delegate.getObjectMapper().getSerializationConfig().withView(Views.Android.class));
                    break;
                case "Web" :
                    this.delegate.getObjectMapper().setConfig(this.delegate.getObjectMapper().getSerializationConfig().withView( Views.Web.class));
                    break;
                default:
                    this.delegate.getObjectMapper().setConfig(this.delegate.getObjectMapper().getSerializationConfig().withView( null ));
                    break;
                }
            }
            else
            {
                // reset to default view
                this.delegate.getObjectMapper().setConfig(this.delegate.getObjectMapper().getSerializationConfig().withView( null ));
            }
            delegate.write(obj, contentType, outputMessage);
        }
    }

}

Maintenant, il faut dire à spring d’utiliser ce convertisseur json personnalisé en le mettant simplement dans dispatcher-servlet.xml

<mvc:annotation-driven>
        <mvc:message-converters register-defaults="true">
            <bean id="jsonConverter" class="com.mactores.org.CustomJacksonConverter" >
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>

C'est ainsi que vous pourrez choisir les champs à sérialiser.

2
Chetan Pardeshi

Si vous ne souhaitez pas polluer votre modèle avec des annotations et que vous souhaitez effectuer des opérations personnalisées, vous pouvez utiliser mixins.

ObjectMapper mapper = new ObjectMapper();
SimpleModule simpleModule = new SimpleModule();
simpleModule.setMixInAnnotation(Person.class, PersonMixin.class);
mapper.registerModule(simpleModule);

Ignorer l'âge:

public abstract class PersonMixin {
    @JsonSerialize(using = PersonAgeSerializer.class)
    public String age;
}

Faites ce dont vous avez besoin avec l'âge:

public class PersonAgeSerializer extends JsonSerializer<Integer> {
    @Override
    public void serialize(Integer integer, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
        jsonGenerator.writeString(String.valueOf(integer * 52) + " months");
    }
}
1
Igor G.