使用GSON，当某些键具有特殊字符时如何将JSON转换为Java

Question

外部API为我提供了一个JSON对象，如下所示：

{
    "@date": "1407436242",
    "@duration": "2411",
    "Entry": {
        "@position": "3",
        "@playerName": "fred"
    }
}

如您所见，除一个嵌套对象之外，所有键都以@符号开头。 我们正在使用GSON解析JSON，并且我试图尽可能简单地做到这一点，而无需手动将每个键转换为有效的Java字段名称。

我目前正在尝试使用以下代码：

MyObject response = gson.fromJson(stringInput, MyObject.class);

该字段与TournamentEntry之外的任何字段均不匹配。

我尝试添加gson字段命名策略，但这似乎是一种全有或全无的方法，并且无法处理某些键带有“ @”符号，而有些则没有。

如何在转换为Java字段名称时告诉GSON删除“ @”符号，同时仍处理没有@符号的嵌套对象？

Answer 1

Gson提供了SerializedName批注，该批注应允许使用那些时髦的json标识符。 这会使您的类看起来像这样：

package com.example;

import com.google.gson.annotations.SerializedName;
import java.util.Date;

public class Event {

  @SerializedName("@date")
  private Date date;

  @SerializedName("@duration")
  private long duration;

  @SerializedName("Entry")
  private Entry entry;

}

和

package com.example;

import com.google.gson.annotations.SerializedName;

public class Entry {

  @SerializedName("@position")
  private int position;

  @SerializedName("@playerName")
  private String playerName;  

}

@SerializedName的伟大之处在于它基于每个字段工作，因此您只需要在需要时进行注释即可。

Answer 2

你可以尝试解析您的JSON成JsonElement首先使用GSON的JsonParser ，然后预处理是删除一个以@开始，以实际的密钥更换任何按键。 之后，您可以使用修改后的JsonElement而不是JSON String调用gson.fromJson 。

以下是如何执行此操作的示例。 它检查元素是否为JSON对象，如果是，则替换所有以@开头的键。 然后，所有值都通过相同的方法递归放置（以便在示例中也替换例如@position）。

public static void main(String... args) {
    String json = "{\n"
            + "    \"@date\": \"1407436242\",\n"
            + "    \"@duration\": \"2411\",\n"
            + "    \"Entry\": {\n"
            + "        \"@position\": \"3\",\n"
            + "        \"@playerName\": \"fred\"\n"
            + "    }\n"
            + "}";

    JsonParser jsonParser = new JsonParser();
    JsonElement jsonElement = jsonParser.parse(json);

    // Modify the JsonElement, replacing any keys beginning with @
    removeAtSymbolsInKeys(jsonElement);

    MyObject myObject = new Gson().fromJson(jsonElement, MyObject.class);
    System.out.println(myObject);
}

private static void removeAtSymbolsInKeys(JsonElement jsonElement) {
    if (jsonElement.isJsonObject()) {
        JsonObject jsonObject = jsonElement.getAsJsonObject();
        Set<Entry<String, JsonElement>> entrySet = new HashSet<>(jsonObject.entrySet()); // Make a copy so we can modify JsonObject

        for (Entry<String, JsonElement> entry : entrySet) {
            String key = entry.getKey();
            JsonElement value = entry.getValue();

            if (key.startsWith("@")) {
                String newKey = key.replaceFirst("@", "");
                jsonObject.add(newKey, value);
                jsonObject.remove(key);
            }

            // Replace the keys of any values that are objects
            removeAtSymbolsInKeys(value);
        }
    }
}

请记住，如果您的JSON极其嵌套，则递归方法将引发StackOverflowError，但希望永远不会这样。