c# - 存储对象的 XML/CSV/其他表示的最佳位置是什么

Question

当一个对象有多种格式(XML、CSV)可以表示时，应该在哪里存储这些格式的知识。

对象是否应该知道它是如何在 XML 中表示的(即让对象通过对象上的某种方法转换自身，例如 GetXML())。对象的知识是否过多，是否应将其存储在存储库/服务/其他层的外部？

如果它存储在存储库中，在对象的 XML 表示必须与其他信息一起持久保存到数据库的用例中会发生什么，例如:-

insert into order values(1, '2004', <order><amount>2</amount><price>19.99</price></order>) ;

...对象的 XML 结构的知识将在 XML 存储库中，但是 SQL 存储库也需要这些知识，这看起来像是重复。

我不确定服务层是否也应该保存对象表示，因为这似乎不是业务逻辑。

此用例的推荐实现是什么？

Answer 1

一般来说，您希望对象的 XML(或其他...)格式化代码与对象本身分开。这样做的实际原因是希望有不止一种 XML 表示(比如摘要和详细表示)。如果这些方法包含对象 API 的所有部分，那么您将开始拥有:

public String GetShortXml(){ ... }
public String GetFullXml(){ ... }
public String GetCsv(){ ... }
public String GetJson(){ ... }

作为每个业务对象的 API 的一部分，这很快就会变得丑陋。此外，这违反了 single responsibility priciple因为每个类都负责 id 的功能并将其自身表示为 XML、JSON、CSV 等。

因此，通常最好有一个知道如何格式化您关心的业务对象的类，并且有一个 SummaryXmlFormatter、DetailedXmlFormatter、CsvFormatter、JsonFormater 等。

您可以更进一步，让您的对象实现一个 IFormattable 接口(interface)(以下是对 visitor patter 的改编，它为我们提供了双重调度优点):

public interface IFormattable {
    public String Format(IFormatter formatter);
}

实现方式如下:

public String Format(IFormatter formatter){
    return formatter.FormatBusinessObjectOne(this);
}

这样定义 IFormatter 接口(interface):

public interface IFormatter{
    public String FormatBuisinessObjectOne(BusinessObjectOne boo);
    public String FormatBuisinessObjectTwo(BusinessObjectTwo bot);
    ...
}

这将允许您的格式化调用以多态方式分派(dispatch)。根据您的要求，可能有用也可能没用(您是否曾拥有不同类型的集合，因此需要多态分派(dispatch)或是否足够重载？)。

您对 format 的调用将如下所示:

IFormatter formatter = new XmlFormatter();
BusinessObjectOne boo = new BusinessObjectOne(...);

// With visitor like double dispatch
String xml = boo.Format(formatter);

// Without 
String xml = formatter.FormatBusinessObjectOne(boo);

// With overloading
String xml = formatter.Format(boo);