C#: 将对象呈现为XML

6
我正在寻找一种将对象树转换为XML的方法。虽然编写这样的程序会很有趣,但我相信已经有人写过了。以下是我的愿望清单:
  • 它不应关心构造函数
  • 最好能处理循环引用(无论如何都不太重要)
  • 它不需要更改对象 - 例如,没有自定义属性
  • 它不关心或需要已知类型(例如XmlInclude)
  • XML应该非常简单 - 运营团队成员需要能够轻松阅读
  • 如果某个属性无法序列化,它应该只是忽略错误并继续执行
  • 可以处理列表和字典

我不需要重建对象模型,因此仅写入解决方案即可(可能是预期的)。

我认为排除以下选项:

  • XmlSerializer - 需要无参数构造函数,不支持循环引用
  • DataContractSerializer - 需要属性(选择加入)

真是个好问题!:P - Cerebrus
有趣的问题。恐怕“它不应该关心构造函数”的要求可能无法满足。如果我的类型有10个不同的构造函数,序列化程序如何知道使用哪个构造函数? - Szymon Rozga
@siz - 我应该澄清一下。它不关心这个问题,因为它只是将对象序列化为 XML,而从不反序列化 XML 为对象。这就是我所说的“只写”解决方案的含义。 - Paul Stovell
为什么你会“排除”XmlSerializer,因为它比你需要的功能更强大?这是否意味着你会拒绝使用Windows,因为它具有语音识别功能,或者你会拒绝使用RDBMS,因为它现在具有地理空间功能?似乎自己编写这个程序是繁琐的工作。 - Cheeso
如果是只写,那么它实际上是一个任意对象的漂亮打印机/格式化程序,但输出为XML。也许使用这些术语进行搜索可能会有所帮助。顺便问一下,它必须是“XML”,还是您真的想要“人类可读”? - 13ren
显示剩余2条评论
3个回答

6
罗伯特·罗斯尼的帖子让我认为这可能比我想象的要简单。所以这是一个非常粗糙的尝试。它处理以下内容:
  • 如果无法读取属性,则将异常打印为值
  • 循环引用和多次出现。它使用ID与每个元素关联;如果一个元素出现两次,它只是指向ref ID。Ref ID对对象图是唯一的(我应该使用GUID,但这符合我的目的)。
  • 它没有派生类型的问题
  • 它不需要属性或特定构造函数或其他废话
  • 它可以处理只读属性
这是输出的示例(在我的测试对象中,“订单”上的“货币”产品会抛出异常)。
<Customer Ref="1">
  <FirstName>Paul</FirstName>
  <LastName>Stovell</LastName>
  <FullName>Paul Stovell</FullName>
  <Orders>
    <Order Ref="2">
      <SKU>Apples</SKU>
      <Price>27.30</Price>
      <Currency>Something bad happened</Currency>
      <Customer Ref="1" />
    </Order>
    <Order Ref="3">
      <SKU>Pears</SKU>
      <Price>17.85</Price>
      <Currency>Something bad happened</Currency>
      <Customer Ref="1" />
    </Order>
    <Order Ref="2" />
  </Orders>
</Customer>

以下是示例对象模型和用法:

示例:

static void Main(string[] args)
{
    var customer = new Customer();
    customer.FirstName = "Paul";
    customer.LastName = "Stovell";
    customer.Orders.Add(new Order(customer) { Price = 27.30M, SKU = "Apples"});
    customer.Orders.Add(new Order(customer) { Price = 17.85M, SKU = "Pears"});
    customer.Orders.Add(customer.Orders[0]);

    var output = new StringWriter();
    var writer = new XmlTextWriter(output);
    writer.Formatting = Formatting.Indented;
    WriteComplexObject("Customer", customer, writer);
    Console.WriteLine(output.ToString());
    Console.ReadKey();
}

class Customer
{
    private readonly List<Order> _orders = new List<Order>();

    public Customer()
    {
    }

    public string FirstName { get; set; }
    public string LastName { get; set; }

    public string FullName
    {
        // Read-only property test
        get { return FirstName + " " + LastName; }
    }

    public List<Order> Orders
    {
        // Collections test
        get { return _orders; }
    }
}

class Order
{
    private readonly Customer _customer;

    public Order(Customer customer)
    {
        _customer = customer;
    }

    public string SKU { get; set; }
    public decimal Price { get; set; }
    public string Currency
    {
        // A proprty that, for some reason, can't be read
        get
        {
            throw new Exception("Something bad happened");
        }
    }

    public Customer Customer
    {
        get { return _customer; }
    }
}

