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



Answers

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

}
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과 지금해야합니다.




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

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




@JsonValue 사용 :

public class User {
    int id;
    String name;

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

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




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



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



Related