Это отличный вопрос, потому что он изолирует то, что должно быть простым, но на самом деле требует большого количества кода.
Для начала напишите аннотацию, 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
), а затем вызывает метод перехвата, beforeWrite()
чтобы позволить подклассу настроить это дерево. Аналогично для десериализации с afterRead()
.
Затем мы подклассифицируем это для конкретного MyClass
примера. Чтобы проиллюстрировать это, я добавлю к карте синтетическое свойство, называемое size, после ее сериализации. И для симметрии я удалю его после десериализации. На практике это может быть любая настройка.
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 чрезвычайно мощны, но они также абстрактны и требуют практики для эффективного использования. Надеюсь, этот пример окажется для вас полезным!
new MyClassTypeAdapterFactory()
с частным ctor ...Есть другой подход к этому. Как говорит Джесси Уилсон, это должно быть легко. И угадайте , что это является просто!
Если вы реализуете
JsonSerializer
иJsonDeserializer
для своего типа, вы можете обрабатывать нужные части и делегировать Gson для всего остального с очень небольшим кодом. Я цитирую ответ @ Perception на другой вопрос ниже для удобства, см. Этот ответ для получения более подробной информации:Однако я признаю, что подход Джесси выглядит лучше, если вы часто собираетесь изменять поля в своем объекте Java. Это компромисс между простотой использования и гибкостью, выбирайте сами.
источник
value
в gsonМой коллега также упомянул об использовании
@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.
Пример:
источник