programing

잭슨에서 커스텀시리얼라이저를 사용하려면 어떻게 해야 하나요?

yoursource 2022. 9. 30. 09:55
반응형

잭슨에서 커스텀시리얼라이저를 사용하려면 어떻게 해야 하나요?

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세릴라이즈하다

{"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();
}

}

Jackson Howto의 코드와 함께 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은 인터페이스를 지원하지 않기 때문에 지금 잭슨과 함께 해야 합니다.

ㅇㅇㅇㅇㄹㄹㄹㄹㄹㄹㄹㄹㄹㄹㄴㄴㄴㄴㄴㄴㄴㄴㄴㄴㄴㄴㄴㄴ@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);
    }

}

앞서 말한 바와 같이 @Json Value가 좋은 방법입니다.그러나 커스텀 시리얼라이저를 사용해도 괜찮다면 Item에 쓸 필요가 없고, User에 쓸 필요가 없습니다.그렇다면 다음과 같이 간단하게 작성할 수 있습니다.

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

또 다른 하는 것입니다.JsonSerializable이 경우 등록은 필요 없습니다.

이치노아마도 최신 버전으로 업그레이드하고 싶을 것입니다., ★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★org.codehaus.jackson.map.ser.SerializerBase비필수 메서드의 표준 실장(실제 시리얼화 콜을 제외한 모든 것)이 있기 때문입니다.

웹의 예시 타입)이되지 않는 ..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

@JsonValue 사용:

public class User {
    int id;
    String name;

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

@JsonValue는 메서드에서만 동작하므로 getId 메서드를 추가해야 합니다.커스텀 시리얼라이저를 모두 생략할 수 있습니다.

가 예를 예를 하나 .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;
    }
}

이것들은 잭슨의 연재를 이해하려고 노력하면서 알게 된 행동 패턴입니다.

1) 객체의 Classroom과 클래스 학생이 있다고 가정합니다.모든 것을 쉽게 공개하고 최종적으로 공개했습니다.

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) DecimalFormat 출력 패턴에 DoubleSerializer만 등록합니다.###,##0.000출력은 다음과 같습니다.

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

POJO 시리얼라이제이션은 더블과 더블을 구별합니다.더블의 경우 Double Serialzer를 사용하고 더블의 경우 일반 String 형식을 사용합니다.

4) Student Serializer를 사용하지 않고 Double Serializer 및 Classroom Serializer를 등록합니다.오브젝트로서 더블을 쓰면 더블처럼 동작하고, 수치로서 더블을 쓰면 더블처럼 동작하는 출력이 될 것으로 예상됩니다.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
  }
}

예상대로입니다.

또 다른 중요한 주의사항:동일한 클래스에 여러 개의 시리얼라이저가 동일한 모듈에 등록되어 있는 경우 모듈은 목록에 최근에 추가된 해당 클래스의 시리얼라이저를 선택합니다.이것은 사용해서는 안 됩니다.혼란스러워서 얼마나 일관성이 있는지 모르겠습니다.

Moral: 오브젝트 내에서 프리미티브의 시리얼화를 커스터마이즈 하려면 오브젝트에 대해 독자적인 시리얼라이저를 작성해야 합니다.POJO Jackson의 시리얼화는 신뢰할 수 없습니다.

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

또한 숨길 필드가 없는 보기를 요청하는 일련 번호 지정(기본적으로 비주석 필드는 일련 번호 지정됨:

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

내 경우(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;
    }
}

Custom Object Serializer.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>솔루션에는 )가 필요합니다.

이 경우의 문제는 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() 

도움이 됐으면 좋겠는데제 답변을 읽어주셔서 감사합니다.

이 「」의 를 건너뛰는 .nameUser, 과도라고 마크합니다.Jackson은 과도 필드를 직렬화 또는 직렬화 해제하지 않습니다.

(참조 항목:Java에 임시 필드가 있는 이유는 무엇입니까?]

method handledType을 덮어써야 모든 것이 작동합니다.

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

언급URL : https://stackoverflow.com/questions/7161638/how-do-i-use-a-custom-serializer-with-jackson

반응형