Jacksonでカスタムシリアライザーを使用するにはどうすればよいですか?


111

Jacksonを使用してJSONにシリアル化するJavaクラスが2つあります。

public class User {
    public final int id;
    public final String name;

    public User(int id, String name) {
        this.id = id;
        this.name = name;
    }
}

public class Item {
    public final int id;
    public final String itemNr;
    public final User createdBy;

    public Item(int id, String itemNr, User createdBy) {
        this.id = id;
        this.itemNr = itemNr;
        this.createdBy = createdBy;
    }
}

アイテムをこのJSONにシリアル化したい:

{"id":7, "itemNr":"TEST", "createdBy":3}

のみを含むようにシリアル化されたユーザーid。次のように、すべてのユーザーオブジェクトをJSONにシリアライズすることもできます。

{"id":3, "name": "Jonas", "email": "jonas@example.com"}

だから私Itemはこれのためにカスタムシリアライザを書く必要があると思います:

public class ItemSerializer extends JsonSerializer<Item> {

@Override
public void serialize(Item value, JsonGenerator jgen,
        SerializerProvider provider) throws IOException,
        JsonProcessingException {
    jgen.writeStartObject();
    jgen.writeNumberField("id", value.id);
    jgen.writeNumberField("itemNr", value.itemNr);
    jgen.writeNumberField("createdBy", value.user.id);
    jgen.writeEndObject();
}

}

私はジャクソンハウツーからのこのコードでJSONをシリアル化します:カスタムシリアライザー

ObjectMapper mapper = new ObjectMapper();
SimpleModule simpleModule = new SimpleModule("SimpleModule", 
                                              new Version(1,0,0,null));
simpleModule.addSerializer(new ItemSerializer());
mapper.registerModule(simpleModule);
StringWriter writer = new StringWriter();
try {
    mapper.writeValue(writer, myItem);
} catch (JsonGenerationException e) {
    e.printStackTrace();
} catch (JsonMappingException e) {
    e.printStackTrace();
} catch (IOException e) {
    e.printStackTrace();
}

しかし、私はこのエラーを受け取ります:

Exception in thread "main" java.lang.IllegalArgumentException: JsonSerializer of type com.example.ItemSerializer does not define valid handledType() (use alternative registration method?)
    at org.codehaus.jackson.map.module.SimpleSerializers.addSerializer(SimpleSerializers.java:62)
    at org.codehaus.jackson.map.module.SimpleModule.addSerializer(SimpleModule.java:54)
    at com.example.JsonTest.main(JsonTest.java:54)

Jacksonでカスタムシリアライザーを使用するにはどうすればよいですか?


これは私がGsonでそれをする方法です:

public class UserAdapter implements JsonSerializer<User> {

    @Override 
    public JsonElement serialize(User src, java.lang.reflect.Type typeOfSrc,
            JsonSerializationContext context) {
        return new JsonPrimitive(src.id);
    }
}

    GsonBuilder builder = new GsonBuilder();
    builder.registerTypeAdapter(User.class, new UserAdapter());
    Gson gson = builder.create();
    String json = gson.toJson(myItem);
    System.out.println("JSON: "+json);

しかし、Gsonはインターフェースをサポートしていないため、今はジャクソンでそれを行う必要があります。


どのように/どこでジャクソンにカスタムシリアライザを使用させましたItemか?コントローラーメソッドが標準のシリアル化されたオブジェクトを返すという問題がありますTypeAが、別の特定のコントローラーメソッドについては、別の方法でシリアル化したいと考えています。それはどのように見えますか?
Don Cheadle 2015

私は、Jacksonカスタムシリアライザーを作成する方法に関する投稿を書きました。
Sam Berry

回答:


51

前述のように、@ JsonValueは良い方法です。しかし、カスタムシリアライザーを気にしない場合は、アイテム用に1つ作成する必要はなく、ユーザー用に1つ作成する必要があります。そうであれば、次のように簡単です。

public void serialize(Item value, JsonGenerator jgen,
    SerializerProvider provider) throws IOException,
    JsonProcessingException {
  jgen.writeNumber(id);
}

さらに別の可能性はを実装することJsonSerializableです。この場合、登録は必要ありません。

