基于.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

相关文章

解决RocketMQ的幂等性问题

《解决RocketMQ的幂等性问题》重复消费因调用链路长、消息发送超时或消费者故障导致,通过生产者消息查询、Redis缓存及消费者唯一主键可以确保幂等性,避免重复处理,本文主要介绍了解决RocketM... 目录造成重复消费的原因解决方法生产者端消费者端代码实现造成重复消费的原因当系统的调用链路比较长的时

深度解析Nginx日志分析与499状态码问题解决

《深度解析Nginx日志分析与499状态码问题解决》在Web服务器运维和性能优化过程中,Nginx日志是排查问题的重要依据,本文将围绕Nginx日志分析、499状态码的成因、排查方法及解决方案展开讨论... 目录前言1. Nginx日志基础1.1 Nginx日志存放位置1.2 Nginx日志格式2. 499

SpringBoot监控API请求耗时的6中解决解决方案

《SpringBoot监控API请求耗时的6中解决解决方案》本文介绍SpringBoot中记录API请求耗时的6种方案,包括手动埋点、AOP切面、拦截器、Filter、事件监听、Micrometer+... 目录1. 简介2.实战案例2.1 手动记录2.2 自定义AOP记录2.3 拦截器技术2.4 使用Fi

kkFileView启动报错:报错2003端口占用的问题及解决

《kkFileView启动报错:报错2003端口占用的问题及解决》kkFileView启动报错因office组件2003端口未关闭,解决:查杀占用端口的进程,终止Java进程,使用shutdown.s... 目录原因解决总结kkFileViewjavascript启动报错启动office组件失败,请检查of

SQL Server安装时候没有中文选项的解决方法

《SQLServer安装时候没有中文选项的解决方法》用户安装SQLServer时界面全英文,无中文选项,通过修改安装设置中的国家或地区为中文中国,重启安装程序后界面恢复中文,解决了问题,对SQLSe... 你是不是在安装SQL Server时候发现安装界面和别人不同,并且无论如何都没有中文选项?这个问题也

SpringBoot 异常处理/自定义格式校验的问题实例详解

《SpringBoot异常处理/自定义格式校验的问题实例详解》文章探讨SpringBoot中自定义注解校验问题,区分参数级与类级约束触发的异常类型,建议通过@RestControllerAdvice... 目录1. 问题简要描述2. 异常触发1) 参数级别约束2) 类级别约束3. 异常处理1) 字段级别约束

详解MySQL中JSON数据类型用法及与传统JSON字符串对比

《详解MySQL中JSON数据类型用法及与传统JSON字符串对比》MySQL从5.7版本开始引入了JSON数据类型,专门用于存储JSON格式的数据,本文将为大家简单介绍一下MySQL中JSON数据类型... 目录前言基本用法jsON数据类型 vs 传统JSON字符串1. 存储方式2. 查询方式对比3. 索引

java内存泄漏排查过程及解决

《java内存泄漏排查过程及解决》公司某服务内存持续增长,疑似内存泄漏,未触发OOM,排查方法包括检查JVM配置、分析GC执行状态、导出堆内存快照并用IDEAProfiler工具定位大对象及代码... 目录内存泄漏内存问题排查1.查看JVM内存配置2.分析gc是否正常执行3.导出 dump 各种工具分析4.

C#解析JSON数据全攻略指南

《C#解析JSON数据全攻略指南》这篇文章主要为大家详细介绍了使用C#解析JSON数据全攻略指南,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、为什么jsON是C#开发必修课?二、四步搞定网络JSON数据1. 获取数据 - HttpClient最佳实践2. 动态解析 - 快速

Python错误AttributeError: 'NoneType' object has no attribute问题的彻底解决方法

《Python错误AttributeError:NoneTypeobjecthasnoattribute问题的彻底解决方法》在Python项目开发和调试过程中,经常会碰到这样一个异常信息... 目录问题背景与概述错误解读:AttributeError: 'NoneType' object has no at