使用 XmlSerializer 时如何向 XML 文件写入注释？

Question

我有一个对象 Foo，我将其序列化为 XML 流。

public class Foo {
  // The application version, NOT the file version!
  public string Version {get;set;}
  public string Name {get;set;}
}

Foo foo = new Foo { Version = "1.0", Name = "Bar" };
XmlSerializer xmlSerializer = new XmlSerializer(foo.GetType());

它工作起来快速、简单，并且可以完成当前所需的一切。

我遇到的问题是我需要维护一个单独的文档文件，其中包含一些小注释。如上例所示，Name 很明显，但 Version 是应用程序版本，而不是我们在本例中所期望的数据文件版本。我还有很多类似的小事情想通过评论来澄清。

我知道如果我使用 WriteComment() 函数手动创建 XML 文件，我就可以做到这一点，但是是否可以实现一个可能的属性或替代语法，以便我可以继续使用序列化器功能？

Answer 1

可能迟到了，但当我尝试使用 Kirill Polishchuk 解决方案反序列化时遇到了问题。最后我决定在序列化 XML 后对其进行编辑，解决方案如下所示：

public static void WriteXml(object objectToSerialize, string path)
{
    try
    {
        using (var w = new XmlTextWriter(path, null))
        {
            w.Formatting = Formatting.Indented;
            var serializer = new XmlSerializer(objectToSerialize.GetType());
            serializer.Serialize(w, objectToSerialize);
        }

        WriteComments(objectToSerialize, path);
    }
    catch (Exception e)
    {
        throw new Exception($"Could not save xml to path {path}. Details: {e}");
    }
}

public static T ReadXml<T>(string path) where T:class, new()
{
    if (!File.Exists(path))
        return null;
    try
    {
        using (TextReader r = new StreamReader(path))
        {
            var deserializer = new XmlSerializer(typeof(T));
            var structure = (T)deserializer.Deserialize(r);
            return structure;
        }
    }
    catch (Exception e)
    {
        throw new Exception($"Could not open and read file from path {path}. Details: {e}");
    }
}

private static void WriteComments(object objectToSerialize, string path)
{
    try
    {
        var propertyComments = GetPropertiesAndComments(objectToSerialize);
        if (!propertyComments.Any()) return;

        var doc = new XmlDocument();
        doc.Load(path);

        var parent = doc.SelectSingleNode(objectToSerialize.GetType().Name);
        if (parent == null) return;

        var childNodes = parent.ChildNodes.Cast<XmlNode>().Where(n => propertyComments.ContainsKey(n.Name));
        foreach (var child in childNodes)
        {
            parent.InsertBefore(doc.CreateComment(propertyComments[child.Name]), child);
        }

        doc.Save(path);
    }
    catch (Exception)
    {
        // ignored
    }
}

private static Dictionary<string, string> GetPropertiesAndComments(object objectToSerialize)
{
    var propertyComments = objectToSerialize.GetType().GetProperties()
        .Where(p => p.GetCustomAttributes(typeof(XmlCommentAttribute), false).Any())
        .Select(v => new
        {
            v.Name,
            ((XmlCommentAttribute) v.GetCustomAttributes(typeof(XmlCommentAttribute), false)[0]).Value
        })
        .ToDictionary(t => t.Name, t => t.Value);
    return propertyComments;
}

[AttributeUsage(AttributeTargets.Property)]
public class XmlCommentAttribute : Attribute
{
    public string Value { get; set; }
}

Answer 2

用户 dbc 提出的解决方案看起来不错，但是与使用知道的 XmlWriter 相比，它似乎需要更多的手动工作来创建此类注释如何根据 XmlComment 属性插入注释。

请参阅 https://archive.codeplex.com/?p=xmlcomment - 看来你可以将这样的编写器传递给 XmlSerializer，因此不必实现您自己的序列化，这可能很棘手。

不过，我自己最终还是使用了 dbc 的解决方案，干净整洁，没有额外的代码。请参阅https://dotnetfiddle.net/Bvbi0N。确保为注释元素（XmlAnyElement）提供“set”访问器。顺便说一句，它不需要有名字。

更新：最好始终传递唯一的名称，即使用 [XmlAnyElement("someCommentElement")] 而不是 [XmlAnyElement]。在 WCF 中使用相同的类，它被那些没有提供名称的 XmlAnyElements 阻塞，尽管我对它们都有 [XmlIgnore、SoapIgnore、IgnoreDataMember]。

Answer 3

对于嵌套的 xml，我以这种方式更改了方法（对我来说，我有简单的属性作为字符串（有可能使其逻辑更加复杂）

public void WriteXml(XmlWriter writer)
    {
        var properties = GetType().GetProperties();

        foreach (var propertyInfo in properties)
        {
            if (propertyInfo.IsDefined(typeof(XmlCommentAttribute), false))
            {
                writer.WriteComment(
                    propertyInfo.GetCustomAttributes(typeof(XmlCommentAttribute), false)
                        .Cast<XmlCommentAttribute>().Single().Value);
            }

                if (propertyInfo.GetValue(this, null).GetType().ToString() != "System.String")
                {
                    XmlSerializer xmlSerializer = new XmlSerializer(propertyInfo.GetValue(this, null).GetType());
                    xmlSerializer.Serialize(writer, propertyInfo.GetValue(this, null));
                }
                else
                {
                    writer.WriteElementString(propertyInfo.Name, propertyInfo.GetValue(this, null).ToString());

                }
            }
    }

Answer 4

通过使用返回 XmlComment 并用 [XmlAnyElement("SomeUniquePropertyName")]。

