使用自定义 typeadapter 添加对象，在 gson 中使用 jsonwriter

json java gson

2022-09-04 06:44:57

gson是一个很棒的库 - 它运行良好。有时我有自定义要求，可以制作和注册TypeAdapters和TypeAdaptorFactories - 这也很好。

然而，让我感到困惑的是如何委托回json序列化...大多数时候，我需要这个集合，但为了说明这一点 - 假设我有一个对类，gson显然会愉快地序列化，但由于某种原因，我需要自己的自定义序列化程序。井。。。如果我的对是

public class Pair
{
    public final Object First;
    public final Object Second; 
    public Pair( Object first, Object second) {this.first = first; this.second = second};
}

如果我为此编写了一个类型适配器 - 你会希望写入函数看起来像这样：

public void write( JsonWriter out, Pair pair )
{
    out.beginObject();
    out.name( "first");
    out.value( pair.first );         // can't do this
    out.name( "second");
    out.value( pair.second);         // or this
    out.endObject();
}

所以你可以看到问题 - 我不知道第一和第二的类型，也不知道它们是如何序列化的。我可以使用gson.toJson来序列化第一个和第二个 - 但是如果我将它们作为字符串添加到编写器中，它们将被转义。有一个gson.tojson函数，它接受一个值和一个编写器 - 但它也需要一个打字标记 - 我没有。我有点印象，我打算从某个地方拥有另一种类型适配器 - 但是当我只是有一个对象列表时......我在哪里得到的？我只是为对象获取适配器吗？

我有点困惑？当然，这是最常见的用例吗？大多数自定义序列化程序将用于一个奇怪的T列表或T树或其他东西，你真的不知道列表中有什么，除了它从T继承...所以你需要能够以某种方式委托回序列化？

无论如何 - 如果有人能告诉我如何编写上述函数，我将不胜感激！

答案 1

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

public class PairSerializer implements JsonSerializer<Pair> {

    public PairSerializer() {
        super();
    }

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

上面的代码示例演示如何将目标对象的序列化委托给主编组。这样做的主要优点（除了避免复杂的解决方法之外）是，您仍然可以利用可能已在主上下文中注册的其他类型的适配器和自定义序列化程序。请注意，序列化程序和适配器的注册使用完全相同的代码：

// With adapter
final Gson gson = new GsonBuilder().registerTypeAdapter(Pair.class,
        new PairAdapter()).create();

// With serializer
final Gson gson = new GsonBuilder().registerTypeAdapter(Pair.class,
        new PairSerializer()).create();

如果您发现需要坚持使用适配器，则可以使用嵌入式 Gson 代理为您序列化 Pair 属性，缺点是无法访问在父 Gson 代理上进行的自定义注册：

public class PairAdapter extends TypeAdapter<Pair> {
    final Gson embedded = new Gson();

    public PairAdapter() {
        super();
    }

    @Override
    public void write(final JsonWriter out, final Pair value)
            throws IOException {
        out.beginObject();

        out.name("first");
        embedded.toJson(embedded.toJsonTree(value.getFirst()), out);

        out.name("second");
        embedded.toJson(embedded.toJsonTree(value.getSecond()), out);

        out.endObject();
    }

    @Override
    public Pair read(JsonReader in) throws IOException {
        throw new UnsupportedOperationException();
    }
}

答案 2

实际上，这似乎有效 - 获取对象的适配器 - 使用typeadaptorfactory在对象上发现“json”方法，并让它存储适配器对象。对于这样一个显而易见的用例来说，似乎非常复杂？

例如：

public static @Nullable
TypeAdapter<ImmutableStack<?>> json(final Gson gson)
{
    final TypeAdapter<Object> adaptor = gson.getAdapter(Object.class);
    return new TypeAdapter<ImmutableStack<?>>()
    {
        @Override
        public ImmutableStack<?> read(@Nullable final JsonReader in) throws IOException
        {
            throw ProgramError.notImplementedYet();
        }
        @Override
        public void write(final JsonWriter out, final ImmutableStack<?> value) throws IOException
        {
            out.beginArray();
            for (final Object inner : value)
                adaptor.write(out, inner);
            out.endArray();
        }
    };
}

有谁知道更好的方法来做到这一点？