Gson 使用 TypeAdapter 为对象中的一个变量(多个变量)自定义血清化器

2022-08-31 10:43:01

我见过很多使用自定义TypeAdapter的简单例子。最有帮助的是Class TypeAdapter<T>。但这还没有回答我的问题。

我想自定义对象中单个字段的序列化,并让默认的Gson机制来处理其余的工作。

出于讨论目的,我们可以将此类定义用作我希望序列化的对象的类。我想让 Gson 序列化前两个类成员以及基类的所有公开成员,并且我想对下面显示的第 3 个和最后一个类成员进行自定义序列化。

public class MyClass extends SomeClass {

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

答案 1

这是一个很好的问题,因为它隔离了一些应该很容易但实际上需要大量代码的东西。

首先,编写一个摘要,为您提供用于修改传出数据的钩子。此示例在 Gson 2.2 中使用了一个名为的新 API,该 API 允许您查找 Gson 默认使用的适配器。委托适配器非常方便,如果您只想调整标准行为。与完全自定义类型适配器不同,当您添加和删除字段时,它们将自动保持最新状态。TypeAdapterFactorygetDelegateAdapter()

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 树(由 表示),然后调用 hook 方法以允许子类自定义该树。与 使用 的反序列化类似。JsonElementbeforeWrite()afterRead()

接下来,我们将其子类化为特定示例。为了说明这一点,我将在序列化映射时向其添加一个名为“size”的合成属性。对于对称性,当它被反序列化时,我会删除它。在实践中,这可以是任何自定义。MyClass

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

最后,通过创建一个使用新类型适配器的自定义实例,将它们放在一起:Gson

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

Gson的新TypeAdapterTypeAdapterFactory类型非常强大,但它们也是抽象的,需要练习才能有效使用。希望这个例子有用!


答案 2

还有另一种方法。正如杰西·威尔逊(Jesse Wilson)所说,这应该很容易。你猜怎么着,很容易!

如果你实现了并且针对你的类型,你可以处理你想要的部分,并委托给Gson来完成其他所有事情,而代码很少。为了方便起见,我引用了@Perception在下面另一个问题上的答案,请参阅该答案以获取更多详细信息:JsonSerializerJsonDeserializer

在这种情况下,最好使用 JsonSerializer 而不是 TypeAdapter,原因很简单,序列化程序可以访问其序列化上下文。

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

这样做的主要优点(除了避免复杂的解决方法之外)是,您仍然可以利用可能已在主上下文中注册的其他类型的适配器和自定义序列化程序。请注意,序列化程序和适配器的注册使用完全相同的代码。

但是,我承认,如果您经常修改 Java 对象中的字段,Jesse 的方法看起来会更好。这是易用性与灵活性的权衡,任您选择。