エラーに関して; それは奇妙です-あなたはおそらくより新しいバージョンにアップグレードしたいでしょう。ただし、org.codehaus.jackson.map.ser.SerializerBase必須ではないメソッド(つまり、実際のシリアル化呼び出し以外のすべて)の標準的な実装があるため、拡張する方が安全です。


これで、私は同じエラーを取得:Exception in thread "main" java.lang.IllegalArgumentException: JsonSerializer of type com.example.JsonTest$UserSerilizer does not define valid handledType() (use alternative registration method?) at org.codehaus.jackson.map.module.SimpleSerializers.addSerializer(SimpleSerializers.java:62) at org.codehaus.jackson.map.module.SimpleModule.addSerializer(SimpleModule.java:54) at com.example.JsonTest.<init>(JsonTest.java:27) at com.exampple.JsonTest.main(JsonTest.java:102)
ジョナス

Jacsksonの最新の安定バージョン1.8.5を使用しています。
ジョナス

4
ありがとう。見てみるよ…ああ!それは実際には単純です(ただし、エラーメッセージは適切ではありません)。シリアライザを対象とするクラスを指定するには、シリアライザを別のメソッドに登録する必要があります。そうでない場合は、handledType()からクラスを返す必要があります。したがって、JavaTypeまたはClassを引数として取る「addSerializer」を使用すると、機能するはずです。
StaxMan 2011

これが実行されていない場合はどうなりますか?
Matej J

62

@JsonSerialize(using = CustomDateSerializer.class)シリアル化するオブジェクトの任意の日付フィールドを置くことができます。

public class CustomDateSerializer extends SerializerBase<Date> {

    public CustomDateSerializer() {
        super(Date.class, true);
    }

    @Override
    public void serialize(Date value, JsonGenerator jgen, SerializerProvider provider)
        throws IOException, JsonProcessingException {
        SimpleDateFormat formatter = new SimpleDateFormat("EEE MMM dd yyyy HH:mm:ss 'GMT'ZZZ (z)");
        String format = formatter.format(value);
        jgen.writeString(format);
    }

}

