我应该如何在JSON中转义字符串？

Question

手动创建JSON数据时，我该如何转义字符串字段？我是否应该使用Apache Commons Lang的StringEscapeUtilities.escapeHtml，StringEscapeUtilities.escapeXml之类的东西，还是应该使用java.net.URLEncoder？

问题是，当我使用SEU.escapeHtml时，它不会引用引号，并且当我将整个字符串包装在一对'中时，会生成格式错误的JSON。

Answer 1

理想的情况下，发现在你的语言一个JSON库，你可以喂一些合适的数据结构，并让它担心如何逃脱的事情。它会让你更加安心。如果因为某种原因你没有使用你的语言库，你不想使用它（我不会建议这个1），或者你正在编写一个JSON库，请继续阅读。

根据RFC转义它。 JSON非常自由：只有必须转义的字符是\,"和控制代码（任何小于U + 0020的）。

这种转义结构特定于JSON。你需要一个JSON特定的功能。所有的转义符都可以写为\uXXXX，其中XXXX是该字符的UTF-16编码单元1。有几个捷径，如\\，也可以。 （并且它们导致更小和更清晰的输出。）

有关全部细节，请参阅the RFC。

¹JSON的转义是建立在JS上的，所以它使用\uXXXX，其中XXXX是一个UTF-16编码单元。对于BMP之外的代码点，这意味着编码代理对，这可能会有点多毛。 （或者，您可以直接输出字符，因为JSON的编码为Unicode文本，并且允许这些特定字符。）

Answer 2

不确定您的意思是“手动创建json”，但您可以使用像gson http://code.google.com/p/google-gson/），这会将你的HashMap，数组，字符串等转换为JSON值。我建议为此使用一个框架。

Answer 3

试试这个org.codehaus.jettison.json.JSONObject.quote("your string")。

在这里下载：http://mvnrepository.com/artifact/org.codehaus.jettison/jettison

Answer 4

我没有花时间，使100％肯定，但它的工作对我的投入，足以通过网上JSON验证被接受：

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

虽然它不看任何比org.codehaus.jettison.json.JSONObject.quote("your string")

我简单地使用速度的工具在我的项目已经 - 我的“手动JSON”建设是一个Velocity模板中

Answer 5

org.json.simple.JSONObject.escape（）转义引号，\，/，\ r，\ n，\ b，\ f，\ t和其他控制字符。它可以用来逃避JavaScript代码。

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

Answer 6

提液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(); 
    } 

Answer 7

StringEscapeUtils.escapeJavaScript/StringEscapeUtils.escapeEcmaScript应该做的伎俩。

Answer 8

Apache commons lang现在支持此功能。只要确保你的类路径中有最新版本的Apache commons lang。你需要的版本3.2+

发行说明版本3.2

LANG-797：增加逃生/ unescapeJson到StringEscapeUtils。

Answer 9

对于那些谁来到这里寻找一个命令行的解决方案，像我这样的，卷曲的--data-进行urlencode正常工作：

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

发送

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

，例如。较大的JSON数据可以放在一个文件中，您可以使用@语法来指定一个文件来唾弃来自要转义的数据。例如，如果

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

你会使用

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

而现在，这也是关于如何通过命令行查询的游离碱:-)在

Answer 10

使用EscapeUtils类的教程commons lang API。

EscapeUtils.escapeJavaScript("Your JSON string"); 

Answer 11

考虑Moshi的JsonWriter类。它有一个美好的API，并且减少复制到最低限度，一切都可以很好地传输到一个提交的OutputStream等

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(); 

如果你想在手串：

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

Answer 12

的方法这里显示实际的实现都是错误的。
我没有Java代码，而只是备案，你可以很容易地转换这个C＃-code：

单项目的礼貌@ 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(); 
} 

这可以被压缩成

// 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(); 
    } 
} 

Answer 13

org.json.JSONObjectquote(String data)方法做这项工作

从文档

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

提取物：

编码数据作为JSON字符串。 这适用于引号和任何必要的字符转义。 [...]空将

Answer 14

如果您正在使用fastexml杰克逊解释为空字符串，可以使用以下命令： com.fasterxml.jackson.core.io.JsonStringEncoder.getInstance().quoteAsString(input)

如果使用Codehaus的杰克逊，你可以使用下面的： org.codehaus.jackson.io.JsonStringEncoder.getInstance().quoteAsString(input)

Answer 15

如果您需要逃避JSON JSON字符串内，使用org.json.JSONObject.quote（“需要进行转义你的JSON字符串”），似乎可以用工作以及

Answer 16

的为\ uXXXX语法CA ñ解决这个问题，谷歌UTF-16的名称的标志，你可以找出XXXX，例如：utf-16双引号

Answer 17

我认为在2017年的最佳答案是使用javax.json API。使用javax.json.JsonBuilderFactory创建您的json对象，然后使用javax.json.JsonWriterFactory编写对象。非常好的建设者/作家组合。