记录DTO对象的不完整对象图

时间:2011-02-03 23:19:28

标签: wcf documentation dto xml-documentation object-graph

当前体系结构基于WCF服务,该服务从DB填充DTO对象并将其返回。

有些方法返回完整的对象图,有些只返回部分。如果完全填充,一些对象图将非常大 - 因此这不是所有情况的选项。

如何记录DTO对象的哪些属性已填充,哪些不是?这是一个.NET商店,XML注释没有提供足够的灵活性来记录不常用的属性。其他人如何应对这一挑战?

Ex:对于客户端,Invoice对象是相同的,无论是否填充了所有属性。

提出的一个想法是为仅具有填充属性的对象生成XSD架构。虽然技术上是正确的,但这似乎不是一个“好的/可用的”文档。

编辑:我发现UML可能是比XSD更好的选择,因为它更具可读性。有没有快速的方法从XML - > XSD - > UML(或其他图表范例)?

1 个答案:

答案 0 :(得分:2)

在我们的一个系统中,我们实际上使用了两个模型:一个是内部的,它们都已完成并成熟,另一个用于服务,如我们的系统和外部各方之间的合同。我们创建了自动生成的映射器和填充器。这使我们有可能在不破坏外部系统数据合同的情况下改变对象模型的内部表示和结构。