java - Gson序列化一般忽略空字符串

Question

有没有通用的方法告诉 Gson 不要写空字符串？

我非常不喜欢必须实现一个 TypeAdapter 来处理每个字段作为 answer here有点暗示。

Answer 1

有点。据我所知，Gson 不会让您对对象字段进行太多控制，而且我知道唯一的控制方式是 @JsonAdapter。例如，

import com.google.gson.annotations.JsonAdapter;

final class Pack {

    @JsonAdapter(EmptyStringTypeAdapter.class)
    final String foo;

    @JsonAdapter(EmptyStringTypeAdapter.class)
    final String bar;

    private Pack(final String foo, final String bar) {
        this.foo = foo;
        this.bar = bar;
    }

    static Pack of(final String foo, final String bar) {
        return new Pack(foo, bar);
    }

    @Override
    public String toString() {
        return foo + " " + bar;
    }

}

尽管它对某些人来说可能看起来很乏味，但它可以让您完全控制数据传输对象，让您可以选择如何处理这个或那个字符串。示例类型适配器可能如下所示:

final class EmptyStringTypeAdapter
        extends TypeAdapter<String> {

    private EmptyStringTypeAdapter() {
    }

    @Override
    @SuppressWarnings("resource")
    public void write(final JsonWriter jsonWriter, @Nullable final String s)
            throws IOException {
        if ( s == null || s.isEmpty() ) {
            jsonWriter.nullValue();
        } else {
            jsonWriter.value(s);
        }
    }

    @Override
    @Nonnull
    @SuppressWarnings("EnumSwitchStatementWhichMissesCases")
    public String read(final JsonReader jsonReader)
            throws IOException {
        final JsonToken token = jsonReader.peek();
        switch ( token ) {
        case NULL:
            return "";
        case STRING:
            return jsonReader.nextString();
        default:
            throw new IllegalStateException("Unexpected token: " + token);
        }
    }

}

这里需要注意的是，它无法从 null 中恢复空字符串(不幸的是，您在这里遇到了不可逆的转换)，因此您可能还想看看 https://github.com/google/gson/blob/master/extras/src/main/java/com/google/gson/typeadapters/PostConstructAdapterFactory.java恢复 @JsonAdapter(EmptyStringTypeAdapter.class) - 读取时带注释的字段。示例测试:

private static final Gson gson = new Gson();

private static final Type listOfStringType = new TypeToken<List<String>>() {
}.getType();

public static void main(final String... args) {
    // Single elements
    ImmutableList.of(Pack.of("", ""), Pack.of("foo", ""), Pack.of("", "bar"), Pack.of("foo", "bar"))
            .stream()
            .peek(pack -> System.out.println("Pack before: " + pack))
            .map(gson::toJson)
            .peek(json -> System.out.println("JSON: " + json))
            .map(json -> gson.fromJson(json, Pack.class))
            .peek(pack -> System.out.println("Pack after: " + pack))
            .forEach(pack -> System.out.println());
    // Multiple elements
    final List<String> stringsBefore = ImmutableList.of("", "foo", "bar");
    System.out.println(stringsBefore);
    final String stringsJson = gson.toJson(stringsBefore, listOfStringType);
    System.out.println(stringsJson);
    final List<String> stringsAfter = gson.fromJson(stringsJson, listOfStringType);
    System.out.println(stringsAfter);
}

输出:

Pack before:
JSON: {}
Pack after: null null -- [!] not "" '"

Pack before: foo
JSON: {"foo":"foo"}
Pack after: foo null -- [!] not foo ""

Pack before: bar
JSON: {"bar":"bar"}
Pack after: null bar -- [!] not "" bar

Pack before: foo bar
JSON: {"foo":"foo","bar":"bar"}
Pack after: foo bar

[, foo, bar]
["","foo","bar"]
[, foo, bar]

但是，我认为编写复杂的(反)序列化策略不是一个好的选择，您可能对重新设计 DTO 和数据(反)序列化感兴趣。此外，"" 是一个值，而 null 不是——我永远不会混合它们，我会修改为什么你的系统是这样设计的方式(它真的看起来像一个空值/空值混合问题)。