1
注目に値する:@JsonSerialize(contentUsing= ...)コレクションに注釈を付けるときに使用(例:@JsonSerialize(contentUsing= CustomDateSerializer.class) List<Date> dates
coderatchet

33

私もこれを試してみましたが、Jackson Webページのサンプルコードに、メソッド.classの呼び出しにタイプ()を含めることができず、次のaddSerializer()ようになっているはずです。

simpleModule.addSerializer(Item.class, new ItemSerializer());

つまり、これらはをインスタンス化しsimpleModuleてシリアライザを追加する行です(前の誤った行はコメント化されています)。

ObjectMapper mapper = new ObjectMapper();
SimpleModule simpleModule = new SimpleModule("SimpleModule", 
                                          new Version(1,0,0,null));
// simpleModule.addSerializer(new ItemSerializer());
simpleModule.addSerializer(Item.class, new ItemSerializer());
mapper.registerModule(simpleModule);

参考:正しいコード例のリファレンスは次のとおりです:http : //wiki.fasterxml.com/JacksonFeatureModules


9

@JsonValueを使用します。

public class User {
    int id;
    String name;

    @JsonValue
    public int getId() {
        return id;
    }
}

@JsonValueはメソッドでのみ機能するため、getIdメソッドを追加する必要があります。カスタムシリアライザーを完全にスキップできるはずです。


2
これは、ユーザーをシリアル化するすべての試みに影響し、JSONを介してユーザーの名前を公開することが困難になると思います。
Paul M

また、すべてのフィールドを持つすべてのユーザーオブジェクトをシリアル化できる必要があるため、このソリューションは使用できません。そして、idフィールドのみが含まれるため、このソリューションはそのシリアル化を壊します。Gson用のように、Jackson用のカスタムシリライザーを作成する方法はありませんか?
ジョナス

1
JSONビュー(私の答え)があなたのニーズに合わない理由についてコメントできますか?
Paul M

@ユーザー:それは良い解決策かもしれません。
ジョナス

2
また、@ JsonSerialize(using = MySerializer.class)を使用してプロパティ(フィールドまたはゲッター)の特定のシリアル化を示すことができるため、型のすべてのインスタンスではなく、メンバープロパティにのみ使用されることに注意してください。
StaxMan 2011

8

私はカスタムのTimestamp.classシリアル化/逆シリアル化の例を書きましたが、これは何でも好きなときに使用できます。

オブジェクトマッパーを作成するときは、次のようにします。

public class JsonUtils {

    public static ObjectMapper objectMapper = null;

    static {
        objectMapper = new ObjectMapper();
        SimpleModule s = new SimpleModule();
        s.addSerializer(Timestamp.class, new TimestampSerializerTypeHandler());
        s.addDeserializer(Timestamp.class, new TimestampDeserializerTypeHandler());
        objectMapper.registerModule(s);
    };
}

たとえば、java ee次のように初期化できます。

import java.time.LocalDateTime;

import javax.ws.rs.ext.ContextResolver;
import javax.ws.rs.ext.Provider;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;

@Provider
public class JacksonConfig implements ContextResolver<ObjectMapper> {

    private final ObjectMapper objectMapper;

    public JacksonConfig() {
        objectMapper = new ObjectMapper();
        SimpleModule s = new SimpleModule();
        s.addSerializer(Timestamp.class, new TimestampSerializerTypeHandler());
        s.addDeserializer(Timestamp.class, new TimestampDeserializerTypeHandler());
        objectMapper.registerModule(s);
    };

    @Override
    public ObjectMapper getContext(Class<?> type) {
        return objectMapper;
    }
}

シリアライザは次のようになります。

import java.io.IOException;
import java.sql.Timestamp;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;

public class TimestampSerializerTypeHandler extends JsonSerializer<Timestamp> {

    @Override
    public void serialize(Timestamp value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException {
        String stringValue = value.toString();
        if(stringValue != null && !stringValue.isEmpty() && !stringValue.equals("null")) {
            jgen.writeString(stringValue);
        } else {
            jgen.writeNull();
        }
    }

    @Override
    public Class<Timestamp> handledType() {
        return Timestamp.class;
    }
}

そして、このようなデシリアライザ:

import java.io.IOException;
import java.sql.Timestamp;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.SerializerProvider;

public class TimestampDeserializerTypeHandler extends JsonDeserializer<Timestamp> {

    @Override
    public Timestamp deserialize(JsonParser jp, DeserializationContext ds) throws IOException, JsonProcessingException {
        SqlTimestampConverter s = new SqlTimestampConverter();
        String value = jp.getValueAsString();
        if(value != null && !value.isEmpty() && !value.equals("null"))
            return (Timestamp) s.convert(Timestamp.class, value);
        return null;
    }

    @Override
    public Class<Timestamp> handledType() {
        return Timestamp.class;
    }
}

7

これらは、ジャクソンのシリアライゼーションを理解しようとしたときに気付いた行動パターンです。

1)オブジェクトClassroomとクラスStudentがあるとします。簡単にするために、すべてを公開し、最終的なものにしました。

public class Classroom {
    public final double double1 = 1234.5678;
    public final Double Double1 = 91011.1213;
    public final Student student1 = new Student();
}

public class Student {
    public final double double2 = 1920.2122;
    public final Double Double2 = 2324.2526;
}

2)これらがオブジェクトをJSONにシリアル化するために使用するシリアライザーであると想定します。オブジェクトマッパーに登録されている場合、writeObjectFieldはオブジェクト自体のシリアライザーを使用します。そうでない場合は、POJOとしてシリアル化します。writeNumberFieldは引数としてプリミティブのみを受け入れます。

public class ClassroomSerializer extends StdSerializer<Classroom> {
    public ClassroomSerializer(Class<Classroom> t) {
        super(t);
    }

    @Override
    public void serialize(Classroom value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException {
        jgen.writeStartObject();
        jgen.writeObjectField("double1-Object", value.double1);
        jgen.writeNumberField("double1-Number", value.double1);
        jgen.writeObjectField("Double1-Object", value.Double1);
        jgen.writeNumberField("Double1-Number", value.Double1);
        jgen.writeObjectField("student1", value.student1);
        jgen.writeEndObject();
    }
}

public class StudentSerializer extends StdSerializer<Student> {
    public StudentSerializer(Class<Student> t) {
        super(t);
    }

