Tôi nên thoát chuỗi trong JSON như thế nào?

Khi tạo dữ liệu JSON theo cách thủ công, tôi nên thoát các trường chuỗi như thế nào? Tôi có nên sử dụng một cái gì đó như Apache Commons Lang StringEscapeUtilities.escapeHtml, StringEscapeUtilities.escapeXmlhay tôi nên sử dụng java.net.URLEncoder?

Vấn đề là khi tôi sử dụng SEU.escapeHtml, nó không thoát được dấu ngoặc kép và khi tôi quấn toàn bộ chuỗi trong một cặp 's, một JSON không đúng định dạng sẽ được tạo.

Lý tưởng nhất là tìm một thư viện JSON bằng ngôn ngữ của bạn để bạn có thể cung cấp một số cấu trúc dữ liệu phù hợp và để nó lo lắng về cách thoát khỏi mọi thứ . Nó sẽ giữ cho bạn nhiều vệ sinh hơn. Nếu vì bất kỳ lý do gì bạn không có thư viện bằng ngôn ngữ của mình, bạn không muốn sử dụng thư viện này (tôi sẽ không đề xuất điều này), hoặc bạn đang viết thư viện JSON, hãy đọc tiếp.

Thoát khỏi nó theo RFC. JSON là khá tự do: Các nhân vật duy nhất bạn phải thoát được \, "và các mã điều khiển (bất cứ điều gì ít hơn U + 0020).

Cấu trúc thoát này là đặc trưng cho JSON. Bạn sẽ cần một hàm cụ thể JSON. Tất cả các lối thoát có thể được viết dưới dạng đơn \uXXXXvị XXXXmã UTF-16¹ cho ký tự đó. Có một vài phím tắt, chẳng hạn như \\, cũng hoạt động. (Và chúng dẫn đến một đầu ra nhỏ hơn và rõ ràng hơn.)

Để biết chi tiết đầy đủ, xem RFC .

Lối thoát của SONJSON được xây dựng trên JS, do đó, nó sử dụng \uXXXX, XXXXđơn vị mã UTF-16 ở đâu. Đối với các điểm mã bên ngoài BMP, điều này có nghĩa là mã hóa các cặp thay thế, có thể có một chút lông. (Hoặc, bạn chỉ có thể xuất ký tự trực tiếp, vì mã hóa của JSON là văn bản Unicode và cho phép các ký tự cụ thể này.)

Trích xuất từ Jettison :

 public static String quote(String string) {
         if (string == null || string.length() == 0) {
             return "\"\"";
         }

         char         c = 0;
         int          i;
         int          len = string.length();
         StringBuilder sb = new StringBuilder(len + 4);
         String       t;

         sb.append('"');
         for (i = 0; i < len; i += 1) {
             c = string.charAt(i);
             switch (c) {
             case '\\':
             case '"':
                 sb.append('\\');
                 sb.append(c);
                 break;
             case '/':
 //                if (b == '<') {
                     sb.append('\\');
 //                }
                 sb.append(c);
                 break;
             case '\b':
                 sb.append("\\b");
                 break;
             case '\t':
                 sb.append("\\t");
                 break;
             case '\n':
                 sb.append("\\n");
                 break;
             case '\f':
                 sb.append("\\f");
                 break;
             case '\r':
                sb.append("\\r");
                break;
             default:
                 if (c < ' ') {
                     t = "000" + Integer.toHexString(c);
                     sb.append("\\u" + t.substring(t.length() - 4));
                 } else {
                     sb.append(c);
                 }
             }
         }
         sb.append('"');
         return sb.toString();
     }

Hãy thử điều này org.codehaus.jettison.json.JSONObject.quote("your string").

Tải xuống tại đây: http://mvnreposective.com/artifact/org.codehaus.jettison/jettison

org.json.simple.JSONObject.escape () thoát dấu ngoặc kép, \, /, \ r, \ n, \ b, \ f, \ t và các ký tự điều khiển khác. Nó có thể được sử dụng để thoát mã JavaScript.

import org.json.simple.JSONObject;
String test =  JSONObject.escape("your string");

Apache commons lang hiện hỗ trợ này. Chỉ cần đảm bảo rằng bạn có một phiên bản Apache commons lang đủ gần đây trên đường dẫn lớp của bạn. Bạn sẽ cần phiên bản 3.2+

Ghi chú phát hành cho phiên bản 3.2

