Belirli alanlar için Jackson JSON özel serileştirme

Özel alan düzeyinde serileştirme yapmak için Jackson JSON Processor kullanmanın bir yolu var mı? Örneğin, sınıfa sahip olmak istiyorum

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

aşağıdaki JSON'da serileştirilmiştir:

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

Age = 25 bir sayı olarak kodlanırken, favoriteNumber = 123 bir dize olarak kodlanır . Kutudan çıkan Jackson int, bir numaraya koşar . Bu durumda favouriteNumber'ın bir dizge olarak kodlanmasını istiyorum.

Aşağıdaki gibi özel bir serileştirici uygulayabilirsiniz:

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 dan Autoboxing işlemesi gerektiğini intetmek Integersizin için.

Jackson-databind (en az 2.1.3) özel ToStringSerializer( com.fasterxml.jackson.databind.ser.std.ToStringSerializer) sağlar

Misal:

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

jackson-annotations @JsonFormat, özel serileştirici yazmaya gerek kalmadan birçok özelleştirmeyi gerçekleştirebilen sağlar.

Örneğin, STRINGsayısal türde bir alan için bir şekil istemek , sayısal değeri dize olarak verir.

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

istenen çıktıyla sonuçlanacak

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

Alan için @JsonPropertya döndüren açıklamalı bir alıcı ekleyin :StringfavoriteNumber

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"}
    }
}

Modelinizi açıklamalarla kirletmek istemiyorsanız ve bazı özel işlemler gerçekleştirmek istiyorsanız, mixins'i kullanabilirsiniz.

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

Yaşı geçersiz kıl:

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

Yaşla birlikte ne gerekiyorsa yap:

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");
    }
}

@JsonView yardımıyla, 10 özellikli bir çekirdek sınıfa sahip olabileceğimiz gibi minimum kriterleri karşılayan (kriterleri tanımlamalıyız) serileştirmek için model sınıflarının alanlarına karar verebiliriz, ancak istemci için gerekli olan yalnızca 5 özellik serileştirilebilir. sadece

Görünümlerimizi aşağıdaki sınıfı oluşturarak tanımlayın:

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

Görünümlere sahip açıklamalı model sınıfı:

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
...
..
}

Şimdi, HttpMessageConverter sınıfını yaydan şu şekilde genişleterek özel json dönüştürücü yazmamız gerekiyor:

    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);
        }
    }

}

Şimdi, spring'e bu özel json dönüştürmesini sadece bunu dispatcher-servlet.xml içine koyarak kullanmasını söylemek gerekiyor.

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

Hangi alanların serileştirileceğine bu şekilde karar verebilirsiniz.