脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → C#教程 → C# xml序列化

C# xml序列化实现及遇到的坑

 更新时间：2023年09月12日 10:08:57   作者：假装我不帅  
在C#中,当我们需要将对象存储到文件或通过网络发送时,我们可以使用XML序列化将C#对象转换为XML文档,以便于存储、传输和还原,本文主要介绍了C# xml序列化实现及遇到的坑,感兴趣的可以了解一下

XML序列化是将对象转化为XML文档的过程。在C#中，当我们需要将对象存储到文件或通过网络发送时，我们可以使用XML序列化将C#对象转换为XML文档，以便于存储、传输和还原。同时，XML序列化也可以将已经存在的XML文档还原为C#对象。

需求：需要将对象进行xml序列化，不想包含xml声明也不想格式化

通过百度找到了如下的方法

/// <summary>
/// 对象转化为xml字符串
/// </summary>
/// <param name="obj"></param>
/// <returns></returns>
public static string ObjectToXmlString(object obj, bool isNeedHeader = false, bool isFormat = false)
{
    try
    {
        XmlSerializer xmlSerializer = new XmlSerializer(obj.GetType());
        XmlWriterSettings settings = new XmlWriterSettings();
        settings.Encoding = Encoding.UTF8;
        if (isFormat)
        {
            settings.Indent = true;
            settings.IndentChars = "    ";
            settings.NewLineChars = "\r\n";
        }
        if (!isNeedHeader)
        {
            settings.OmitXmlDeclaration = true;  // 不生成声明头
        }
        using (var memoryStream = new MemoryStream())
        using (XmlWriter xmlWriter = XmlWriter.Create(memoryStream, settings))
        {
            // 强制指定命名空间，覆盖默认的命名空间
            XmlSerializerNamespaces namespaces = new XmlSerializerNamespaces();
            namespaces.Add(string.Empty, string.Empty);
            xmlSerializer.Serialize(xmlWriter, obj, namespaces);
            var xmlString = Encoding.UTF8.GetString(memoryStream.ToArray());
            return xmlString;
        };
    }
    catch
    {
        return string.Empty;
    }
}

但是发现请求头前面有东西，因为他和普通输入的尖括号不一样，下面的两句代码看着是一样的但是具体运行起来就不一样了

var a1= Encoding.UTF8.GetBytes("<");
var a2 = Encoding.UTF8.GetBytes("<");

通过转化为byte查看，他俩字节长度都不一样

第二个比第一个多了三个特殊的字符,经过了解，239 187 191是utf-8 bom的前缀，所以xml序列化之后是utf-8 bom格式的，现在需要不是bom格式的，经过百度学习，发现 new UTF8Encoding(false); 这样的utf-8生成的字符串就不是带BOM得了，所以修改代码如下

/// <summary>
/// 对象转化为xml字符串
/// </summary>
/// <param name="obj"></param>
/// <param name="isNeedHeader">是否需要xml声明头，默认不需要</param>
/// <param name="isFormat">是否需要格式化xml，默认不需要</param>
/// <returns></returns>
public static string ObjectToXmlString(object obj, bool isNeedHeader = false, bool isFormat = false)
{
    try
    {
        XmlSerializer xmlSerializer = new XmlSerializer(obj.GetType());
        XmlWriterSettings settings = new XmlWriterSettings();
        settings.Encoding = new UTF8Encoding(false);//utf-8不带BOM //Encoding.UTF8;//utf-8带BOM
        if (isFormat)
        {
            settings.Indent = true;
            settings.IndentChars = "    ";
            settings.NewLineChars = "\r\n";
        }
        if (!isNeedHeader)
        {
            settings.OmitXmlDeclaration = true;  // 不生成声明头
        }
        using (var memoryStream = new MemoryStream())
        using (XmlWriter xmlWriter = XmlWriter.Create(memoryStream, settings))
        {
            // 强制指定命名空间，覆盖默认的命名空间
            XmlSerializerNamespaces namespaces = new XmlSerializerNamespaces();
            namespaces.Add(string.Empty, string.Empty);
            xmlSerializer.Serialize(xmlWriter, obj, namespaces);
            var xmlString = Encoding.UTF8.GetString(memoryStream.ToArray());
            return xmlString;
        };
    }
    catch
    {
        return string.Empty;
    }
}

到此这篇关于C# xml序列化实现及遇到的坑的文章就介绍到这了,更多相关C# xml序列化内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • C#实现窗体全屏的两种方法

    C#实现窗体全屏的两种方法

    这篇文章主要为大家详细介绍了C#实现窗体全屏的两种方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2018-10-10
  • 如何使用C#将Tensorflow训练的.pb文件用在生产环境详解

    如何使用C#将Tensorflow训练的.pb文件用在生产环境详解

    这篇文章主要给大家介绍了关于如何使用C#将Tensorflow训练的.pb文件用在生产环境的相关资料，文中通过示例代码介绍的非常详细，需要的朋友可以参考借鉴，下面随着小编来一起学习学习吧
    2018-11-11
  • C#身份证识别相关技术功能详解

    C#身份证识别相关技术功能详解

    这篇文章主要介绍了C#身份证识别相关技术详解,具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2017-07-07
  • C#反射机制介绍

    C#反射机制介绍

    这篇文章介绍了C#的反射机制，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2022-03-03
  • DevExpress设置FocusedNode背景色的方法

    DevExpress设置FocusedNode背景色的方法

    这篇文章主要介绍了DevExpress设置FocusedNode背景色的方法,很实用的功能,需要的朋友可以参考下
    2014-08-08
  • C#使用对象序列化类库MessasgePack

    C#使用对象序列化类库MessasgePack

    这篇文章介绍了C#使用对象序列化类库MessasgePack的方法，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2022-06-06
  • c# 开机启动项的小例子

    c# 开机启动项的小例子

    c# 开机启动项的小例子，需要的朋友可以参考一下
    2013-03-03
  • .NET Core开发之配置详解

    .NET Core开发之配置详解

    这篇文章给大家分享了.NET Core开发中相关配置的知识点内容，有需要的朋友们可以参考下。
    2018-08-08
  • C#自定义特性(Attribute)详解

    C#自定义特性(Attribute)详解

    本文详细讲解了C#的自定义特性(Attribute)，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2022-04-04
  • C#获取项目指定目录下文件的方法

    C#获取项目指定目录下文件的方法

    这篇文章主要介绍了C#获取项目指定目录下文件的方法,涉及C#操作目录及文件的技巧,非常具有实用价值,需要的朋友可以参考下
    2015-04-04

最新评论