Gson 序列化字段仅在不为空或不为空时

serialization json java groovy gson

2022-09-01 10:55:05

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

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

例如：

//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序列化类会很好。

答案 1

创建您自己的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是番石榴类。如果您不需要该依赖项，则可以进行自己的检查。

答案 2

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

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

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