LANG-797: Đã thêm esc / unescapeJson vào StringEscapeUtils.

org.json.JSONObject quote(String data) phương pháp làm công việc

import org.json.JSONObject;
String jsonEncodedString = JSONObject.quote(data);

Trích xuất từ ​​tài liệu:

Mã hóa dữ liệu dưới dạng chuỗi JSON. Điều này áp dụng dấu ngoặc kép và bất kỳ nhân vật cần thiết thoát . [...] Null sẽ được hiểu là một chuỗi rỗng

StringEscapeUtils.escapeJavaScript/ StringEscapeUtils.escapeEcmaScriptnên làm thủ thuật quá.

Nếu bạn đang sử dụng jackson fastexml, bạn có thể sử dụng như sau: com.fasterxml.jackson.core.io.JsonStringEncoder.getInstance().quoteAsString(input)

Nếu bạn đang sử dụng codehaus jackson, bạn có thể sử dụng như sau: org.codehaus.jackson.io.JsonStringEncoder.getInstance().quoteAsString(input)

Không chắc ý của bạn là gì khi "tạo json thủ công", nhưng bạn có thể sử dụng cái gì đó như gson ( http://code.google.com.vn/p/google-gson/ ) và điều đó sẽ biến đổi HashMap, Mảng, Chuỗi, v.v. , đến một giá trị JSON. Tôi khuyên bạn nên đi với một khuôn khổ cho việc này.

Tôi đã không dành thời gian để chắc chắn 100%, nhưng nó đã hoạt động cho các đầu vào của tôi đủ để được các trình xác nhận JSON trực tuyến chấp nhận:

org.apache.velocity.tools.generic.EscapeTool.EscapeTool().java("input")

mặc dù nó trông không đẹp hơn org.codehaus.jettison.json.JSONObject.quote("your string")

Tôi chỉ đơn giản là sử dụng các công cụ vận tốc trong dự án của mình - tòa nhà "JSON thủ công" của tôi nằm trong một mẫu vận tốc

Đối với những người đến đây để tìm kiếm một giải pháp dòng lệnh, như tôi, --data-urlencode của cURL hoạt động tốt:

curl -G -v -s --data-urlencode 'query={"type" : "/music/artist"}' 'https://www.googleapis.com/freebase/v1/mqlread'

gửi

GET /freebase/v1/mqlread?query=%7B%22type%22%20%3A%20%22%2Fmusic%2Fartist%22%7D HTTP/1.1

, ví dụ. Dữ liệu JSON lớn hơn có thể được đặt trong một tệp và bạn sẽ sử dụng cú pháp @ để chỉ định một tệp để ẩn trong dữ liệu cần thoát. Ví dụ, nếu

$ cat 1.json 
{
  "type": "/music/artist",
  "name": "The Police",
  "album": []
}

bạn sẽ sử dụng

curl -G -v -s --data-urlencode query@1.json 'https://www.googleapis.com/freebase/v1/mqlread'

Và bây giờ, đây cũng là một hướng dẫn về cách truy vấn Freebase từ dòng lệnh :-)

Sử dụng lớp EscapeUtils trong API commons lang.

EscapeUtils.escapeJavaScript("Your JSON string");

Hãy xem xét lớp JsonWriter của Moshi . Nó có một API tuyệt vời và nó giảm việc sao chép đến mức tối thiểu, mọi thứ đều có thể được truyền trực tiếp đến một tệp, OutputStream, v.v.

OutputStream os = ...;
JsonWriter json = new JsonWriter(Okio.buffer(Okio.sink(os)));
json.beginObject();
json.name("id").value(getId());
json.name("scores");
json.beginArray();
for (Double score : getScores()) {
  json.value(score);
}
json.endArray();
json.endObject();

Nếu bạn muốn có chuỗi trong tay:

Buffer b = new Buffer(); // okio.Buffer
JsonWriter writer = new JsonWriter(b);
//...
String jsonString = b.readUtf8();

Văn bản commons của Apache hiện có StringEscapeUtils.escapeJson (String) .

Nếu bạn cần thoát JSON trong chuỗi JSON, hãy sử dụng org.json.JSONObject.quote ("chuỗi json của bạn cần được thoát") dường như hoạt động tốt

sử dụng cú pháp \ uXXXX có thể giải quyết vấn đề này, google UTF-16 với tên của dấu hiệu, bạn có thể tìm hiểu XXXX, ví dụ: trích dẫn kép utf-16

