快捷導(dǎo)航

C#?xml序列化實(shí)現(xiàn)及遇到的坑

更新時(shí)間：2023年09月12日 10:08:57 作者：假裝我不帥

在C#中,當(dāng)我們需要將對(duì)象存儲(chǔ)到文件或通過(guò)網(wǎng)絡(luò)發(fā)送時(shí),我們可以使用XML序列化將C#對(duì)象轉(zhuǎn)換為XML文檔,以便于存儲(chǔ)、傳輸和還原,本文主要介紹了C#?xml序列化實(shí)現(xiàn)及遇到的坑,感興趣的可以了解一下

XML序列化是將對(duì)象轉(zhuǎn)化為XML文檔的過(guò)程。在C#中，當(dāng)我們需要將對(duì)象存儲(chǔ)到文件或通過(guò)網(wǎng)絡(luò)發(fā)送時(shí)，我們可以使用XML序列化將C#對(duì)象轉(zhuǎn)換為XML文檔，以便于存儲(chǔ)、傳輸和還原。同時(shí)，XML序列化也可以將已經(jīng)存在的XML文檔還原為C#對(duì)象。

需求：需要將對(duì)象進(jìn)行xml序列化，不想包含xml聲明也不想格式化

通過(guò)百度找到了如下的方法

/// <summary>
/// 對(duì)象轉(zhuǎn)化為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))
        {
            // 強(qiáng)制指定命名空間，覆蓋默認(rèn)的命名空間
            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;
    }
}

但是發(fā)現(xiàn)請(qǐng)求頭前面有東西，因?yàn)樗推胀ㄝ斎氲募饫ㄌ?hào)不一樣，下面的兩句代碼看著是一樣的但是具體運(yùn)行起來(lái)就不一樣了

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

通過(guò)轉(zhuǎn)化為byte查看，他倆字節(jié)長(zhǎng)度都不一樣

第二個(gè)比第一個(gè)多了三個(gè)特殊的字符,經(jīng)過(guò)了解，239 187 191是utf-8 bom的前綴，所以xml序列化之后是utf-8 bom格式的，現(xiàn)在需要不是bom格式的，經(jīng)過(guò)百度學(xué)習(xí)，發(fā)現(xiàn) new UTF8Encoding(false); 這樣的utf-8生成的字符串就不是帶BOM得了，所以修改代碼如下

/// <summary>
/// 對(duì)象轉(zhuǎn)化為xml字符串
/// </summary>
/// <param name="obj"></param>
/// <param name="isNeedHeader">是否需要xml聲明頭，默認(rèn)不需要</param>
/// <param name="isFormat">是否需要格式化xml，默認(rèn)不需要</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))
        {
            // 強(qiáng)制指定命名空間，覆蓋默認(rèn)的命名空間
            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;
    }
}

到此這篇關(guān)于C# xml序列化實(shí)現(xiàn)及遇到的坑的文章就介紹到這了,更多相關(guān)C# xml序列化內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: