96

我见过很多使用自定义 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]
}
4

3 回答 3

134

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

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

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），然后调用 hook 方法beforeWrite()让子类自定义该树。对于反序列化也是如此afterRead()。

接下来我们将其子类化以用于特定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 的新TypeAdapter和TypeAdapterFactory类型非常强大，但它们也是抽象的，需要练习才能有效使用。希望你觉得这个例子有用！

于 2012-06-30T07:50:50.967 回答
16

还有另一种方法。正如 Jesse Wilson 所说，这应该很容易。猜猜看，这很容易！

如果你为你的类型实现JsonSerializer和JsonDeserializer，你可以处理你想要的部分并将其他所有部分委托给 Gson，只需要很少的代码。为方便起见，我引用了@Perception 对下面另一个问题的回答，有关更多详细信息，请参阅该回答：

在这种情况下，最好使用 aJsonSerializer而不是 a 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 的方法看起来会更好。这是易用性与灵活性的权衡，任您选择。

于 2016-02-02T07:57:53.220 回答
10

我的同事也提到了@JsonAdapter注解的使用

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

该页面已移至此处：https ://www.javadoc.io/doc/com.google.code.gson/gson/latest/com.google.gson/com/google/gson/annotations/JsonAdapter.html

例子：

 private static final class Gadget {
   @JsonAdapter(UserJsonAdapter2.class)
   final User user;
   Gadget(User user) {
       this.user = user;
   }
 }
于 2018-06-21T19:48:31.743 回答