如何使用MonoXSD / xsd.exe使用xsd文件生成C#类？

文章目录

引言
什么是MonoXSD/xsd.exe
如何使用
xsd.exe的参数解析

引言

之前写了这两篇，对OpenDRIVE文件的读写有了一点认识。

【C#】读写XML文件总结
OpenDRIVE——如何高效查阅元素和属性

但我也会思考一个问题，如何检测我读入的文件是否符合OpenDRIVE的规范呢？

这天，我看到了LGSVL Simulator的源码，它可以实现OpenDRIVE1.4地图的读写。我好奇地看了看它是如何读写OpenDIRVE的：使用的果然是Deserialize函数和Serialize函数（可查看【C#】读写XML文件总结）！

但是它的OpenDRIVE类比我之前看到的要复杂很多，最上方的注释，解释了这个玄机：

//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by a tool.
// Runtime Version:4.0.30319.42000
//
// Changes to this file may cause incorrect behavior and will be lost if
// the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------
//
//This source code was auto-generated by MonoXSD
//

原来OpenDRIVE的类可以由xsd文件自动生成！这样就不用自己费尽心思去考虑类中到底要添加哪些元素和属性了~ 此外，还可以检测到读取的文件是否符合xchema规范、确保写到硬盘中的文件也符合规范，正确性的问题也解决了！

目前OpenDRIVE的官网给出了1.6,1.5,1.4的规范说明，而1.6和1.4并不兼容，所以我们的OpenDRIVE读写器必须同时兼容以上3个版本，这样的话我们就需要分别根据它们的xsd文件生成对应的类了~

什么是MonoXSD/xsd.exe

微软的.NET官方文档中介绍了XML架构定义工具（Xsd.exe）。它可以从XDR，XML和XSD文件或运行时程序集中的类生成XML架构或公共语言运行时的类。

XML架构定义工具（Xsd.exe）通常可以在以下路径中找到：

C：\ Program Files（x86）\ Microsoft SDKs \ Windows \ {version} \ bin \ NETFX {version} Tools \

如何使用

微软的官方文档 How to: Use the XML Schema Definition Tool to Generate Classes and XML Schema Documents 中介绍了给工具的用法。

我举个例子：把OpenDRIVE V1.6的xsd文件转成对应的类：

导航到需要转换的xsd文件所在的目录

在地址栏中输入cmd，在此位置打开一个命令行工具
在C：\ Program Files（x86）\ Microsoft SDKs \ Windows \ {version} \ bin \ NETFX {version} Tools \目录下找到xsd.exe，并拷贝到xsd文件所在目录。
输入以下命令，即可生成.cs文件：
```
xsd /classes /language:CS opendrive_16_core.xsd
```
为什么只需要转换core.xsd，不需要管其他文件呢？因为core.xsd中已经Include了其他文件。

我也检查过导出的.cs文件，已经包含了道路、交叉口等的元素。

xsd.exe的参数解析

输入以下命令，即可查看到帮助。也可以在官网XML架构定义工具（Xsd.exe）中看到具体的参数解释。

xsd /?

帮助内容如下：

xsd.exe -Utility to generate schema or class files from given source.//【1】xsd.exe可以处理4种文件类型
//.xsd文件
//写完文件名后，必须写 /classes或/dataset
//可以写/e:等参数，也可以不写
xsd.exe <schema>.xsd /classes|dataset [/e:] [/l:] [/n:] [/o:] [/s] [/uri:]
//.dll或.exe文件
xsd.exe <assembly>.dll|.exe [/outputdir:] [/type: [...]]
//.xml文件
xsd.exe <instance>.xml [/outputdir:]
//.xdr文件
xsd.exe <schema>.xdr [/outputdir:]- OPTIONS -
//写/classes的意思是，为xsd文件生成类。可以简写为 /c
/classesGenerate classes for this schema. Short form is '/c'./datasetGenerate sub-classed DataSet for this schema. Short form is '/d'./enableLinqDataSetGenerate LINQ-enabled sub-classed Dataset for the schemas provided.  Short form is '/eld'./element:<element>Element from schema to process. Short form is '/e:'./fieldsGenerate fields instead of properties. Short form is '/f'./orderGenerate explicit order identifiers on all particle members./enableDataBindingImplement INotifyPropertyChanged interface on all generated typesto enable data binding. Short form is '/edb'.//写/language可以指定生成代码的语言，默认是CS。可以简写为/l:，冒号后面的值可以写CS、VB等。
/language:<language>The language to use for the generated code. Choose from 'CS', 'VB', 'JS','VJS', 'CPP' or provide a fully-qualified name for a class implementingSystem.CodeDom.Compiler.CodeDomProvider. The default languageis 'CS' (CSharp). Short form is '/l:'./namespace:<namespace>The namespace for generated class files. The default namespaceis the global namespace. Short form is '/n:'./nologoSuppresses the banner./out:<directoryName>The output directory to create files in. The defaultis the current directory. Short form is '/o:'./type:<type>Type from assembly to generate schema for. Multiple types may be provided.If no types are provided, then schemas for all types in an assemblyare generated. Short form is '/t:'./uri:<uri>Uri of elements from schema to process. Short form is '/u:'.- ADVANCED -/parameters:<file>Read command-line options from the specified xml file. Short form is '/p:'.- ARGUMENTS -
<schema>.xsd       Name of a schema containing elements to import.
<assembly>.dll|exe Name of an assembly containing types to generate schema for.
<instance>.xml     Name of an xml file to infer xsd schema from.
<schema>.xdr       Name of an xdr schema to convert to xsd.
Multiple file arguments of the same type may be provided.