Пользовательский сериализатор Gson для одной переменной (из многих) в объекте с помощью TypeAdapter

это отличный вопрос, потому что он изолирует то, что должно быть легко, но на самом деле требует много кода.

для начала напишите реферат TypeAdapterFactory что дает вам крючки для изменения исходящих данных. В этом примере используется новый API в Gson 2.2 под названием 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();

Дсын это TypeAdapter и TypeAdapterFactory типы чрезвычайно мощные, но они также абстрактны и требуют практики для эффективного использования. Надеюсь, вы найдете этот пример полезен!