Question

我找不到在Gson序列化期间添加自定义字段的简单方法，我希望其他人可以提供帮助。

这是一个展示我的问题的示例类：

public class A {
  String id;
  String name;
  ...
}

当我序列化A类时，我想返回类似的内容：

{ "id":"123", "name":"John Doe", "url_to_user":"http://www.example.com/123" }

其中url_to_user未存储在我的A类实例中，但可以使用A类实例中的数据生成。

有一种简单的方法吗？我宁愿避免编写整个序列化程序只是为了添加一个字段。

Answer 1

使用Gson.toJsonTree获取JsonElement，您可以动态进行互动。

A a = getYourAInstanceHere();
Gson gson = new Gson();
JsonElement jsonElement = gson.toJsonTree(a);
jsonElement.getAsJsonObject().addProperty("url_to_user", url);
return gson.toJson(jsonElement);

Answer 2

嗯，评分最高的答案是一个快速的答案，当您缺乏很多时间时，答案基本上不是坏，但这是问题所在：没有适当的separation of concern

您正在编写业务逻辑的同一位置修改序列化的JSON。您应该在TypeAdapter或JsonSerializer内部进行所有序列化。

我们如何保持适当的关注分离？

答案包含了一些额外的复杂性，但是体系结构要求它。我们去了（摘自我的other answer）：

首先，我们将对类型使用定制的序列化器。其次，我们必须在基类和包装子类中创建一个 copy构造器，如下所示：

注意：自定义序列化程序看似过大，但请相信我，从长远来看，它具有可维护性的价值。

// Lets say the base class is named Cat
public class Cat {

    public String name;

    public Cat(String name) {
        super();
        this.name = name;
    }
    // COPY CONSTRUCTOR
    public Cat(Cat cat) {
        this.name = cat.name;
    }

    @Override
    public String sound() {
        return name + " : \"meaow\"";
    };
}



    // The wrapper subclass for serialization
public class CatWrapper extends Cat{


    public CatWrapper(String name) {
        super(name);
    }

    public CatWrapper(Cat cat) {
        super(cat);
    }
}

还有类型为Cat的序列化器：

public class CatSerializer implements JsonSerializer<Cat> {

    @Override
    public JsonElement serialize(Cat src, Type typeOfSrc, JsonSerializationContext context) {

        // Essentially the same as the type Cat
        JsonElement catWrapped = context.serialize(new CatWrapper(src));

        // Here, we can customize the generated JSON from the wrapper as we want.
        // We can add a field, remove a field, etc.

        // The main logic from the top rated answer now here instead of *spilling* around(Kindly ignore the cat having a url for the sake of example)
        return catWrapped.getAsJsonObject().addProperty("url_to_user", url);
    }
}

那么，为什么要使用复制构造函数？

好吧，一旦定义了复制构造函数，无论基类有多大变化，您的包装器都将继续扮演相同的角色。其次，如果我们没有定义复制构造函数，而只是简单地对基类进行子类化，那么我们将不得不就扩展类（即CatWrapper）进行“交谈”。您的组件很有可能根据基类而不是包装器类型进行交谈。

Gson在序列化期间添加字段

2 个答案: