c# - 控制名称格式的 XSD 到 C# 类

Question

我正在处理一个 XSD 文件，该文件将大写字母用于元素名称和不一致的属性名称大小写。不幸的是，这无法更正，因为符合此模式的 XML 文件由硬编码为期望这些约定的程序读取和写入。

我正在使用 Visual Studio 2013 的 xsd.exe 工具将 XSD 文件转换为模型类，但是 XSD 逐字复制元素和类型名称并且仅应用 [XmlElement ] 或 [XmlAttribute] 属性，当名称在 C# 中不合法时(例如当名称包含破折号字符时)。

给定这个 XML 文件:

<someIndustrialData>
    <FOOBAR name="foo" baz="BAR">
        <CHILDELEMENTS>
            <FOOBARCHILDELEMENT QUX="FOO">


            </FOOBARCHILDELEMENT>
            <FOOBARCHILDELEMENT qux="foo">

            </FOOBARCHILDELEMENT>
        </CHILDELEMENTS>
    </FOOBAR>
</someIndustrialData>

因此，我有 xsd.exe 生成的输出，如下所示:

public partial class FOOBAR {
    public FOOBARCHILDELEMENT[] CHILDELEMENTS { get; set; }
}
public partial class FOOBARCHILDELEMENT {
    public String QUX { get; set; }
    public String qux { get; set; }
}

我不喜欢这个。

如果 xsd.exe 会生成以下输出，我会更喜欢它:

[XmlElement("FOOBAR")]
public partial class FooBar {

    [XmlElement("CHILDELEMENTS")]
    public FooBarChild[] Children { get; set; }
}

[XmlElement("FOOBARCHILDELEMENT ")]
public partial class FooBarChild {

    [XmlAttribute("QUX")
    private String QUX { get; set; }

    [XmlAttribute("qux")
    private String qux { get; set; }

    public String Qux { get { return this.QUX ?? this.qux; } }
}

即:

• 生成的 POCO 类型的名称及其成员符合 .NET 编码约定(PascalCase 实例成员而不是 UPPERCASE)

• 生成的 POCO 类型应该应用 XmlElement 和 XmlAttribute 属性，这样 XmlSerializer 类就可以将它们映射到 XML 元素，而无需始终使用 POCO 类型名称。

这可能吗？

Answer 1

这可能不是您正在寻找的答案，但我建议您接受难看的大写约定，因为它最能反射(reflect)您服务的实际界面。为什么允许盲目地致力于 .NET 编码约定现在为您创建额外的非功能性工作并在以后为您增加额外的支持负担？

如果您的团队的纯粹主义者的敏感性被这些公认的丑陋名称冒犯了，请考虑更有效地利用其开发时间可能是构建适合您的领域的非界面绑定(bind)模型。 直接针对接口(interface)模型进行编码对于大型项目而言并不理想。如果您的项目快速而肮脏或规模较小，则坏名称无论如何也不会传播很远。如果您的项目很大，允许错误的名称准确反射(reflect)真实的接口(interface)名称，并构建单独的、非接口(interface)绑定(bind)的、基于域的类，以提供更好的编码模型(其次可以遵循您喜欢的命名约定) .

如果您拥有或即将拥有额外的接口(interface)来支持(其他 XML 模式、JSON 等)，从长远来看，让基于域的代码与域对象而不是接口(interface)对象相比，将比坚持 .NET 提供更大的好处接口(interface)类中的命名约定。