Programing

TypeAdapter를 사용하는 개체의 하나의 변수에 대한 Gson 사용자 지정 세랄 라이저

lottogame 2020. 9. 3. 23:39
반응형

TypeAdapter를 사용하는 개체의 하나의 변수에 대한 Gson 사용자 지정 세랄 라이저


사용자 지정 TypeAdapter를 사용하는 간단한 예제를 많이 보았습니다. 가장 도움이되는 것은 Class TypeAdapter<T>. 그러나 그것은 아직 내 질문에 대한 답을 얻지 못했습니다.

객체에서 단일 필드의 직렬화를 사용자 정의하고 기본 Gson 메커니즘이 나머지를 처리하도록하고 싶습니다.

토론 목적으로이 클래스 정의를 직렬화하려는 객체의 클래스로 사용할 수 있습니다. Gson이 처음 두 클래스 멤버와 기본 클래스의 모든 노출 된 멤버를 직렬화하도록하고, 아래 표시된 세 번째 및 마지막 클래스 멤버에 대해 사용자 지정 직렬화를 수행하려고합니다.

public class MyClass extends SomeClass {

@Expose private HashMap<String, MyObject1> lists;
@Expose private HashMap<String, MyObject2> sources;
private LinkedHashMap<String, SomeClass> customSerializeThis;
    [snip]
}

이것은 쉽지만 실제로 많은 코드가 필요한 것을 분리하기 때문에 좋은 질문입니다.

시작하려면 TypeAdapterFactory나가는 데이터를 수정할 수있는 후크를 제공 하는 초록 작성하십시오 . 이 예에서는 getDelegateAdapter()Gson이 기본적으로 사용할 어댑터를 조회 할 수 있도록하는 Gson 2.2의 새 API를 사용합니다. 델리게이트 어댑터는 표준 동작을 조정하려는 경우 매우 편리합니다. 또한 전체 사용자 지정 유형 어댑터와 달리 필드를 추가 및 제거 할 때 자동으로 최신 상태로 유지됩니다.

public abstract class CustomizedTypeAdapterFactory<C>
    implements TypeAdapterFactory {
  private final Class<C> customizedClass;

  public CustomizedTypeAdapterFactory(Class<C> customizedClass) {
    this.customizedClass = customizedClass;
  }

  @SuppressWarnings("unchecked") // we use a runtime check to guarantee that 'C' and 'T' are equal
  public final <T> TypeAdapter<T> create(Gson gson, TypeToken<T> type) {
    return type.getRawType() == customizedClass
        ? (TypeAdapter<T>) customizeMyClassAdapter(gson, (TypeToken<C>) type)
        : null;
  }

  private TypeAdapter<C> customizeMyClassAdapter(Gson gson, TypeToken<C> type) {
    final TypeAdapter<C> delegate = gson.getDelegateAdapter(this, type);
    final TypeAdapter<JsonElement> elementAdapter = gson.getAdapter(JsonElement.class);
    return new TypeAdapter<C>() {
      @Override public void write(JsonWriter out, C value) throws IOException {
        JsonElement tree = delegate.toJsonTree(value);
        beforeWrite(value, tree);
        elementAdapter.write(out, tree);
      }
      @Override public C read(JsonReader in) throws IOException {
        JsonElement tree = elementAdapter.read(in);
        afterRead(tree);
        return delegate.fromJsonTree(tree);
      }
    };
  }

  /**
   * Override this to muck with {@code toSerialize} before it is written to
   * the outgoing JSON stream.
   */
  protected void beforeWrite(C source, JsonElement toSerialize) {
  }

  /**
   * Override this to muck with {@code deserialized} before it parsed into
   * the application type.
   */
  protected void afterRead(JsonElement deserialized) {
  }
}

위의 클래스는 기본 직렬화를 사용하여 JSON 트리 (로 JsonElement표시됨)를 가져온 다음 후크 메서드 beforeWrite()호출 하여 하위 클래스가 해당 트리를 사용자 지정할 수 있도록합니다. .NET을 사용한 역 직렬화와 유사합니다 afterRead().

Next we subclass this for the specific MyClass example. To illustrate I'll add a synthetic property called 'size' to the map when it's serialized. And for symmetry I'll remove it when it's deserialized. In practice this could be any customization.

private class MyClassTypeAdapterFactory extends CustomizedTypeAdapterFactory<MyClass> {
  private MyClassTypeAdapterFactory() {
    super(MyClass.class);
  }

  @Override protected void beforeWrite(MyClass source, JsonElement toSerialize) {
    JsonObject custom = toSerialize.getAsJsonObject().get("custom").getAsJsonObject();
    custom.add("size", new JsonPrimitive(custom.entrySet().size()));
  }

  @Override protected void afterRead(JsonElement deserialized) {
    JsonObject custom = deserialized.getAsJsonObject().get("custom").getAsJsonObject();
    custom.remove("size");
  }
}

Finally put it all together by creating a customized Gson instance that uses the new type adapter:

Gson gson = new GsonBuilder()
    .registerTypeAdapterFactory(new MyClassTypeAdapterFactory())
    .create();

Gson's new TypeAdapter and TypeAdapterFactory types are extremely powerful, but they're also abstract and take practice to use effectively. Hopefully you find this example useful!


There's another approach to this. As Jesse Wilson says, this is supposed to be easy. And guess what, it is easy!

If you implement JsonSerializer and JsonDeserializer for your type, you can handle the parts you want and delegate to Gson for everything else, with very little code. I'm quoting from @Perception's answer on another question below for convenience, see that answer for more details:

In this case its better to use a JsonSerializer as opposed to a TypeAdapter, for the simple reason that serializers have access to their serialization context.

public class PairSerializer implements JsonSerializer<Pair> {
    @Override
    public JsonElement serialize(final Pair value, final Type type,
            final JsonSerializationContext context) {
        final JsonObject jsonObj = new JsonObject();
        jsonObj.add("first", context.serialize(value.getFirst()));
        jsonObj.add("second", context.serialize(value.getSecond()));
        return jsonObj;
    }
}

The main advantage of this (apart from avoiding complicated workarounds) is that you can still advantage of other type adaptors and custom serializers that might have been registered in the main context. Note that registration of serializers and adapters use the exact same code.

However, I will acknowledge that Jesse's approach looks better if you're frequently going to modify fields in your Java object. It's a trade-off of ease-of-use vs flexibility, take your pick.


My colleague also mentioned the use of the @JsonAdapter annotation

https://google.github.io/gson/apidocs/com/google/gson/annotations/JsonAdapter.html

Example:

 private static final class Gadget {
   @JsonAdapter(UserJsonAdapter2.class)
   final User user;
   Gadget(User user) {
       this.user = user;
   }
 }

참고URL : https://stackoverflow.com/questions/11271375/gson-custom-seralizer-for-one-variable-of-many-in-an-object-using-typeadapter

반응형