仅当不为空或不为空时才对 Gson 序列化字段

Question

我有需要将 java 对象转换为 json 的要求。

我为此使用 Gson，但我需要转换器仅序列化非 null 或非空值。

例如：

//my java object looks like
class TestObject{
    String test1;
    String test2;
    OtherObject otherObject = new OtherObject();
}

现在我的 Gson 实例将此对象转换为 json 看起来像

Gson gson = new Gson();
TestObject obj = new TestObject();
obj.test1 = "test1";
obj.test2 = "";

String jsonStr = gson.toJson(obj);
println jsonStr;

在上面的打印中，结果是

{"test1":"test1", "test2":"", "otherObject":{}}

这里我只想得到结果

{"test1":"test1"}

由于test2为空，otherObject为空，我不希望将它们序列化为json数据。

顺便说一句，我正在使用 Groovy/Grails，所以如果有任何插件会很好，如果没有任何自定义 gson 序列化类的建议会很好。

Answer 1

在我看来，问题不在于 gson。 Gson 正确地跟踪 null 和空字符串之间的差异。您确定要消除这种区别吗？你确定所有使用 TestObject 的类都不关心吗？

如果您不关心差异，您可以做的是在序列化之前将 TestObject 中的空字符串更改为 null。或者更好的是，让 TestObject 中的设置器将空字符串设置为 null；这样，您就可以在类中严格定义空字符串与 null 相同。您必须确保不能在设置器之外设置值。

Answer 2

创建您自己的TypeAdapter

public class MyTypeAdapter extends TypeAdapter<TestObject>() {

    @Override
    public void write(JsonWriter out, TestObject value) throws IOException {
        out.beginObject();
        if (!Strings.isNullOrEmpty(value.test1)) {
            out.name("test1");
            out.value(value.test1);
        }

        if (!Strings.isNullOrEmpty(value.test2)) {
            out.name("test2");
            out.value(value.test1);
        }
        /* similar check for otherObject */         
        out.endObject();    
    }

    @Override
    public TestObject read(JsonReader in) throws IOException {
        // do something similar, but the other way around
    }
}

然后您可以使用Gson 注册它。

Gson gson = new GsonBuilder().registerTypeAdapter(TestObject.class, new MyTypeAdapter()).create();
TestObject obj = new TestObject();
obj.test1 = "test1";
obj.test2 = "";
System.out.println(gson.toJson(obj));

产生

 {"test1":"test1"}

GsonBuilder 类有很多方法可以创建您自己的序列化/反序列化策略、注册类型适配器和设置其他参数。

Strings 是一个番石榴类。如果您不想要这种依赖关系，您可以自己检查。

Answer 3

我个人不喜欢在TypeAdapter 中使用答案的事实是，您需要描述整个班级的每个字段，可以说是 50 个字段（这意味着 TypeAdapter 中有 50 个 if 块）。
我的解决方案是基于Reflection 和一个事实Gson 默认情况下不会序列化空值字段。
我有一个特殊的类，它为 API 保存数据以创建名为 DocumentModel 的文档，它有大约 50 个字段，我不喜欢将带有“”（空但非空）值或空数组的 String 字段发送到服务器。所以我创建了一个特殊的方法，它返回我的对象​​的副本，其中所有空字段都为空。注意 - 默认情况下，我 DocumentModel 实例中的所有数组都初始化为空（零长度）数组，因此它们永远不会为空，您可能应该在检查数组长度之前检查数组是否为空。

public DocumentModel getSerializableCopy() {
    Field fields[] = new Field[]{};
    try {
        // returns the array of Field objects representing the public fields
        fields = DocumentModel.class.getDeclaredFields();
    } catch (Exception e) {
        e.printStackTrace();
    }
    DocumentModel copy = new DocumentModel();
    Object value;
    for (Field field : fields) {
        try {
            value = field.get(this);
            if (value instanceof String && TextUtils.isEmpty((String) value)) {
                field.set(copy, null);
            // note: here array is not being checked for null!
            else if (value instanceof Object[] && ((Object[]) value).length == 0) {
                field.set(copy, null);
            } else
                field.set(copy, value);
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        }
    }
    return copy;
}

使用此方法，我不在乎在编写此方法之后是否添加或删除了某些字段。剩下的唯一问题是检查自定义类型字段，它们不是String 或数组，但这取决于特定的类，应该在 if/else 块中额外编码。