从我的 xml (de)serializer 得到奇怪的结果

Question

我创建了一个 streamExtension，我可以在其中简单地序列化和反序列化来自 xml 文件的流，代码如下所示：

/// <summary>
/// Contains the logic for streaming extensions.
/// </summary>
public static class StreamExtensions
{
    /// <summary>
    /// Serialize an object.
    /// </summary>
    /// <typeparam name="T">The type of the object that gets serialized.</typeparam>
    /// <param name="stream">The stream to which the bytes will be written.</param>
    /// <param name="serializableObject">The object that gets serialized.</param>
    public static void SerializeObject<T>(this Stream stream, T serializableObject) where T : IXmlSerializable
    {
        var xmlTextWriter = new XmlTextWriter(stream, Encoding.UTF8);
        xmlTextWriter.Formatting = Formatting.Indented;
        xmlTextWriter.IndentChar = ' ';
        xmlTextWriter.Indentation = 4;

        var serializer = new XmlSerializer(typeof(T));

        serializer.Serialize(xmlTextWriter, serializableObject);

        xmlTextWriter.Close();
        stream.Close();
    }

    /// <summary>
    /// Deserialize a stream and return the object.
    /// </summary>
    /// <typeparam name="T">The type of the object that returns from the deserialization.</typeparam>
    /// <param name="stream">The stream which contains the bytes to deserialize.</param>
    /// <returns>The object recovered.</returns>
    public static T DeserializeObject<T>(this Stream stream)
    {
        var xmlTextReader = new XmlTextReader(stream);
        var serializer = new XmlSerializer(typeof(T));

        var result = (T)serializer.Deserialize(xmlTextReader);

        xmlTextReader.Close();
        stream.Close();

        return result;
    }
}

2 个非常简单（如果我可以这么说：优雅）的序列化和反序列化方法。

我正在使用这个 class 作为测试：

/// <summary>
/// A serializable class for testing purposes.
/// </summary>
public class SerializableXmlTest : IXmlSerializable
{
    #region Fields
    private string mTestString = string.Empty;
    #endregion

    #region Properties
    /// <summary>
    /// Gets or sets the configuration for this simulation.
    /// </summary>
    /// <value>The configuration for this simulation.</value>
    public string TestString
    {
        get
        {
            return mTestString;
        }

        set
        {
            mTestString = value;
        }
    }
    #endregion

    #region XML serialization region
    /// <summary>
    /// Write the extra information to an XML stream.
    /// </summary>
    /// <param name="writer">Writer to write to.</param>
    public void WriteXml(XmlWriter writer)
    {
        writer.WriteStartElement(MethodBase.GetCurrentMethod().DeclaringType.Name);
        writer.WriteAttributeString("TestString", this.TestString);
        writer.WriteEndElement();
    }

    /// <summary>
    /// Read the extra information from an XML stream.
    /// </summary>
    /// <param name="reader">Reader to read from.</param>
    public void ReadXml(XmlReader reader)
    {
        if ((reader.MoveToContent() == XmlNodeType.Element) && (reader.Name == MethodBase.GetCurrentMethod().DeclaringType.Name))
        {
            reader.Read();
            this.TestString = reader.GetAttribute("TestString");
        }

        reader.ReadEndElement();
    }

    /// <summary>
    /// This method is reserved when implementing the IXmlSerializable interface.
    /// </summary>
    /// <returns>An XmlSchema that describes the XML representation of the
    /// object that is produced by the WriteXml method and consumed by the
    /// ReadXml method.</returns>
    public XmlSchema GetSchema()
    {
        return null;
    }
    #endregion
}

这是我单元测试中的代码：

/// <summary>
/// Test the stream extension class for normal function.
/// </summary>
[Test]
public void TestStreamExtension()
{
    File.Delete(mFileName);
    var testObject = new SerializableXmlTest();
    testObject.TestString = "Test";

    Stream saveFileStream = new FileStream(mFileName, FileMode.OpenOrCreate);
    saveFileStream.SerializeObject(testObject);

    Stream openFileStream = new FileStream(mFileName, FileMode.OpenOrCreate);
    var testObjectClone = openFileStream.DeserializeObject<SerializableXmlTest>();
    Assert.IsTrue(testObject.TestString.Equals(testObjectClone.TestString));
    }

输出的xml文件：

<?xml version="1.0" encoding="utf-8"?>
<SerializableXmlTest>
    <SerializableXmlTest TestString="Test" />
</SerializableXmlTest>

但是有几件事我不明白，至少其中一个肯定是错误的（我认为）

第一件事是我希望我的 xml 文件看起来像这样：

<?xml version="1.0" encoding="utf-8"?>
<SerializableXmlTest TestString="Test" />

但如果您需要单独的开始和结束元素，我可以理解。

尝试阅读它时的第二件事 reader 登陆的第一个元素是（如预期的那样）<SerializableXmlTest> 但是，如果我然后继续执行 reader.Read() 或 reader.ReadStartElement() 调试器告诉我它当前正在读取：

{Whitespace, Value="\r\n    "}.

这是从哪里来的？为什么要读取换行符？显然，当我使用另一个 reader.Read() 时，我确实进入了 xml 文件中的 <SerializableXmlTest TestString="Test" /> 行。

我做错了什么？

P.s。告诉您我稍微更改了序列化和反序列化方法（它们曾经有效）可能是明智的，但是序列化仅使用 xmlTextWriter 而不是 XmlSerializer。反序列化方法使用流 reader 而不是 XmlTextReader。但是为了使它们相同，我遇到了这个我似乎无法弄清楚的问题。

额外问题：我是否应该使用 XmlTextReader 和 writer？我也可以将获得的流作为方法参数传递给序列化程序，不是吗？

Answer 1

几件事。

1) 序列化器失败

XmlSerializer.Serialize(stream, object)

已经写入了文件的编码和起始元素。这就是为什么你会得到奇怪的输出。将您的 WriteXML 方法缩减为仅打开流，让序列化程序完成其余的工作。这将修复您编写的 XML 文件。

2) \r\n

的读取

目前有 2 种方法可以访问 .NET 中的 XML 数据

XmlReader \ XmlWriter
XmlFile

当您使用 XmlReader 时，您将可以更深入地访问 XML 文件。另一方面，这意味着一些自动化会丢失。 XmlReader.Read() 完全正确。首先，他找到了一个 < 标志。所以现在他知道阅读直到找到 > 结束标记。然后你告诉他再读一遍。现在他看到了一个 \r\n 标志。现在他知道他必须停下来，因为你告诉他只读 1 个字符，但他没有找到 < 开始标记。

希望对您有所帮助

从我的 xml (de)serializer 得到奇怪的结果

getting strange results from my xml (de)serializer

c#

xml

xml-serialization

xml-deserialization