JSON文字列をエスケープする方法は?


97

JSONを簡単にエスケープするために使用できるクラス/関数はありますか?自分で書く必要はありません。


3
JsonConvert.ToString()がうまくいきました。
Martin Lottering 2017年

回答:



47

Newtonsoftの非常に人気のあるJson.Netプロジェクトを使用している人にとって、タスクは簡単です:

using Newtonsoft.Json;

....
var s = JsonConvert.ToString(@"a\b");
Console.WriteLine(s);
....

このコードは出力します:

「a \\ b」

つまり、結果の文字列値には、引用符とエスケープされた円記号が含まれます。


2
エンコードおよびエスケープされたuncパスをデシリアライズするためのこの方法を再現できません。私のパスは"WatchedPath": "\\\\myserver\\output"なり"\"\\\\\\\\myserver\\\\output\""かなり容認できないとします。
slestak 2014

3
上記のメソッドはデシリアライズ用ではありません。JSONテキストを手動で作成したい場合に使用され、C#文字列があり、適切な表現をテキストとして取得する必要があります。
Dror Harari 2014

@slestak、私はあなたがここにいたのと同じ問題に直面していると思います。解決策は見つかりましたか?
GP24、2016

@ GP24 IIRC、私はしませんでした。申し訳ありませんが、これ以上の情報はありません。
slestak 2016

問題ありません。返信いただきありがとうございます。それがあなたを助けるなら私はこれをしました:yourAnnoyingDoubleEncodedString.Replace( "\\\\"、 "\\")。Replace( "\\\" "、" \ "");
GP24 2016

38

Dejanの答えに基づいて.NET FrameworkアセンブリをインポートしSystem.Web.Helpers、次の関数を使用することができます。

static string EscapeForJson(string s) {
  string quoted = System.Web.Helpers.Json.Encode(s);
  return quoted.Substring(1, quoted.Length - 2);
}

Substring以来呼び出しは、必要とされEncode、自動的に二重引用符で文字列を囲んでいます。


System.Web.Helpersは.Net 4.0以前では利用できないようです
SerG

…そしてVisual Studio 2015でもこれ以上はありません。
ラポ

5
これはASP.NET Webページ2.0の一部です。NuGetを使用して追加できます。フレームワークの一部ではありません。
Murven、2016

30

はい、次の関数をUtilsクラスなどに追加します。

    public static string cleanForJSON(string s)
    {
        if (s == null || s.Length == 0) {
            return "";
        }

        char         c = '\0';
        int          i;
        int          len = s.Length;
        StringBuilder sb = new StringBuilder(len + 4);
        String       t;

        for (i = 0; i < len; i += 1) {
            c = s[i];
            switch (c) {
                case '\\':
                case '"':
                    sb.Append('\\');
                    sb.Append(c);
                    break;
                case '/':
                    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" + String.Format("X", c);
                        sb.Append("\\u" + t.Substring(t.Length - 4));
                    } else {
                        sb.Append(c);
                    }
                    break;
            }
        }
        return sb.ToString();
    }

3
なぜ脱出する必要があるの/ですか?
drzaus

私はこれが古い答えであることを知っています。外部ライブラリに依存したくなかったので、これが表示されたことを嬉しく思いますが、制御文字のデフォルトのケースでは常に「\\ u000X」が返されることに気付きました。最初にcharをintにキャストする必要があると思います。交換することを検討してくださいstring t = "000" + ((int)c).ToString("X");
Jan Discart 2018

正しいデフォルトのケースでなければなりません:t = "000" + String.Format("{0:X}",(int) c);
daniatic

16

次のコードを使用して、jsonの文字列値をエスケープしました。次のコードの出力に「」を追加する必要があります。

public static string EscapeStringValue(string value)
{
    const char BACK_SLASH = '\\';
    const char SLASH = '/';
    const char DBL_QUOTE = '"';

    var output = new StringBuilder(value.Length);
    foreach (char c in value)
    {
        switch (c)
        {
            case SLASH:
                output.AppendFormat("{0}{1}", BACK_SLASH, SLASH);
                break;

            case BACK_SLASH:
                output.AppendFormat("{0}{0}", BACK_SLASH);
                break;

            case DBL_QUOTE:
                output.AppendFormat("{0}{1}",BACK_SLASH,DBL_QUOTE);
                break;

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

    return output.ToString();
}

1
これは本当に私の日を救った。どうもありがとう!
casaout 2013年

8
このコードを本番環境で使用しないでください!このJSONエスケープでは、重要な特殊文字が欠落しています。参照:stackoverflow.com/a/33799784
vog 2015年

2
このコードは、すべての特殊なケースをカバーしているわけではありません。本番環境では使用しないでください。
邪悪な

2
ホイールを再発明し、特別な場合にいくつかのバグを導入することは良い答えではありません
Xilmiki '19年

6

ここで提供される方法は不完全です。
なぜSystem.Web.HttpUtility.JavaScriptEncodeを使用できるのに、ここまで冒険するのですか?

下のフレームワークを使用している場合は、モノからコピーして貼り付けることができます

mono-projectの礼儀@ 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();
    }
}


