🌟 解决JSON乱码问题：一个实用的.NET工具类
在开发过程中，我们经常会遇到JSON数据处理的问题，尤其是在数据传输和解析过程中，很容易出现编码错误导致的乱码问题。这种情况通常发生在原始数据以UTF-8编码，却被错误地用GBK等其他编码解码时。为了解决这个问题，我开发了一个名为JsonEncodingFixer的.NET工具类，它可以有效地修复因编码错误导致的JSON乱码问题。
问题背景
在实际开发中，JSON数据的编码和解码是一个常见的环节。然而，当数据在不同系统之间传输时，可能会因为编码不一致而出现乱码。例如：
- 原始数据以UTF-8编码存储。
- 在传输或解析过程中，数据被错误地用GBK编码解码。
- 最终导致JSON字符串中出现乱码。
这种问题不仅影响数据的可读性，还可能导致后续处理失败。因此，我们需要一个工具来修复这种编码错误。
核心原理
JsonEncodingFixer的核心原理是通过以下步骤修复乱码：
- 逆向工程：将错误解码的字符串重新编码为原始的错误字节。
- 正确解码：使用正确的编码（如UTF-8）重新解析这些字节。
具体来说，我们先将乱码字符串用GBK编码转换为字节数组，然后用UTF-8编码重新解析这些字节，从而恢复原始的正确字符串。
工具类实现
以下是JsonEncodingFixer工具类的完整代码实现，包含详细的注释和说明：
csharp
using System;
using System.IO;
using System.Text;
using System.Text.Encodings.Web;
using System.Text.Json;
namespace HalconCenter
{
/// <summary>
/// JSON编码修复工具类
/// 🌟 适用场景：修复因编码错误导致的JSON乱码问题，典型场景是：
/// 1. 原始数据使用UTF-8编码
/// 2. 被错误地用GBK等非UTF-8编码解码
/// 3. 导致JSON字符串出现乱码
/// </summary>
public class JsonEncodingFixer
{
/// <summary>
/// 修复单个错误编码的字符串
/// 🌟 核心原理：错误解码 -> 还原原始错误字节 -> 正确编码重新解码
/// </summary>
/// <param name="garbledText">乱码字符串（UTF-8字节被误用GBK解码的结果）</param>
/// <returns>修复后的正确字符串</returns>
public static string FixEncoding(string garbledText)
{
try
{
// 🌟 注册扩展编码支持（.NET Core默认不包含GBK等编码）
Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
// 🌟 逆向工程：将错误解码的字符串重新编码为原始错误字节
// 等效于：错误解码的逆过程，获取原始传输时的错误字节
byte[] wrongBytes = Encoding.GetEncoding("GBK").GetBytes(garbledText);
// 🌟 正确解码：用本应有的UTF-8编码重新解析原始字节
return Encoding.UTF8.GetString(wrongBytes);
}
catch (Exception ex)
{
// 🌟 异常处理原则：保证业务连续性，宁可返回乱码也不阻断流程
Console.WriteLine($"编码转换失败: {ex.Message}");
return garbledText;
}
}
/// <summary>
/// 自动修复整个JSON对象
/// 🌟 实现策略：
/// 1. 解析原始JSON结构
/// 2. 深度遍历所有节点
/// 3. 修复每个字符串节点的编码
/// 4. 重建JSON结构保持格式
/// </summary>
/// <param name="json">需要修复的JSON字符串</param>
/// <returns>修复编码后的JSON字符串</returns>
public static string FixJsonEncoding(string json)
{
// 🌈 使用JsonDocument解析而非反序列化，避免类型转换干扰
using (JsonDocument doc = JsonDocument.Parse(json))
using (var ms = new MemoryStream())
{
// 🌟 关键配置：设置宽松的JSON编码规则（防止二次转义）
var options = new JsonWriterOptions
{
Indented = true, // 保持美观格式
Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping // 允许中文等特殊字符
};
// 🚀 使用Utf8JsonWriter重新构建JSON
using (var writer = new Utf8JsonWriter(ms, options))
{
WriteFixedValue(doc.RootElement, writer);
}
return Encoding.UTF8.GetString(ms.ToArray());
}
}
/// <summary>
/// 递归写入修复后的JSON值
/// 🌟 遍历策略：
/// 1. 对象：修复每个属性名和属性值
/// 2. 数组：修复每个元素
/// 3. 字符串：应用FixEncoding修复
/// 4. 其他类型：保持原始值
/// </summary>
/// <param name="element">当前JSON元素</param>
/// <param name="writer">JSON写入器</param>
private static void WriteFixedValue(JsonElement element, Utf8JsonWriter writer)
{
switch (element.ValueKind)
{
case JsonValueKind.Object:
writer.WriteStartObject();
foreach (System.Text.Json.JsonProperty prop in element.EnumerateObject())
{
// 🔄 双重修复：属性名和属性值都需要处理
var fixedName = FixEncoding(prop.Name);
writer.WritePropertyName(fixedName);
WriteFixedValue(prop.Value, writer);
}
writer.WriteEndObject();
break;
case JsonValueKind.Array:
writer.WriteStartArray();
foreach (JsonElement item in element.EnumerateArray())
{
// 🔄 递归处理数组元素
WriteFixedValue(item, writer);
}
writer.WriteEndArray();
break;
case JsonValueKind.String:
// 🎯 核心修复点：字符串值修复
writer.WriteStringValue(FixEncoding(element.GetString()));
break;
default:
// ⚙️ 非字符串类型直接写入（数字/布尔值/null等）
element.WriteTo(writer);
break;
}
}
}
}代码说明
-
FixEncoding方法：- 这是核心修复方法，用于修复单个乱码字符串。
- 它通过将错误解码的字符串重新编码为字节数组，然后用正确的编码重新解析，从而恢复原始字符串。
-
FixJsonEncoding方法：- 这个方法用于修复整个JSON对象。
- 它使用
JsonDocument解析JSON，然后深度遍历所有节点，修复每个字符串值。 - 最后，它通过
Utf8JsonWriter重建JSON结构，保持格式不变。
-
WriteFixedValue方法：- 这是一个递归方法，用于深度遍历JSON对象或数组。
- 它会修复每个字符串值，并正确处理其他类型的节点（如数字、布尔值、null等）。
使用示例
以下是一个简单的使用示例：
csharp
using System;
namespace ExampleUsage
{
class Program
{
static void Main(string[] args)
{
string garbledText = "æ---¥æœ¬è¯"; // 示例乱码文本
string yourCorruptedJson = "{\"name\":\"æ---¥æœ¬è¯\",\"age\":30}";
// 修复单个字符串
string fixedString = JsonEncodingFixer.FixEncoding(garbledText);
Console.WriteLine($"修复后的字符串: {fixedString}");
// 修复整个JSON对象
string fixedJson = JsonEncodingFixer.FixJsonEncoding(yourCorruptedJson);
Console.WriteLine($"修复后的JSON: {fixedJson}");
}
}
}输出结果将是修复后的正确JSON字符串。
总结
JsonEncodingFixer是一个简单而强大的工具类，可以帮助我们快速修复JSON乱码问题。它适用于各种因编码错误导致的乱码场景，能够显著提高开发效率。如果你在项目中遇到类似的乱码问题，不妨尝试使用这个工具类。