以下是实现代码:
public static void WriteObject(string name, object target, XmlWriter writer)
{
    WriteObject(name, target, writer, new List<object>(), 0, 10, -1);
}

private static void WriteObject(string name, object target, XmlWriter writer, List<object> recurringObjects, int depth, int maxDepth, int maxListLength)
{
    var formatted = TryToFormatPropertyValueAsString(target);
    if (formatted != null)
    {
        WriteSimpleProperty(name, formatted, writer);
    }
    else if (target is IEnumerable)
    {
        WriteCollectionProperty(name, (IEnumerable)target, writer, depth, maxDepth, recurringObjects, maxListLength);
    }
    else
    {
        WriteComplexObject(name, target, writer, recurringObjects, depth, maxDepth, maxListLength);
    }
}

private static void WriteComplexObject(string name, object target, XmlWriter writer, List<object> recurringObjects, int depth, int maxDepth, int maxListLength)
{
    if (target == null || depth >= maxDepth) return;
    if (recurringObjects.Contains(target))
    {
        writer.WriteStartElement(name);
        writer.WriteAttributeString("Ref", (recurringObjects.IndexOf(target) + 1).ToString());
        writer.WriteEndElement();
        return;
    }
    recurringObjects.Add(target);

    writer.WriteStartElement(name);
    writer.WriteAttributeString("Ref", (recurringObjects.IndexOf(target) + 1).ToString());
    foreach (var property in target.GetType().GetProperties())
    {
        var propertyValue = ReadPropertyValue(target, property);
        WriteObject(property.Name, propertyValue, writer, recurringObjects, depth + 1, maxDepth, maxListLength);
    }
    writer.WriteEndElement();
}

private static object ReadPropertyValue(object target, PropertyInfo property)
{
    try { return property.GetValue(target, null); }
    catch (Exception ex) { return ReadExceptionMessage(ex); }
}

private static string ReadExceptionMessage(Exception ex)
{
    if (ex is TargetInvocationException && ex.InnerException != null)
        return ReadExceptionMessage(ex.InnerException);
    return ex.Message;
}

private static string TryToFormatPropertyValueAsString(object propertyValue)
{
    var formattedPropertyValue = null as string;
    if (propertyValue == null)
    {
        formattedPropertyValue = string.Empty;
    }
    else if (propertyValue is string || propertyValue is IFormattable || propertyValue.GetType().IsPrimitive)
    {
        formattedPropertyValue = propertyValue.ToString();
    }
    return formattedPropertyValue;
}

private static void WriteSimpleProperty(string name, string formattedPropertyValue, XmlWriter writer)
{
    writer.WriteStartElement(name);
    writer.WriteValue(formattedPropertyValue);
    writer.WriteEndElement();
}

private static void WriteCollectionProperty(string name, IEnumerable collection, XmlWriter writer, int depth, int maxDepth, List<object> recurringObjects, int maxListLength)
{
    writer.WriteStartElement(name);
    var enumerator = null as IEnumerator;
    try
    {
        enumerator = collection.GetEnumerator();
        for (var i = 0; enumerator.MoveNext() && (i < maxListLength || maxListLength == -1); i++)
        {
            if (enumerator.Current == null) continue;
            WriteComplexObject(enumerator.Current.GetType().Name, enumerator.Current, writer, recurringObjects, depth + 1, maxDepth, maxListLength);
        }
    }
    catch (Exception ex)
    {
        writer.WriteElementString(ex.GetType().Name, ReadExceptionMessage(ex));
    }
    finally
    {
        var disposable = enumerator as IDisposable;
        if (disposable != null)
        {
            disposable.Dispose();
        }
        writer.WriteEndElement();
    }
}

我仍然很想知道是否有更多经过验证的解决方案。


4
这似乎可以使用反射轻松编写:给定一个对象实例,创建一个带有其类名的XML元素,然后遍历其所有属性。
对于每个属性,创建一个带有其名称的元素:
- 如果它是值类型,则将其文本设置为其值的XML模式文本; - 如果它实现了IEnumerable,则迭代访问并为每个项创建一个元素; - 如果它是任何其他引用类型,则将元素的内容设置为属性的XML表示。
使用包含已序列化每个对象的哈希代码的HashSet跟踪循环/多重引用;如果在HashSet中找到对象的哈希代码,则已经对其进行了序列化。(如果发生这种情况,我不知道您想要放入XML中的内容。)
但是,不,我没有编写此代码的例子。

1

我怀疑你不会找到适用于所有类的特别好的解决方案。正如你所指出的,XmlSerializer 是迄今为止微软在泛型端口上的最佳努力。

另一方面是可视化工具,它们只适用于特定的类。我认为目前还没有一个很好的平衡点。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接