dotnet core System.Text.Json unescape 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":"\你\好"}但我想要{"Name":"你好"}

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

Answer 1

您需要设置 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);

结果：

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

Answer 2

要更改JsonSerializer的转义行为，您可以通过在JsonSerializer设置Encoder属性将自定义JavascriptEncoder传递给JsonSerializerOptions 。

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

默认行为的设计考虑了安全性，并且JsonSerializer过度转义以进行深度防御。

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

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 3

您可以使用： System.Text.RegularExpressions.Regex.Unescape(string)来取消转义 unicode 字符。 https://docs.microsoft.com/en-us/dotnet/api/system.text.regularexpressions.regex.unescape

从原始问题更新示例：

using System;
using System.Text.Json;

public class Program
{
    public static void Main()
    {
            var a = new A{Name = "你好"};
            var s = JsonSerializer.Serialize(a);
        
            var unescaped = System.Text.RegularExpressions.Regex.Unescape(s);

            Console.WriteLine(s);
            Console.WriteLine(unescaped);
        }
}

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

输出：

{"Name":"\u4F60\u597D"}
{"Name":"你好"}

Answer 4

利用：

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