基于.NET编写工具类解决JSON乱码问题

2025-03-05 17:50

本文主要是介绍基于.NET编写工具类解决JSON乱码问题,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《基于.NET编写工具类解决JSON乱码问题》在开发过程中,我们经常会遇到JSON数据处理的问题,尤其是在数据传输和解析过程中,很容易出现编码错误导致的乱码问题,下面我们就来编写一个.NET工具类来解...

在开发过程中,我们经常会遇到jsON数据处理的问题,尤其是在数据传输和解析过程中,很容易出现编码错误导致的乱码问题。这种情况通常发生在原始数据以UTF-8编码,却被错误地用GBK等其他编码解码时。为了解决这个问题,我开发了一个名为JsonEncodingFixer的.NET工具类,它可以有效地修复因编码错误导致的JSON乱码问题。

问题背景

在实际开发中,JSON数据的编码和解码是一个常见的环节。然而,当数据在不同系统之间传输时,可能会因为编码不一致而出现乱码。例如:

  • 原始数据以UTF-8编码存储。
  • 在传输或解析过程中,数据被错误地用GBK编码解码。
  • 最终导致JSON字符串中出现乱码。

这种问题不仅影响数据的可读性,还可能导致后续处理失败。因此,我们需要一个工具来修复这种编码错误。

核心原理

JsonEncodingFixer的核心原理是通过以下步骤修复乱码:

逆向工程:将错误解码的字符串重新编码为原始的错误字节。

正确解码:使用正确的编码(如UTF-8)重新解析这些字节。

具体来说,我们先将乱码字符串用GBK编码转换为字节数组,然后用UTF-8编码重新解析这些字节,从而恢复原始的正确字符串。

工具类实现

以下是JsonEncodingFixer工具类的完整代码实现,包含详细的注释和说明:

using System;
using System.IO;
using System.Text;
using System.Text.Encodings.Web;
using System.Text.Json;

namespace HalconCenter
{
    /// <summary>
    /// JSON编码修复工具类
    ///  javascript适用场景:修复因编码错误导致的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());
            }
        www.chinasem.cn}

        /// <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);
                 China编程   break;
            }
        }
    }
}

代码说明

1.FixEncoding方法:

这是核心修复方法,用于修复单个乱码字符串。

它通过将错误解码的字符串重新编码为字节数组,然后用正确的编码重新解析,从而恢复原始字符串。

2.FixJsonEncoding方法:

这个方法用于修复整个JSON对象。

它使用JsonDocument解析JSON,然后深度遍历所有节点,修复每个字符串值。

最后,它通过Utf8JsonWriter重建JSON结构,保持格式不变。

3.WriteFixedValue方法:

这是一个递归方法,用于深度遍历JSON对象或数组。

它会修复每个字符串值,并正确处理其他类型的节点(如数字、布尔值、null等)。

使用示例

以下是一个简单的使用示例:

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

            // 修复整个JSON对象
            string fixedJson = JsonEncodingFixer.FixJsonEncoding(yourCorruptedJson);
            Consolwww.chinasem.cne.WriteLine($"修复后的JSON: {fixedJson}");
        }
    }
}

输出结果将是修复后的正确JSON字符串。

总结

JsonEncodingFixer是一个简单而强大的工具类,可以帮助我们快速修复JSON乱码问题。它适用于各种因编码错误导致的乱码场景,能够显著提高开发效率。如果你在项目中遇到类似的乱码问题,不妨尝试使用这个工具类。

到此这篇关于基于.NET编写工具类解决JSON乱码问题的文章就介绍到这了,更多相关.NET解决JSON乱码内容请搜索编程China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持China编程(www.chinasem.cn)!

这篇关于基于.NET编写工具类解决JSON乱码问题的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1153646

相关文章

基于Python实现一个Windows Tree命令工具