Các phương pháp ở đây cho thấy việc thực hiện thực tế đều bị lỗi.
Tôi không có mã Java, nhưng chỉ để ghi lại, bạn có thể dễ dàng chuyển đổi mã C # này:

Lịch sự của dự án đơn sắc @ https://github.com/mono/mono/blob/master/mcs/ class / System.Web / System.Web / HttpUtility.cs

public static string JavaScriptStringEncode(string value, bool addDoubleQuotes)
{
    if (string.IsNullOrEmpty(value))
        return addDoubleQuotes ? "\"\"" : string.Empty;

    int len = value.Length;
    bool needEncode = false;
    char c;
    for (int i = 0; i < len; i++)
    {
        c = value[i];

        if (c >= 0 && c <= 31 || c == 34 || c == 39 || c == 60 || c == 62 || c == 92)
        {
            needEncode = true;
            break;
        }
    }

    if (!needEncode)
        return addDoubleQuotes ? "\"" + value + "\"" : value;

    var sb = new System.Text.StringBuilder();
    if (addDoubleQuotes)
        sb.Append('"');

    for (int i = 0; i < len; i++)
    {
        c = value[i];
        if (c >= 0 && c <= 7 || c == 11 || c >= 14 && c <= 31 || c == 39 || c == 60 || c == 62)
            sb.AppendFormat("\\u{0:x4}", (int)c);
        else switch ((int)c)
            {
                case 8:
                    sb.Append("\\b");
                    break;

                case 9:
                    sb.Append("\\t");
                    break;

                case 10:
                    sb.Append("\\n");
                    break;

                case 12:
                    sb.Append("\\f");
                    break;

                case 13:
                    sb.Append("\\r");
                    break;

                case 34:
                    sb.Append("\\\"");
                    break;

                case 92:
                    sb.Append("\\\\");
                    break;

                default:
                    sb.Append(c);
                    break;
            }
    }

    if (addDoubleQuotes)
        sb.Append('"');

    return sb.ToString();
}

Điều này có thể được nén vào

    // https://github.com/mono/mono/blob/master/mcs/class/System.Json/System.Json/JsonValue.cs
public class SimpleJSON
{

    private static  bool NeedEscape(string src, int i)
    {
        char c = src[i];
        return c < 32 || c == '"' || c == '\\'
            // Broken lead surrogate
            || (c >= '\uD800' && c <= '\uDBFF' &&
                (i == src.Length - 1 || src[i + 1] < '\uDC00' || src[i + 1] > '\uDFFF'))
            // Broken tail surrogate
            || (c >= '\uDC00' && c <= '\uDFFF' &&
                (i == 0 || src[i - 1] < '\uD800' || src[i - 1] > '\uDBFF'))
            // To produce valid JavaScript
            || c == '\u2028' || c == '\u2029'
            // Escape "</" for <script> tags
            || (c == '/' && i > 0 && src[i - 1] == '<');
    }



    public static string EscapeString(string src)
    {
        System.Text.StringBuilder sb = new System.Text.StringBuilder();

        int start = 0;
        for (int i = 0; i < src.Length; i++)
            if (NeedEscape(src, i))
            {
                sb.Append(src, start, i - start);
                switch (src[i])
                {
                    case '\b': sb.Append("\\b"); break;
                    case '\f': sb.Append("\\f"); break;
                    case '\n': sb.Append("\\n"); break;
                    case '\r': sb.Append("\\r"); break;
                    case '\t': sb.Append("\\t"); break;
                    case '\"': sb.Append("\\\""); break;
                    case '\\': sb.Append("\\\\"); break;
                    case '/': sb.Append("\\/"); break;
                    default:
                        sb.Append("\\u");
                        sb.Append(((int)src[i]).ToString("x04"));
                        break;
                }
                start = i + 1;
            }
        sb.Append(src, start, src.Length - start);
        return sb.ToString();
    }
}

Tôi nghĩ rằng câu trả lời tốt nhất trong năm 2017 là sử dụng API javax.json. Sử dụng javax.json.JsonBuilderFactory để tạo các đối tượng json của bạn, sau đó viết các đối tượng ra bằng cách sử dụng javax.json.JsonWriterFactory. Kết hợp xây dựng / nhà văn rất tốt đẹp.