    @Override
    public void serialize(Student value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException {
        jgen.writeStartObject();
        jgen.writeObjectField("double2-Object", value.double2);
        jgen.writeNumberField("double2-Number", value.double2);
        jgen.writeObjectField("Double2-Object", value.Double2);
        jgen.writeNumberField("Double2-Number", value.Double2);
        jgen.writeEndObject();
    }
}

3)SimpleModuleで、DecimalFormat出力パターンを持つDoubleSerializerのみを登録###,##0.000します。出力は次のとおりです。

{
  "double1" : 1234.5678,
  "Double1" : {
    "value" : "91,011.121"
  },
  "student1" : {
    "double2" : 1920.2122,
    "Double2" : {
      "value" : "2,324.253"
    }
  }
}

POJOシリアライゼーションがdoubleとDoubleを区別していることがわかります。DoublesにはDoubleSerialzerを使用し、doubleには通常のString形式を使用しています。

4)StudentSerializerなしでDoubleSerializerとClassroomSerializerを登録します。doubleをオブジェクトとして書き込むとDoubleのように動作し、Doubleを数値として書き込むとdoubleのように動作する出力が期待されます。Studentインスタンス変数はPOJOとして記述され、登録されないため、上記のパターンに従う必要があります。

{
  "double1-Object" : {
    "value" : "1,234.568"
  },
  "double1-Number" : 1234.5678,
  "Double1-Object" : {
    "value" : "91,011.121"
  },
  "Double1-Number" : 91011.1213,
  "student1" : {
    "double2" : 1920.2122,
    "Double2" : {
      "value" : "2,324.253"
    }
  }
}

5)すべてのシリアライザを登録します。出力は次のとおりです。

{
  "double1-Object" : {
    "value" : "1,234.568"
  },
  "double1-Number" : 1234.5678,
  "Double1-Object" : {
    "value" : "91,011.121"
  },
  "Double1-Number" : 91011.1213,
  "student1" : {
    "double2-Object" : {
      "value" : "1,920.212"
    },
    "double2-Number" : 1920.2122,
    "Double2-Object" : {
      "value" : "2,324.253"
    },
    "Double2-Number" : 2324.2526
  }
}

予想通り。

別の重要な注意:同じモジュールに登録された同じクラスのシリアライザーが複数ある場合、モジュールはリストに最後に追加されたそのクラスのシリアライザーを選択します。これは使用すべきではありません-混乱を招き、これがどれほど一貫しているかはわかりません

モラル:オブジェクト内のプリミティブのシリアライゼーションをカスタマイズする場合は、オブジェクト用に独自のシリアライザを作成する必要があります。POJO Jacksonのシリアル化に依存することはできません。


Classroomの発生などを処理するためにClassroomSerializerをどのように登録しますか?
Trismegistos

5

ジャクソンのJSONビューは、特にJSON形式にある程度の柔軟性がある場合、要件を達成するためのより簡単な方法である可能性があります。

場合は{"id":7, "itemNr":"TEST", "createdBy":{id:3}}許容表現があり、これは非常に少ないコードで実現するのは非常に簡単になります。

ユーザーの名前フィールドにビューの一部として注釈を付け、シリアル化要求で別のビューを指定するだけです(注釈なしフィールドはデフォルトで含まれます)。

例:ビューを定義します。

public class Views {
    public static class BasicView{}
    public static class CompleteUserView{}
}

ユーザーに注釈を付ける:

public class User {
    public final int id;

    @JsonView(Views.CompleteUserView.class)
    public final String name;

    public User(int id, String name) {
        this.id = id;
        this.name = name;
    }
}

そして、非表示にするフィールドを含まないビューを要求してシリアル化します(非注釈フィールドはデフォルトでシリアル化されます)。

objectMapper.getSerializationConfig().withView(Views.BasicView.class);

私はジャクソンJSONビューを使用するのが難しいと感じており、この問題の適切な解決策を得ることができません。
ジョナス

ジョナス-例を追加しました。同じオブジェクトをさまざまな方法でシリアル化するための非常に優れたソリューションのビューを見つけました。
ポールM

良い例をありがとう。これはこれまでのところ最良の解決策です。しかしcreatedBy、オブジェクトとしてではなく値として取得する方法はありませんか?
ジョナス

