dotnet核心System.Text.Json Unscape Unicode字符串

Question

使用JsonSerializer.Serialize(obj);将产生一个转义的字符串，但我想要未转义的版本。例如：

using System;
using System.Text.Json;

public class Program
{
    public static void Main()
    {
            var a = new A{Name = "??"};
            var s = JsonSerializer.Serialize(a);
            Console.WriteLine(s);
        }
}

class A {
    public string Name {get; set;}
}

会产生一个字符串，{"Name":"\u4F60\u597D"}但我想要{"Name":"??"}

我在https://dotnetfiddle.net/w73vnO上创建了一个代码段，请帮助我。

Answer 1

要改变的逃逸行为JsonSerializer，你可以在自定义传递JavascriptEncoder到JsonSerializer通过设置Encoder的财产JsonSerializerOptions。

https://docs.microsoft.com/en-us/dotnet/api/system.text.json.jsonserializeroptions.encoder?view=netcore-3.0#System_Text_Json_JsonSerializerOptions_Encoder

默认行为的设计考虑了安全性和JsonSerializer纵深防御的过度逃避。

如果您正在寻找的只是转义特定非拉丁语言的某些“字母数字”字符，我建议您改为JavascriptEncoder使用Create工厂方法而不是使用UnsafeRelaxedJsonEscaping编码器创建一个。

JsonSerializerOptions options = new JsonSerializerOptions
{
    Encoder = JavaScriptEncoder.Create(UnicodeRanges.BasicLatin, UnicodeRanges.CjkUnifiedIdeographs)
};

var a = new A { Name = "??" };
var s = JsonSerializer.Serialize(a, options);
Console.WriteLine(s);

这样做可以保护某些安全措施，例如，HTML 敏感字符将继续被转义。

我会警告不要 System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping轻率地使用，因为它的转义最少（这就是为什么它的名称中有“不安全”）。如果您正在创建的 JSON 写入磁盘上的 UTF-8 编码文件，或者它的 Web 请求部分将字符集显式设置为 utf-8（并且不会按原样嵌入 HTML 组件中），那么使用它可能是可以的。

请参阅 API 文档中的备注部分：https : //docs.microsoft.com/en-us/dotnet/api/system.text.encodings.web.javascriptencoder.unsaferelaxedjsonescaping? view = netcore-3.0#remarks

您还可以考虑指定UnicodeRanges.All是否希望/需要所有语言都保持未转义。这仍然会转义某些容易出现安全漏洞的 ASCII 字符。

JsonSerializerOptions options = new JsonSerializerOptions
{
    Encoder = JavaScriptEncoder.Create(UnicodeRanges.All)
};

有关详细信息和代码示例，请参阅：https : //docs.microsoft.com/en-us/dotnet/standard/serialization/system-text-json-how-to?view=netcore-3.0#customize-character-encoding

请参阅注意事项

Answer 2

使用：

JsonSerializerOptions options = new JsonSerializerOptions
{
    Encoder = JavaScriptEncoder.Create(UnicodeRanges.All)
};

Answer 3

您可以使用：System.Text.RegularExpressions.Regex.Unescape(string)对 unicode 字符进行转义。\n https://learn.microsoft.com/en-us/dotnet/api/system.text.regularexpressions.regex.unescape

\n

更新原始问题的示例：

\n

using System;\nusing System.Text.Json;\n\npublic class Program\n{\n    public static void Main()\n    {\n            var a = new A{Name = "\xe4\xbd\xa0\xe5\xa5\xbd"};\n            var s = JsonSerializer.Serialize(a);\n        \n            var unescaped = System.Text.RegularExpressions.Regex.Unescape(s);\n\n            Console.WriteLine(s);\n            Console.WriteLine(unescaped);\n        }\n}\n\nclass A {\n    public string Name {get; set;}\n}\n

\n

输出：

\n

{"Name":"\\u4F60\\u597D"}\n{"Name":"\xe4\xbd\xa0\xe5\xa5\xbd"}\n

\n

Answer 4

您需要设置JsonSerializer选项，以不对那些字符串进行编码。

JsonSerializerOptions jso = new JsonSerializerOptions();
jso.Encoder = System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping;

然后，在调用Serialize方法时传递此选项。

var s = JsonSerializer.Serialize(a, jso);        

完整代码：

JsonSerializerOptions jso = new JsonSerializerOptions();
jso.Encoder = System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping;

var a = new A { Name = "??" };
var s = JsonSerializer.Serialize(a, jso);        
Console.WriteLine(s);

结果：

如果需要在控制台中打印结果，则可能需要安装其他语言。请参考这里。