Como escapar da string JSON?

97

Existem classes / funções disponíveis para serem usadas para facilitar o escape JSON? Prefiro não ter que escrever o meu próprio.

theringostarrs
fonte
3
JsonConvert.ToString () funcionou para mim.
Martin Lottering

Respostas:

74

eu uso System.Web.HttpUtility.JavaScriptStringEncode

string quoted = HttpUtility.JavaScriptStringEncode(input);
xmedeko
fonte
5
Usei isso para evitar a falta System.Web.Helpers.Json.Encodeno VS2015, mas ele precisa do (input, true)parâmetro para incluir as cotações reais também.
lapo
47

Para aqueles que usam o popular projeto Json.Net da Newtonsoft, a tarefa é trivial:

using Newtonsoft.Json;

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

Este código imprime:

"a \\ b"

Ou seja, o valor da string resultante contém as aspas, bem como a barra invertida com escape.

Dror Harari
fonte
2
Não posso reproduzir este método para desserializar um caminho unc codificado e escapado. Meu caminho "WatchedPath": "\\\\myserver\\output"se torna, o "\"\\\\\\\\myserver\\\\output\""que é bastante inaceitável.
slestak
3
O método acima não é para desserializar - avaliador ele é usado quando você deseja criar um texto JSON manualmente e você tem uma string C # e precisa obter sua representação adequada como um texto.
Dror Harari
@slestak, acho que estou enfrentando o mesmo problema que você estava aqui. Você encontrou uma solução?
GP24 de
@ GP24 IIRC, eu não fiz. Desculpe, não tenho mais informações.
slestak de
Não tem problema, obrigado por responder. Eu fiz isso se te ajudar: yourAnnoyingDoubleEncodedString.Replace ("\\\\", "\\"). Replace ("\\\" "," \ "");
GP24
38

Com base na resposta de Dejan , o que você pode fazer é importar o System.Web.Helpersassembly do .NET Framework e usar a seguinte função:

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

A Substringchamada é necessária, pois Encodeenvolve automaticamente as strings com aspas duplas.

Rok Strniša
fonte
Parece que System.Web.Helpers não está disponível antes de .Net 4.0
SerG
… E nada mais no Visual Studio 2015 também.
lapo de
5
Isso faz parte do ASP.NET Web Pages 2.0. Ele pode ser adicionado usando NuGet. Não faz parte da estrutura.
Murven
30

Sim, basta adicionar a seguinte função à sua classe Utils ou algo assim:

    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();
    }
Clive Paterson
fonte
3
Por que você precisa escapar /?
drzaus
Eu sei que esta é uma resposta antiga e estou feliz em ver que isso foi dado, pois não queria depender de nenhuma biblioteca externa, mas percebi que o caso padrão para um caractere de controle sempre retornará "\\ u000X". Eu acredito que você precisa converter o char primeiro para um int. Considere substituí-lo porstring t = "000" + ((int)c).ToString("X");
Jan Discart
O caso padrão correto deve ser:t = "000" + String.Format("{0:X}",(int) c);
daniático
16

Usei o código a seguir para escapar do valor da string para json. Você precisa adicionar seu '"' à saída do seguinte código:

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();
}
Amit Bhagat
fonte
1
Isso realmente salvou meu dia. Muito obrigado!
casaout
8
Não use este código na produção! Este escape JSON perde caracteres especiais importantes. Consulte: stackoverflow.com/a/33799784
vog
2
Este código não cobre todos os casos especiais. NÃO use na produção.
Envil
2
reinventar a roda e introduzir algum bug em casos especiais não é uma boa resposta
Xilmiki
6

Os métodos oferecidos aqui estão com defeito.
Por que se aventurar tão longe quando você poderia apenas usar System.Web.HttpUtility.JavaScriptEncode?

Se você estiver em um framework inferior, você pode apenas copiar e colar do mono

Cortesia do mono-projeto @ 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();
    }

Isso pode ser compactado em

// 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();
    }
}
Stefan Steiger
fonte
4

Fiz testes de velocidade em algumas dessas respostas para uma string longa e uma string curta. O código de Clive Paterson ganhou por uma boa parte, provavelmente porque os outros estão levando em consideração as opções de serialização. Aqui estão meus resultados:

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

E aqui está o código de teste:

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();
}
inominado 227
fonte
2
String.Format("X", c);

Isso resulta apenas em: X

Em vez disso, tente isto:

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

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

Eu nice one-liner, usei JsonConvert como outros fizeram, mas adicionei substring para remover as aspas adicionadas e barra invertida.

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

Em .Net Core 3+ e .Net 5+:

string escapedJsonString = JsonEncodedText.Encode(jsonString);
Jawad Al Shaikh
fonte
0

Eu escolhi usar System.Web.Script.Serialization.JavaScriptSerializer.

Eu tenho uma pequena classe auxiliar estática definida da seguinte maneira:

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

Para serializar qualquer coisa eu apenas chamo Serialization.ToJSON(itemToSerialize)

Para desserializar eu apenas chamo Serialization.FromJSON<T>(jsonValueOfTypeT)

AnthonyVO
fonte