1.概述

在這個簡短的教程中，我們將展示一些在 Java 中轉義 JSON 字符串的方法。

我們將快速瀏覽最流行的 JSON 處理庫以及它們如何使轉義成為一項簡單的任務。

2.會出什么問題?

讓我們考慮一個簡單但常見的用例，將用戶指定的消息發送到 Web 服務。天真地，我們可以嘗試：

String payload = "{\"message\":\"" + message + "\"}";
sendMessage(payload);

但是，實際上，這會帶來很多問題。

最簡單的是如果消息包含引號：

{ "message" : "My "message" breaks json" }

更糟糕的是用戶可以故意破壞請求的語義。如果他發送：

Hello", "role" : "admin

 然后消息變為：

{ "message" : "Hello", "role" : "admin" }

最簡單的方法是用適當的轉義序列替換引號：

String payload = "{\"message\":\"" + message.replace("\"", "\\\"") + "\"}";

但是，這種方法非常脆弱：

需要對每個連接的值執行此操作，并且我們需要始終牢記我們已經轉義了哪些字符串

此外，隨著消息結構隨時間變化，這可能會成為維護難題

而且很難閱讀，更容易出錯

簡而言之，我們需要采用更通用的方法。不幸的是，原生 JSON 處理功能仍處于JEP 階段，因此我們不得不將目光轉向各種開源 JSON 庫。

3. JSON-java 庫

我們評論中最簡單和最小的庫是JSON-java，也稱為org.json。

要構造一個 JSON 對象，我們只需創建一個JSONObject 的實例，并且基本上將它視為一個Map：

JSONObject jsonObject = new JSONObject();
jsonObject.put("message", "Hello \"World\"");
String payload = jsonObject.toString();

這將采用“世界”周圍的引號并轉義它們：

{
   "message" : "Hello \"World\""
}

4.Jackson

用于 JSON 處理的最流行和通用的 Java 庫之一是Jackson。

乍一看，Jackson 的行為與 org.json類似：

Map<String, Object> params = new HashMap<>();
params.put("message", "Hello \"World\"");
String payload = new ObjectMapper().writeValueAsString(params);

但是，Jackson 也可以支持序列化 Java 對象。

因此，讓我們通過將消息包裝在自定義類中來稍微增強我們的示例：

class Payload {
    Payload(String message) {
        this.message = message;
    }
    String message;    
    // getters and setters
}

然后，我們需要一個 ObjectMapper的實例，我們可以將對象的實例傳遞給它：

String payload = new ObjectMapper().writeValueAsString(new Payload("Hello \"World\""));

在這兩種情況下，我們都會得到與之前相同的結果：

{
   "message" : "Hello \"World\""
}

如果我們有一個已經轉義的屬性并且需要在不進一步轉義的情況下對其進行序列化，我們可能希望在該字段上使用 Jackson 的@JsonRawValue注釋。

5.Gson

Gson 是 Google 的一個庫，經常與 Jackson 正面交鋒。

當然，我們可以再次像使用org.json 那樣做：

JsonObject json = new JsonObject();
json.addProperty("message", "Hello \"World\"");
String payload = new Gson().toJson(gsonObject);

或者我們可以使用自定義對象，例如 Jackson：

String payload = new Gson().toJson(new Payload("Hello \"World\""));

我們將再次得到相同的結果。