To świetne pytanie, ponieważ wyodrębnia coś, co powinno być łatwe, ale w rzeczywistości wymaga dużo kodu.
Na początek napisz streszczenie TypeAdapterFactory
, które pozwoli Ci zmodyfikować dane wychodzące. W tym przykładzie użyto nowego interfejsu API w Gson 2.2 o nazwie, getDelegateAdapter()
który umożliwia wyszukanie adaptera, którego Gson używałby domyślnie. Adaptery delegatów są bardzo przydatne, jeśli chcesz po prostu dostosować standardowe zachowanie. W przeciwieństwie do w pełni niestandardowych adapterów będą one automatycznie aktualizowane podczas dodawania i usuwania pól.
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) {
}
}
Powyższa klasa używa domyślnej serializacji, aby uzyskać drzewo JSON (reprezentowane przez JsonElement
), a następnie wywołuje metodę hook, beforeWrite()
aby umożliwić podklasie dostosowanie tego drzewa. Podobnie w przypadku deserializacji z afterRead()
.
Następnie podklasujemy to dla konkretnego MyClass
przykładu. Aby zilustrować, dodam syntetyczną właściwość o nazwie „size” do mapy, gdy jest ona serializowana. I dla symetrii usunę go, gdy zostanie zdeserializowany. W praktyce może to być dowolna personalizacja.
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");
}
}
Na koniec połącz to wszystko razem, tworząc niestandardową Gson
instancję, która korzysta z adaptera nowego typu:
Gson gson = new GsonBuilder()
.registerTypeAdapterFactory(new MyClassTypeAdapterFactory())
.create();
Nowe typy TypeAdapter i TypeAdapterFactory firmy Gson są niezwykle zaawansowane, ale są również abstrakcyjne i wymagają praktyki, aby skutecznie używać. Mamy nadzieję, że ten przykład okaże się przydatny!
new MyClassTypeAdapterFactory()
z prywatnym ctor ...Jest inne podejście do tego. Jak mówi Jesse Wilson, ma to być łatwe. I wiecie co, to jest proste!
Jeśli zaimplementujesz
JsonSerializer
iJsonDeserializer
dla swojego typu, możesz obsłużyć żądane części i delegować do Gson na wszystko inne , z bardzo małą ilością kodu. Cytuję z odpowiedzią @ percepcji na innym pytaniu poniżej dla wygody zobaczyć tę odpowiedź więcej szczegółów:Jednak przyznaję, że podejście Jessego wygląda lepiej, jeśli często zamierzasz modyfikować pola w obiekcie Java. To kompromis między łatwością obsługi a elastycznością, wybierz.
źródło
value
daje delegacji wszystkich innych dziedzin na gsonMój kolega również wspomniał o zastosowaniu
@JsonAdapter
adnotacjihttps://google.github.io/gson/apidocs/com/google/gson/annotations/JsonAdapter.htmlStrona została przeniesiona tutaj: https://www.javadoc.io/doc/com.google.code.gson/gson/latest/com.google.gson/com/google/gson/annotations/JsonAdapter.html
Przykład:
źródło