[Java] Jackson과 함께 커스텀 시리얼 라이저를 사용하려면 어떻게해야합니까?


Answers

언급했듯이 @JsonValue는 좋은 방법입니다. 하지만 사용자 지정 serializer에 신경 쓸 필요가 없다면 Item에 대한 값을 쓰지 않고 사용자에 대해 값을 쓸 필요가 없습니다. 그렇다면 사용자는 다음과 같이 간단 할 것입니다.

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

또 다른 가능성은 JsonSerializable 을 구현하는 JsonSerializable ,이 경우 등록이 필요하지 않습니다.

오류에 관해서; 그 이상한 - 당신은 아마 최신 버전으로 업그레이 드하고 싶습니다. 그러나 org.codehaus.jackson.map.ser.SerializerBase 를 확장하는 것이 필수적이지 않은 메소드 (즉, 실제 직렬화 호출이 아닌)의 표준 구현을 가지기 때문에 안전합니다.

Question

잭슨을 사용하여 JSON에 직렬화하려는 두 개의 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 항목을 serialize하려면 :

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

사용자는 id 만 포함하도록 일련 번호가 부여됩니다. JSON에 대한 모든 사용자 객체를 다음과 같이 serilize 할 수도 있습니다.

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

그래서 Item 대한 사용자 지정 serializer를 작성해야하고 다음과 같이 시도해보아야합니다.

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 에서이 코드를 사용하여 JSON을 serialize합니다. How-to : Custom Serializers :

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은 인터페이스를 지원하지 않기 때문에 Jackson과 지금해야합니다.




이것들은 Jackson 직렬화를 이해하려고 할 때 알아 차린 행동 패턴입니다.

1) 객체 클래스 룸과 클래스 학생이 있다고 가정합니다. 나는 쉽게 모든 것을 공개하고 마지막으로 만들었습니다.

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으로 객체를 직렬화하기 위해 사용하는 serializer라고 가정합니다. 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) DecimalFormat 출력 패턴 ###,##0.000 가진 DoubleSerializer만을 SimpleModule에 등록하고 출력은 다음과 같습니다.

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

POJO 직렬화는 DoubleSerialzer for Doubles를 사용하고 double 형의 정규 String 형식을 사용하여 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
  }
}

정확히 예상대로.

또 다른 중요한 사항 : 동일한 클래스에 대해 동일한 모듈에 등록 된 여러 개의 serializer가있는 경우 모듈은 가장 최근에 목록에 추가 된 클래스의 serializer를 선택합니다. 이것은 사용되어서는 안됩니다. 혼란스럽고 이것이 얼마나 일관성이 있는지 확신하지 못합니다.

Moral : 객체의 프리미티브 직렬화를 사용자 정의하려면 객체에 대한 고유 한 직렬 변환기를 작성해야합니다. POJO Jackson 직렬화에 의존 할 수는 없습니다.




필자의 경우 (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> )이 필요 없습니다.




사용자 정의 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;
    }
}

serializer는 다음과 같이되어야합니다.

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

및 deserializer 이런 식으로 뭔가 :

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



사용자 지정 serializer의 유일한 요구 사항이 사용자의 name 필드 직렬화를 건너 뛰는 것이면 일시적인 것으로 표시하십시오. Jackson은 일시적인 필드를 serialize하거나 deserialize하지 않습니다.

[참고 : Java에 일시적인 필드가있는 이유는 무엇입니까? ]




Jackson의 JSON Views 는 특히 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;
    }
}

그리고 숨길 필드를 포함하지 않는보기를 요청하는 serialise (주석이 달린 필드는 기본적으로 serialize됩니다) :

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



@JsonValue 사용 :

public class User {
    int id;
    String name;

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

@JsonValue는 메서드에서만 작동하므로 getId 메서드를 추가해야합니다. 사용자 지정 serializer를 건너 뛸 수 있어야합니다.




직렬화 할 객체의 날짜 필드 위에 @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);
    }

}



handleType 메소드를 오버라이드 해야 하고 모든 것이 작동 할 것이다.

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



이 작업도 시도해 보았고 Jackson 웹 페이지의 예제 코드에서 addSerializer 메서드를 호출 할 때 형식 (.class)을 포함하지 못하는 실수가있었습니다. 다음과 같이 읽어야합니다.

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

다시 말해서, 이들은 simpleModule을 인스턴스화하고 serializer를 추가하는 선입니다 (이전에 잘못된 행이 주석 처리 된 상태에서).

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

FYI : 다음은 올바른 예제 코드에 대한 참조입니다. http://wiki.fasterxml.com/JacksonFeatureModules

희망이 도움이!