《基于Python实现一个WindowsTree命令工具》今天想要在Windows平台的CMD命令终端窗口中使用像Linux下的tree命令,打印一下目录结构层级树,然而还真有tree命令,但是发现... 目录引言实现代码使用说明可用选项示例用法功能特点添加到环境变量方法一:创建批处理文件并添加到PATH1

SpringBoot排查和解决JSON解析错误(400 Bad Request)的方法

《SpringBoot排查和解决JSON解析错误(400BadRequest)的方法》在开发SpringBootRESTfulAPI时,客户端与服务端的数据交互通常使用JSON格式,然而,JSON... 目录问题背景1. 问题描述2. 错误分析解决方案1. 手动重新输入jsON2. 使用工具清理JSON3.

使用jenv工具管理多个JDK版本的方法步骤

《使用jenv工具管理多个JDK版本的方法步骤》jenv是一个开源的Java环境管理工具,旨在帮助开发者在同一台机器上轻松管理和切换多个Java版本,:本文主要介绍使用jenv工具管理多个JD... 目录一、jenv到底是干啥的?二、jenv的核心功能(一)管理多个Java版本(二)支持插件扩展(三)环境隔

Springboot3+将ID转为JSON字符串的详细配置方案

《Springboot3+将ID转为JSON字符串的详细配置方案》:本文主要介绍纯后端实现Long/BigIntegerID转为JSON字符串的详细配置方案,s基于SpringBoot3+和Spr... 目录1. 添加依赖2. 全局 Jackson 配置3. 精准控制(可选)4. OpenAPI (Spri

MySQL JSON 查询中的对象与数组技巧及查询示例

《MySQLJSON查询中的对象与数组技巧及查询示例》MySQL中JSON对象和JSON数组查询的详细介绍及带有WHERE条件的查询示例,本文给大家介绍的非常详细,mysqljson查询示例相关知... 目录jsON 对象查询1. JSON_CONTAINS2. JSON_EXTRACT3. JSON_TA

MySQL 设置AUTO_INCREMENT 无效的问题解决

《MySQL设置AUTO_INCREMENT无效的问题解决》本文主要介绍了MySQL设置AUTO_INCREMENT无效的问题解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参... 目录快速设置mysql的auto_increment参数一、修改 AUTO_INCREMENT 的值。

关于跨域无效的问题及解决(java后端方案)

《关于跨域无效的问题及解决(java后端方案)》:本文主要介绍关于跨域无效的问题及解决(java后端方案),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录通用后端跨域方法1、@CrossOrigin 注解2、springboot2.0 实现WebMvcConfig

Go语言中泄漏缓冲区的问题解决

《Go语言中泄漏缓冲区的问题解决》缓冲区是一种常见的数据结构,常被用于在不同的并发单元之间传递数据,然而,若缓冲区使用不当,就可能引发泄漏缓冲区问题,本文就来介绍一下问题的解决,感兴趣的可以了解一下... 目录引言泄漏缓冲区的基本概念代码示例:泄漏缓冲区的产生项目场景:Web 服务器中的请求缓冲场景描述代码

Python使用smtplib库开发一个邮件自动发送工具

《Python使用smtplib库开发一个邮件自动发送工具》在现代软件开发中,自动化邮件发送是一个非常实用的功能,无论是系统通知、营销邮件、还是日常工作报告,Python的smtplib库都能帮助我们... 目录代码实现与知识点解析1. 导入必要的库2. 配置邮件服务器参数3. 创建邮件发送类4. 实现邮件

Java死锁问题解决方案及示例详解

《Java死锁问题解决方案及示例详解》死锁是指两个或多个线程因争夺资源而相互等待,导致所有线程都无法继续执行的一种状态,本文给大家详细介绍了Java死锁问题解决方案详解及实践样例,需要的朋友可以参考下... 目录1、简述死锁的四个必要条件:2、死锁示例代码3、如何检测死锁?3.1 使用 jstack3.2