web-dev-qa-db-ja.com

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

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

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": "[email protected]"}

だから、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();
}

}

Jackson How-to：Custom Serializers ：からこのコードで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)

ジャクソンでカスタムシリアライザーを使用するにはどうすればよいですか？

これは私が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はインターフェースをサポートしていないため、今はJacksonでそれを行う必要があります。

javajsonserializationjackson
97
Jonas

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

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

さらに別の可能性はJsonSerializableを実装することです。この場合、登録は不要です。

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

45
StaxMan

シリアル化するオブジェクトの任意の日付フィールドに@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);
    }

}
58
Moesio

私もこれを試してみましたが、addSerializerメソッドの呼び出しに型（.class）を含めることに失敗したJackson Webページのサンプルコードに誤りがあります。

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

お役に立てれば！

31
pmhargis

@JsonValueを使用します。

public class User {
    int id;
    String name;

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

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

8
henrik_lundgren

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

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）DoubleSerializerのみをDecimalFormat出力パターン###,##0.000でSimpleModuleに登録します。出力は次のとおりです。

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

POJOのシリアル化では、DoubleSerialzer for Doublesと通常の文字列形式を使用して、doubleとDoubleが区別されていることがわかります。

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のシリアル化に依存することはできません。

7
laughing_man

私の場合（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;
    }
}

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

5
user11153

Jacksonの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);
5
Paul M

カスタム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;
    }
}
4
madx

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

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

1
Mike G

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

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