如何设置与 XmlDictionaryWriter 具有相同设置的 XmlWriter？

Question

我正在使用

DataContractSerializer dcs = new DataContractSerializer(typeof(T));
XmlDictionaryWriter xdw = XmlDictionaryWriter.CreateTextWriter(filestream, Encoding.UTF8);
dcs.WriteObject(xdw, obj);

为了写出 XML，我听说过 WCF DataContractSerializer 在性能和提供前向兼容性方面的优点。

但是，无法将设置传递给 XmlDictionaryWriter。

我不是 100% 理解 XmlDictionaryWriter 和具有自定义设置的普通 XmlWriter 之间的区别，据我所知，不可能调整 XmlDictionaryWriter 的设置。

那么 XmlDictionaryWriter 和 XmlWriter 之间有什么区别（是的，它是一个超类，但我说的是具体的，vs var XmlWriter = XmlWriter.Create(filestream, settings);）

除了将缩进设置为 true 之外，我可以使用哪些设置来尽可能接近地模仿 XmlDictionaryWriter？

我现在有

var settings = new XmlWriterSettings
            {
                Indent = true,
                Encoding = Encoding.UTF8,
                IndentChars = "    "
            };

作为我对 XmlWriter 的设置，而 XmlDictionaryWriter 似乎具有 null 设置。 （XmlDictionaryWriter.Settings 既是 null 又是只读的，所以这很失败。）

我的最终目标是格式化 XML，所以如果更改不是太严重，我还是可以使用手动创建的 XmlWriter。

使用 NUnit 比较两者的结果

XmlDictionaryWriter:

"<Party xmlns=\"http://schemas.datacontract.org/2004/07/HeliSTATS.Test\" xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\"><Guests><Larry><Age>12</Age><Friend><Name>John</Name></Friend></Larry><Larry><Age>15</Age><Friend><Name>Mason</Name></Friend></Larry></Guests></Party>"

XmlWriter:

"<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<Party xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/HeliSTATS.Test\">\r\n    <Guests>\r\n        <Larry>\r\n            <Age>12</Age>\r\n            <Friend>\r\n                <Name>John</Name>\r\n            </Friend>\r\n        </Larry>\r\n        <Larry>\r\n            <Age>15</Age>\r\n            <Friend>\r\n                <Name>Mason</Name>\r\n            </Friend>\r\n        </Larry>\r\n    </Guests>\r\n</Party>"

Answer 1

您实际上是在问几个单独的问题：

1. XmlDictionaryWriter 和XmlWriter 有什么区别？

   XMLWriter vs XMLDictionaryWriter 解决了这个问题，Bronumski 和 Mike McCaughan 提供了答案。结论是XmlDictionaryWriter被使用了

   • 为了性能（虽然我们不确定），并且
   • 作为数据协定的 XML、二进制和 MTOM 序列化的抽象基类。

   
   此外，DataContractSerializer 的某些功能仅适用于XmlDictionaryWriter。例如。如果您需要使用custom DataContractResolver 序列化对象，则需要使用DataContractSerializer.WriteObject(XmlDictionaryWriter, Object, DataContractResolver)，因为没有WriteObject() 的重载需要XmlWriter 和DataContractResolver。

2. 如何使用XmlDictionaryWriter 并控制XmlWriterSettings？

   如果您确定需要使用XmlDictionaryWriter（出于性能原因，或者因为您需要使用DataContractResolver），那么您可以使用XmlDictionaryWriter.CreateDictionaryWriter(XmlWriter) 构造一个包装预先存在的XmlWriter。

3. 我可以使用哪些设置来尽可能地模仿XmlDictionaryWriter 和XmlWriter，同时仍然缩进？

   你没有。您使用您需要的那个，如果您需要两者的功能，请创建一个包装好的XmlWriter，如上所示。

综上所述，以下扩展方法可用于序列化XmlDictionaryWriter 和可选XmlWriterSettings：

public static partial class DataContractSerializerExtensions
{
    public static string ToContractXml<T>(this T obj, DataContractSerializer serializer = null, XmlWriterSettings settings = null, DataContractResolver resolver = null)
    {
        serializer = serializer ?? new DataContractSerializer(obj == null ? typeof(T) : obj.GetType());
        using (var textWriter = new StringWriterWithEncoding((settings == null ? null : settings.Encoding) ?? Encoding.UTF8))
        {
            using (var xmlWriter = XmlWriter.Create(textWriter, settings))
            {
                serializer.WriteObject(xmlWriter, obj, resolver);
            }
            return textWriter.ToString();
        }
    }

    public static void WriteObject(this DataContractSerializer serializer, Stream stream, object obj, XmlWriterSettings settings, DataContractResolver resolver = null)
    {
        if (serializer == null || stream == null)
            throw new ArgumentNullException();
        // If settings are specified create a wrapped dictionary writer, else create a text writer directly.
        if (settings == null)
        {
            // Let caller close the stream
            using (var xmlWriter = XmlDictionaryWriter.CreateTextWriter(stream, Encoding.UTF8, false))
            {
                serializer.WriteObject(xmlWriter, obj, resolver);
            }
        }
        else
        {
            using (var xmlWriter = XmlWriter.Create(stream, settings))
            {
                serializer.WriteObject(xmlWriter, obj, resolver);
            }
        }
    }

    static void WriteObject(this DataContractSerializer serializer, XmlWriter xmlWriter, object obj, DataContractResolver resolver)
    {
        if (serializer == null || xmlWriter == null)
            throw new ArgumentNullException();
        using (var xmlDictionaryWriter = XmlDictionaryWriter.CreateDictionaryWriter(xmlWriter))
        {
            serializer.WriteObject(xmlDictionaryWriter, obj, resolver);
        }
    }
}

然后，分析带有和不带有 XmlWriterSettings 的 WriteObject()，以确定使用包装的 XmlWriter 对性能的影响。