特定のフィールドのジャクソンJSONカスタムシリアル化

93

Jackson JSONプロセッサを使用してカスタムフィールドレベルのシリアル化を行う方法はありますか？たとえば、私はクラスを持っていると思います

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

次のJSONにシリアル化：

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

age = 25は数値としてエンコードされ、favoriteNumber = 123は文字列としてエンコードされることに注意してください。箱から出してすぐに、ジャクソンintは多くの人を集めます。この場合、favoriteNumberを文字列としてエンコードします。

java  json  serialization  jackson 
— スティーブクオ
ソース
1
私は、Jacksonでカスタムシリアライザーを作成する方法に関する投稿を書きました。
— Sam Berry

回答:

106

次のようにカスタムシリアライザーを実装できます。 

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が自動ボクシングをintto Integerで処理するはずです。

— ケビン・ボワーソックス
ソース
3
Jackson-databind（少なくとも2.1.3）にはすでに特別なToStringSerializerが含まれています。私の答えを参照してください。
— werupokz 2013
@KevinBowersox 逆シリアル化の問題を解決できますか？
— JJD 2014年
4
— Gareth Latty、2015
これを行うためのそれほどひどくない方法はありますか？のようにPerson implements ToJson？
— jameshfisher 2015年
1
私の場合、as=String.class使用したタイプが原因で、一部で失敗しました。@ kevin-bowersox、@ GarethLattyの発言に合わせて、コメントを更新することをお勧めします。
— バート・
54

Jackson-databind（少なくとも2.1.3）は特別なToStringSerializer（com.fasterxml.jackson.databind.ser.std.ToStringSerializer）を提供します

例：

public class Person {
    public String name;
    public int age;
    @JsonSerialize(using = ToStringSerializer.class)
    public int favoriteNumber:
}
— Werupokz
ソース
3
文字列をintに変換する必要がある逆はどうですか？ToIntSerializer.classが表示されません。
— jEremyB 2015
— Drew Stephens
ToStringSerializerは機能しますが、FloatSerializerは次のメッセージを表示します：コンテンツを書き込めませんでした：java.lang.Integerをjava.lang.Floatにキャストできません
— Arnie Schwarzvogel
12

jackson-annotationsは@JsonFormat、カスタムシリアライザーを記述する必要なしに多くのカスタマイズを処理できる機能を提供します。

たとえば、STRING数値タイプのフィールドの形状を要求すると、数値が文字列として出力されます

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

望ましい出力になります

{"name":"Joe","age":25,"favoriteNumber":"123"}
— オレグ・エステキン
ソース
11

フィールドに@JsonPropertyを返す注釈付きゲッターを追加Stringし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"}
    }
}
— ジョアン・シルバ
ソース
7

アノテーションでモデルを汚染したくない場合や、カスタム操作を実行したい場合は、ミックスインを使用できます。

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

年齢を上書き：

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

年齢に応じて必要なことをすべて実行します。

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");
    }
}
— イゴールG.
ソース
2

@JsonViewの助けを借りて 10個のプロパティを持つコアクラスを1つ持つことができますが、クライアントに必要な5個のプロパティのみをシリアル化できるように、最小限の基準（基準を定義する必要があります）を満たすシリアル化するモデルクラスのフィールドを決定できますのみ

次のクラスを作成するだけでビューを定義します。

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

ビュー付きの注釈付きモデルクラス：

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

ここで、SpringからHttpMessageConverterクラスを拡張するだけで、カスタムjsonコンバーターを作成する必要があります。

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

}

今度は、これを単にdispatcher-servlet.xmlに入れて、このカスタムjson変換を使用するようにSpringに指示する必要があります。

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

これにより、シリアル化するフィールドを決定できます。

— チェタン・パルデシ
ソース
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.