如何在 Gson 序列化中保持字段顺序

Question

似乎Gson.toJson(Object object) 生成带有随机分布的对象字段的 JSON 代码。有没有办法以某种方式修复字段顺序？

public class Foo {
    public String bar;
    public String baz;
    public Foo( String bar, String baz ) {
        this.bar = bar;
        this.baz = baz;
    }
}
Gson gson = new Gson();
String jsonRequest = gson.toJson(new Foo("bar","baz"));

字符串jsonRequest可以是：

• { "bar":"bar", "baz":"baz" }（正确）
• { "baz":"baz", "bar":"bar" }（顺序错误）

Answer 1

您需要创建一个自定义 JSON 序列化程序。

例如

public class FooJsonSerializer implements JsonSerializer<Foo> {

    @Override
    public JsonElement serialize(Foo foo, Type type, JsonSerializationContext context) {
        JsonObject object = new JsonObject();
        object.add("bar", context.serialize(foo.getBar());
        object.add("baz", context.serialize(foo.getBaz());
        // ...
        return object;
    }

}

并按如下方式使用：

Gson gson = new GsonBuilder().registerTypeAdapter(Foo.class, new FooJsonSerializer()).create();
String json = gson.toJson(foo);
// ...

这将保持您在序列化程序中指定的顺序。

另见：

• Gson User Guide - Custom serializers and deserializers

Answer 2

如果 GSON 不支持定义字段顺序，则有其他库支持。例如，Jackson 允许使用 @JsonPropertyOrder 定义它。对我来说，必须指定自己的自定义序列化程序似乎需要做很多工作。

是的，我同意根据 JSON 规范，应用程序不应期望特定的字段顺序。

Answer 3

实际上 Gson.toJson(Object object) 不会以随机顺序生成字段。结果 json 的顺序取决于字段名称的文字顺序。

我遇到了同样的问题，它是通过类中属性名称的字面顺序来解决的。

问题中的示例将始终返回以下 jsonRequest：

{ "bar":"bar", "baz":"baz" }

为了有一个特定的顺序，你应该修改字段的名称，例如：如果你想让baz 排在第一位，那么bar：

public class Foo {
    public String f1_baz;
    public String f2_bar;

    public Foo ( String f1_baz, String f2_bar ) {
        this.f1_baz = f1_baz;
        this.f2_bar = f2_bar;
    }
}

jsonRequest 将是{ "f1_baz ":"baz", "f2_bar":"bar" }

Answer 4

这是我在给定目录中循环遍历 json 文本文件并使用排序版本覆盖它们顶部的解决方案：

private void standardizeFormat(File dir) throws IOException {
    File[] directoryListing = dir.listFiles();
    if (directoryListing != null) {
        for (File child : directoryListing) {
            String path = child.getPath();
            JsonReader jsonReader = new JsonReader(new FileReader(path));

            Gson gson = new GsonBuilder().setPrettyPrinting().registerTypeAdapter(LinkedTreeMap.class, new SortedJsonSerializer()).create();
            Object data = gson.fromJson(jsonReader, Object.class);
            JsonWriter jsonWriter = new JsonWriter(new FileWriter(path));
            jsonWriter.setIndent("  ");
            gson.toJson(data, Object.class, jsonWriter);
            jsonWriter.close();
        }
    }
}

private class SortedJsonSerializer implements JsonSerializer<LinkedTreeMap> {
    @Override
    public JsonElement serialize(LinkedTreeMap foo, Type type, JsonSerializationContext context) {
        JsonObject object = new JsonObject();
        TreeSet sorted = Sets.newTreeSet(foo.keySet());
        for (Object key : sorted) {
            object.add((String) key, context.serialize(foo.get(key)));
        }
        return object;
    }
}

这很 hacky，因为它取决于 Gson 在 Type 只是 Object 时使用 LinkedTreeMap 的事实。这是一个可能无法保证的实现细节。无论如何，这对于我短暂的目的来说已经足够了......