4

長い文字列と短い文字列について、これらの回答のいくつかに対して速度テストを実行しました。おそらく他のユーザーがシリアル化オプションを考慮しているため、Clive Patersonのコードは少し勝ちました。これが私の結果です:

Apple Banana
System.Web.HttpUtility.JavaScriptStringEncode: 140ms
System.Web.Helpers.Json.Encode: 326ms
Newtonsoft.Json.JsonConvert.ToString: 230ms
Clive Paterson: 108ms

\\some\long\path\with\lots\of\things\to\escape\some\long\path\t\with\lots\of\n\things\to\escape\some\long\path\with\lots\of\"things\to\escape\some\long\path\with\lots"\of\things\to\escape
System.Web.HttpUtility.JavaScriptStringEncode: 2849ms
System.Web.Helpers.Json.Encode: 3300ms
Newtonsoft.Json.JsonConvert.ToString: 2827ms
Clive Paterson: 1173ms

そしてここにテストコードがあります:

public static void Main(string[] args)
{
    var testStr1 = "Apple Banana";
    var testStr2 = @"\\some\long\path\with\lots\of\things\to\escape\some\long\path\t\with\lots\of\n\things\to\escape\some\long\path\with\lots\of\""things\to\escape\some\long\path\with\lots""\of\things\to\escape";

    foreach (var testStr in new[] { testStr1, testStr2 })
    {
        var results = new Dictionary<string,List<long>>();

        for (var n = 0; n < 10; n++)
        {
            var count = 1000 * 1000;

            var sw = Stopwatch.StartNew();
            for (var i = 0; i < count; i++)
            {
                var s = System.Web.HttpUtility.JavaScriptStringEncode(testStr);
            }
            var t = sw.ElapsedMilliseconds;
            results.GetOrCreate("System.Web.HttpUtility.JavaScriptStringEncode").Add(t);

            sw = Stopwatch.StartNew();
            for (var i = 0; i < count; i++)
            {
                var s = System.Web.Helpers.Json.Encode(testStr);
            }
            t = sw.ElapsedMilliseconds;
            results.GetOrCreate("System.Web.Helpers.Json.Encode").Add(t);

            sw = Stopwatch.StartNew();
            for (var i = 0; i < count; i++)
            {
                var s = Newtonsoft.Json.JsonConvert.ToString(testStr);
            }
            t = sw.ElapsedMilliseconds;
            results.GetOrCreate("Newtonsoft.Json.JsonConvert.ToString").Add(t);

            sw = Stopwatch.StartNew();
            for (var i = 0; i < count; i++)
            {
                var s = cleanForJSON(testStr);
            }
            t = sw.ElapsedMilliseconds;
            results.GetOrCreate("Clive Paterson").Add(t);
        }

        Console.WriteLine(testStr);
        foreach (var result in results)
        {
            Console.WriteLine(result.Key + ": " + Math.Round(result.Value.Skip(1).Average()) + "ms");
        }
        Console.WriteLine();
    }

    Console.ReadLine();
}


2
String.Format("X", c);

それだけを出力します:X

代わりにこれを試してください:

string t = ((int)c).ToString("X");

sb.Append("\\u" + t.PadLeft(4, '0'));

2

他の人と同じようにJsonConvertを使用しましたが、追加された引用符とバックスラッシュを削除するために部分文字列を追加しました。

 var escapedJsonString = JsonConvert.ToString(JsonString).Substring(1, JsonString.Length - 2);



0

使用することにしましたSystem.Web.Script.Serialization.JavaScriptSerializer

次のように定義された小さな静的ヘルパークラスがあります。

internal static partial class Serialization
{
    static JavaScriptSerializer serializer;
    
    static Serialization()
    {
        serializer = new JavaScriptSerializer();
        serializer.MaxJsonLength = Int32.MaxValue;
    }
    public static string ToJSON<T>(T obj)
    {
        return serializer.Serialize(obj);
    }
    public static T FromJSON<T>(string data)
    {
        if (Common.IsEmpty(data))
            return default(T);
        else
            return serializer.Deserialize<T>(data);
    }
}

何でもシリアライズするために、 Serialization.ToJSON(itemToSerialize)

逆シリアル化するには、私はただ呼び出す Serialization.FromJSON<T>(jsonValueOfTypeT)

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.