如何让 gson 避免在 json 响应中转义 json？

Question

我有一个这样的响应对象：

public class TestResponse {

    private final String response;
    private final ErrorCodeEnum error;
    private final StatusCodeEnum status;

    // .. constructors and getters here
}

我正在使用 Gson 库对上面的类进行序列化，如下所示：

Gson gson = new GsonBuilder().setPrettyPrinting().serializeNulls().create();
System.out.println(gson.toJson(testResponseOutput));

我得到的回复如下所示：

{
  "response": "{\"hello\":0,\"world\":\"0\"}",
  "error": "OK",
  "status": "SUCCESS"
}

如您所见，"response" 字段中的我的 json 字符串正在转义。有什么办法可以让 gson 不要这样做，而是返回一个完整的响应，如下所示：

{
  "response": {"hello":0,"world":"0"},
  "error": "OK",
  "status": "SUCCESS"
}

还有——如果我按照上面的方式做会有什么问题吗？

注意：我的 "response" 字符串将始终是 JSON 字符串，否则它将为空，因此我的 "response" 字符串中只有这两个值。在"response" 字段中，我可以有任何json 字符串，因为这个库正在调用一个可以返回任何json 字符串的rest 服务，所以我将它存储在一个字符串"response" 字段中。

Answer 1

如果您的 response 字段可以是任意 JSON，那么您需要：

1. 将其定义为任意 JSON 字段（利用 GS​​ON 中已内置的 JSON 类型系统，将其定义为 JSON 层次结构的根 - JsonElement）

   public class TestResponse {
       private final JsonElement response;
   }
   

2. 将 String 字段转换为适当的 JSON 对象表示。为此，您可以使用 GSON 的 JsonParser 类：

   final JsonParser parser = new JsonParser();
   
   String responseJson = "{\"hello\":0,\"world\":\"0\"}";
   JsonElement json = parser.parse(responseJson); // Omits error checking, what if responseJson is invalid JSON?
   System.out.println(gson.toJson(new TestResponse(json)));
   

这应该打印出来：

{
  "response": {
    "hello": 0,
    "world": "0"
  }
}

它也应该适用于任何有效的 JSON：

String responseJson = "{\"arbitrary\":\"fields\",\"can-be\":{\"in\":[\"here\",\"!\"]}}";
JsonElement json = parser.parse(responseJson);
System.out.println(gson.toJson(new TestResponse(json)));

输出：

{
  "response": {
    "arbitrary": "fields",
    "can-be": {
      "in": [
        "here",
        "!"
      ]
    }
  }
}

Answer 2

我知道这是旧的，但只是添加一个潜在的答案以备不时之需。

听起来您只想返回响应而不转义。转义是个好东西，它有助于防止安全问题，防止你的 JS 应用程序因错误而崩溃。

但是，如果您仍然想忽略转义，请尝试：

Gson gson = new GsonBuilder().setPrettyPrinting().disableHtmlEscaping().serializeNulls().create();

Answer 3

添加简单的 TypeAdapter 并使用 jsonValue(value) gson 2.8.0

版本 1：

  @Test
public void correctlyShow() {
    TestResponse2 src = new TestResponse2("{\"arbitrary\":\"fields\",\"can-be\":{\"in\":[\"here\",\"!\"]}}");
    Gson create = new GsonBuilder().registerTypeAdapter(String.class, ADAPTER).create();

    Stopwatch createStarted = Stopwatch.createStarted();
    String json2 = create.toJson(src);
    System.out.println(json2 + " correctlyShow4 " + createStarted.stop());
}

public class TestResponse2 {
    private final String response;

    public TestResponse2(String response) {
        this.response = response;
    }

    public String getResponse() {
        return response;
    }
}

private static final TypeAdapter<String> ADAPTER = new TypeAdapter<String>() {
    @Override
    public String read(JsonReader in) throws IOException {
        throw new UnsupportedOperationException("Unsupported Operation !!!");
    }

    @Override
    public void write(JsonWriter out, String value) throws IOException {
        out.jsonValue(value);
    }
};

...

版本 2

@Test
public void correctlyShow() {
    TestResponse2 src = new TestResponse2("{\"arbitrary\":\"fields\",\"can-be\":{\"in\":[\"here\",\"!\"]}}");

    String json2 = new Gson().toJson(src);
    System.out.println(json2 + " correctlyShow4 ");
}

public class TestResponse2 {
    @JsonAdapter(value = AdapterStringJson.class)
    private final String response;

    public TestResponse2(String response) {
        this.response = response;
    }

    public String getResponse() {
        return response;
    }
}

private class AdapterStringJson extends TypeAdapter<String> {
    @Override
    public String read(JsonReader in) throws IOException {
        throw new UnsupportedOperationException("Unsupported Operation !!!");
    }

    @Override
    public void write(JsonWriter out, String value) throws IOException {
        out.jsonValue(value);
    }
}

Answer 4

你应该有一个嵌套对象。

public class Response {
    private final Integer hello;
    private final String world;
}

public class TestResponse {
    private final Response response;
    private final ErrorCodeEnum error;
    private final StatusCodeEnum status;

    // .. constructors and getters here
}

Answer 5

根据您的需要，您可以使用地图（或类似的）或嵌套对象来代替字符串。以这种方式表示它应该没有问题，但在您的示例中，如果它是一个字符串，如果您没有转义诸如双引号之类的字符，则会出现问题。