即，如果您向 Foo 添加一个属性，如下所示：

public class Foo
{
    [XmlAnyElement("VersionComment")]
    public XmlComment VersionComment { get { return new XmlDocument().CreateComment("The application version, NOT the file version!"); } set { } }

    public string Version { get; set; }
    public string Name { get; set; }
}

将生成以下 XML：

<Foo>
  <!--The application version, NOT the file version!-->
  <Version>1.0</Version>
  <Name>Bar</Name>
</Foo>

但是，问题要求的不止于此，即某种在文档系统中查找注释的方法。以下代码通过使用扩展方法根据反射的注释属性名称查找文档来实现此目的：

public class Foo
{
    [XmlAnyElement("VersionXmlComment")]
    public XmlComment VersionXmlComment { get { return GetType().GetXmlComment(); } set { } }

    [XmlComment("The application version, NOT the file version!")]
    public string Version { get; set; }

    [XmlAnyElement("NameXmlComment")]
    public XmlComment NameXmlComment { get { return GetType().GetXmlComment(); } set { } }

    [XmlComment("The application name, NOT the file name!")]
    public string Name { get; set; }
}

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]
public class XmlCommentAttribute : Attribute
{
    public XmlCommentAttribute(string value)
    {
        this.Value = value;
    }

    public string Value { get; set; }
}

public static class XmlCommentExtensions
{
    const string XmlCommentPropertyPostfix = "XmlComment";

    static XmlCommentAttribute GetXmlCommentAttribute(this Type type, string memberName)
    {
        var member = type.GetProperty(memberName);
        if (member == null)
            return null;
        var attr = member.GetCustomAttribute<XmlCommentAttribute>();
        return attr;
    }

    public static XmlComment GetXmlComment(this Type type, [CallerMemberName] string memberName = "")
    {
        var attr = GetXmlCommentAttribute(type, memberName);
        if (attr == null)
        {
            if (memberName.EndsWith(XmlCommentPropertyPostfix))
                attr = GetXmlCommentAttribute(type, memberName.Substring(0, memberName.Length - XmlCommentPropertyPostfix.Length));
        }
        if (attr == null || string.IsNullOrEmpty(attr.Value))
            return null;
        return new XmlDocument().CreateComment(attr.Value);
    }
}

为此生成以下 XML：

<Foo>
  <!--The application version, NOT the file version!-->
  <Version>1.0</Version>
  <!--The application name, NOT the file name!-->
  <Name>Bar</Name>
</Foo>

注意：

• 扩展方法 XmlCommentExtensions.GetXmlCommentAttribute(this Type type, string memberName ) 假定注释属性将命名为 xxxXmlComment，其中 xxx 是“真实”属性。如果是这样，它可以通过使用 CallerMemberNameAttribute。这可以通过传入真实姓名手动覆盖。

• 一旦知道类型和成员名称，扩展方法就会通过搜索应用于属性的 [XmlComment] 特性来查找相关注释。这可以替换为对单独文档文件的缓存查找。

• 虽然仍然需要为每个可能被注释的属性添加 xxxXmlComment 属性，但这可能比 直接实现 IXmlSerialized 这是相当棘手的，可能会导致反序列化中的错误，并且可能需要复杂子属性的嵌套序列化。

• 确保每个注释位于其关联元素之前，请参阅控制 C# 中的序列化顺序。

• 要使 XmlSerializer 序列化属性，它必须同时具有 getter 和 setter。因此，我提供了不执行任何操作的注释属性设置器。

工作 .Net fiddle。

Answer 5

使用默认基础设施是不可能的。您需要根据您的目的实现IXmlSerialized。

非常简单的实现：

public class Foo : IXmlSerializable
{
    [XmlComment(Value = "The application version, NOT the file version!")]
    public string Version { get; set; }
    public string Name { get; set; }


    public void WriteXml(XmlWriter writer)
    {
        var properties = GetType().GetProperties();

        foreach (var propertyInfo in properties)
        {
            if (propertyInfo.IsDefined(typeof(XmlCommentAttribute), false))
            {
                writer.WriteComment(
                    propertyInfo.GetCustomAttributes(typeof(XmlCommentAttribute), false)
                        .Cast<XmlCommentAttribute>().Single().Value);
            }

            writer.WriteElementString(propertyInfo.Name, propertyInfo.GetValue(this, null).ToString());
        }
    }
    public XmlSchema GetSchema()
    {
        throw new NotImplementedException();
    }

    public void ReadXml(XmlReader reader)
    {
        throw new NotImplementedException();
    }
}

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]
public class XmlCommentAttribute : Attribute
{
    public string Value { get; set; }
}

输出：

<?xml version="1.0" encoding="utf-16"?>
<Foo>
  <!--The application version, NOT the file version!-->
  <Version>1.2</Version>
  <Name>A</Name>
</Foo>

另一种方式，也许更好：使用默认序列化程序序列化，然后执行后处理，即更新 XML，例如使用 XDocument 或 XmlDocument。

Answer 6

序列化后在 xml 末尾添加注释（神奇的是刷新 xmlWriter）。

byte[] buffer;

XmlSerializer serializer = new XmlSerializer(result.GetType());

var settings = new XmlWriterSettings() { Encoding = Encoding.UTF8 };

using (MemoryStream memoryStream = new MemoryStream())
{
    using (XmlWriter xmlWriter = XmlWriter.Create(memoryStream, settings))
    {
        serializer.Serialize(xmlWriter, result);

        xmlWriter.WriteComment("test");

        xmlWriter.Flush();

        buffer = memoryStream.ToArray();
    }
}