setSerializationView()廃止予定なので、mapper.viewWriter(JacksonViews.ItemView.class).writeValue(writer, myItem);代わりに使用しました。
ジョナス

jsonviewsを使用することは疑います。ビューを発見する前に私が使用した迅速で汚い解決策は、興味のあるプロパティをマップにコピーしてから、マップをシリアル化することでした。
ポールM

5

私の場合(Spring 3.2.4およびJackson 2.3.1)、カスタムシリアライザーのXML構成:

<mvc:annotation-driven>
    <mvc:message-converters register-defaults="false">
        <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
            <property name="objectMapper">
                <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
                    <property name="serializers">
                        <array>
                            <bean class="com.example.business.serializer.json.CustomObjectSerializer"/>
                        </array>
                    </property>
                </bean>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

原因不明の方法で上書きされてデフォルトに戻りました。

これは私のために働きました:

CustomObject.java

@JsonSerialize(using = CustomObjectSerializer.class)
public class CustomObject {

    private Long value;

    public Long getValue() {
        return value;
    }

    public void setValue(Long value) {
        this.value = value;
    }
}

CustomObjectSerializer.java

public class CustomObjectSerializer extends JsonSerializer<CustomObject> {

    @Override
    public void serialize(CustomObject value, JsonGenerator jgen,
        SerializerProvider provider) throws IOException,JsonProcessingException {
        jgen.writeStartObject();
        jgen.writeNumberField("y", value.getValue());
        jgen.writeEndObject();
    }

    @Override
    public Class<CustomObject> handledType() {
        return CustomObject.class;
    }
}

<mvc:message-converters>(...)</mvc:message-converters>私のソリューションではXML構成()は必要ありません。


1

カスタムシリアライザーの唯一の要件がのnameフィールドのシリアル化をスキップするUserことである場合、それを一時的としてマークします。ジャクソンは一時的なフィールドをシリアライズまたはデシリアライズしません。

[参照:Javaに一時フィールドがあるのはなぜですか?]


どこにマークしますか?でUser-class?ただし、すべてのユーザーオブジェクトもシリアル化します。たとえば、最初にitemsuserIdユーザーオブジェクトへの参照としてのみ)allのみをシリアル化し、次にallをシリアル化しますusers。この場合、-classでフィールドをマークできませんUser
ジョナス

この新しい情報を踏まえると、このアプローチは機能しません。Jacksonがカスタムシリアライザーの詳細情報を探しているようです(handledType()メソッドはオーバーライドが必要ですか?)
Mike G

はい、しかしhandledType()私がリンクしたドキュメンテーションにはメソッドについては何も書かれておらず、Eclipseがnoを実装するメソッドを生成するときにhandledType()生成されるので、混乱しています。
ジョナス

リンクしたWikiがそれを参照していないため、私にはわかりませんが、バージョン1.5.1にはhandledType()があり、例外はメソッドが見つからないか無効であることを報告しているようです(基本クラスがメソッドからnullを返します)。jackson.codehaus.org/1.5.1/javadoc/org/codehaus/jackson/map/…–
Mike G、

1

あなたはhandledTypeメソッドをオーバーライドする必要があり、すべてが機能します

@Override
public Class<Item> handledType()
{
  return Item.class;
}

0

あなたの場合の問題は、ItemSerializerにJsonSerializerからオーバーライドする必要のあるHandledType()メソッドがないことです。

    public class ItemSerializer extends JsonSerializer<Item> {

    @Override
    public void serialize(Item value, JsonGenerator jgen,
            SerializerProvider provider) throws IOException,
            JsonProcessingException {
        jgen.writeStartObject();
        jgen.writeNumberField("id", value.id);
        jgen.writeNumberField("itemNr", value.itemNr);
        jgen.writeNumberField("createdBy", value.user.id);
        jgen.writeEndObject();
    }

   @Override
   public Class<Item> handledType()
   {
    return Item.class;
   }
}

したがって、handledType()が定義されていないという明示的なエラーが発生します

Exception in thread "main" java.lang.IllegalArgumentException: JsonSerializer of type com.example.ItemSerializer does not define valid handledType() 

それが誰かを助けることを願っています。私の答えを読んでくれてありがとう。

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