XSD 工具在 .NET8 中 – 第7部分 – LinqToXsdCore - 简单
.NET8 环境中可用的 XSD 工具实用指南。
1 在 .NET8 中进行 XML 和 XSD 相关工作
我最近在 .NET8 环境中进行了一些与 XML 和 XSD 处理相关的工作，并创建了几个 概念验证 应用程序来评估可用的工具。这些文章是我原型工作的结果。
1.1 使用/测试的工具列表
以下是使用/测试的工具
- Visual Studio 2022
- XSD.EXE（微软许可，VS2022 的一部分）
- XmlSchemaClassGenerator (开源/免费软件)
- LinqToXsdCore (开源/免费软件)
- Liquid XML Objects (商业许可)
1.2 本系列文章
由于技术原因，我将把这篇文章组织成几篇文章
- .NET8 中的 XSD 工具 – 第 1 部分 – VS2022
- .NET8 中的 XSD 工具 – 第 2 部分 – C# 验证
- .NET8 中的 XSD 工具 – 第 3 部分 – XsdExe – 简单
- .NET8 中的 XSD 工具 – 第 4 部分 – XsdExe - 高级
- .NET8 中的 XSD 工具 – 第 5 部分 – XmlSchemaClassGenerator – 简单
- .NET8 中的 XSD 工具 – 第 6 部分 – XmlSchemaClassGenerator – 高级
- .NET8 中的 XSD 工具 – 第 7 部分 – LinqToXsdCore – 简单
- .NET8 中的 XSD 工具 – 第 8 部分 – LinqToXsdCore – 高级
- .NET8 中的 XSD 工具 – 第 9 部分 – LiquidXMLObjects – 简单
- .NET8 中的 XSD 工具 – 第 10 部分 – LiquidXMLObjects – 高级
2 更多关于 XML 和 XSD 规则的理论
这里有更多关于 XML 和 XSD 规则的理论。
2.1 可选的 Xml-Element 和 Xml-Attribute
可选：XML 中不需要存在。
对于 XSD Schema 元素
可选：minOccurs="0" 属性 ->要将 Schema 元素设置为可选，请包含 minOccurs="0" 属性。
3 XML 和 XSD 的示例
以下是我为测试目的创建的一些示例 XML 和 XSD。
3.1 简单情况
请注意，此示例 XML/XSD 包含一个 可选的 Xml-Element。有关更多详细信息，请阅读其中的注释。
<?xml version="1.0" encoding="utf-8"?>
<!--SmallCompany.xsd++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-->
<xs:schema attributeFormDefault="unqualified"
elementFormDefault="qualified"
targetNamespace="https://markpelf.com/SmallCompany.xsd"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="SmallCompany">
<xs:complexType>
<xs:sequence>
<xs:element name="CompanyName" type="xs:string" />
<xs:element maxOccurs="unbounded" name="Employee">
<xs:complexType>
<xs:sequence>
<!--Name_String_NO is String NotOptional-->
<xs:element name="Name_String_NO" type="xs:string" />
<!--City_String_O is String Optional-->
<xs:element minOccurs="0" name="City_String_O" type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element maxOccurs="unbounded" name="InfoData">
<xs:complexType>
<xs:sequence>
<!--Id_Int_NO is Int NotOptional-->
<xs:element name="Id_Int_NO" type="xs:int" />
<!--Quantity_Int_O is Int Optional-->
<xs:element minOccurs="0" name="Quantity_Int_O" type="xs:int" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
<?xml version="1.0" encoding="utf-8"?>
<!--SmallCompanyAAA.xml+++++++++++++++++++++++++++++++++++++++++++++++-->
<SmallCompany xmlns="https://markpelf.com/SmallCompany.xsd">
<CompanyName>SmallCompanyAAA</CompanyName>
<Employee>
<Name_String_NO>Mark</Name_String_NO>
<City_String_O>Belgrade</City_String_O>
</Employee>
<Employee>
<Name_String_NO>John</Name_String_NO>
</Employee>
<InfoData>
<Id_Int_NO>11</Id_Int_NO>
<Quantity_Int_O>123</Quantity_Int_O>
</InfoData>
<InfoData>
<Id_Int_NO>22</Id_Int_NO>
</InfoData>
</SmallCompany>
4 使用 LinqToXsdCore 工具创建 C# 类
本文重点介绍使用 LinqToXsdCore 工具从 XSD 文件生成 C# 类。
以下是该工具的基本信息。
Tool name: ============================
XSD LinqToXsdCore
License============================
Open Source/Freeware
Where to get it============================
It is NuGet package of type DotnetTool. You need to install it in a special way.
Install Instructions====================================
Create somewhere directory Tool>
I had some additional custom sources. Just using --ignore-failed-sources wasn't enough. I went into Visual Studio -> Tools -> Options -> NuGet Package Manager -> Package Sources and unchecked the extra package sources so only nuget.org and Microsoft Visual Studio Offline Packages was left checked. After doing that I was able to install the tool , and then I re-enabled my custom package sources.
PowerShell, as Administrator
> dotnet new tool-manifest
> dotnet tool install LinqToXsdCore --ignore-failed-sources
You can invoke the tool from this directory using the following commands: 'dotnet tool run LinqToXsd' or 'dotnet LinqToXsd'.
Tool 'linqtoxsdcore' (version '3.4.7') was successfully installed. Entry is added to the manifest file _________\Tool\.config\dotnet-tools.json.
Version============================
Windows PowerShell > ./LinqToXsd.exe
LinqToXsd 3.4.7
Copyright (C) Muhammad Miftah, GitHub Contributors (2019-2022) & Microsoft Corporation (2008-2011)
Help============================
Windows PowerShell > ./LinqToXsd.exe gen
LinqToXsd 3.4.7
Copyright (C) Muhammad Miftah, GitHub Contributors (2019-2022) & Microsoft Corporation (2008-2011)
ERROR(S):
A required value not bound to option name is missing.
-c, --Config (string) Specify the file or folder path to one or more configuration file(s).
Multiple configuration files are merged as one. Incompatible with -AutoConfig
-e, --EnableServiceReference (bool) Imports the 'System.Xml.Serialization' namespace into the generated code.
-a, --AutoConfig (bool) Specify this with a folder containing XSDs and accompanying configuration
files. This argument associate a configuration file with an XSD when one follows the
naming convention: 'schema.xsd' + 'schema.xsd.config' - this is the default convention
used by the 'config -e' verb when you specify a folder. Use this parameter to
associate an XSD with its own configuration settings to prevent those settings being
overriden or merged as the -Config argument would do. Only accepts folder paths.
Incompatible with -Config. Will only generate code for XSDs that have an accompanying
.config file. If no output is generated, run the 'config' verb on the folder first.
-o, --Output (string) Output file name or folder. When specifying multiple input XSDs or input
folders, and this value is a file, all output is merged into a single file. If this
value is a folder, multiple output files are output to this folder.
--help Display this help screen.
--version Display version information.
value pos. 1 Required. (string[]) One or more schema files or folders containing schema files.
Separate multiple files using a comma (,). If folders are given, then the files
referenced in xs:include or xs:import directives are not imported twice. Usage:
'LinqToXsd [verb] <file1.xsd>,<file2.xsd>' or 'LinqToXsd [verb] <folder1>,<folder2>'.
You can also include folder and file paths in the same invocation: 'LinqToXsd [verb]
<file1.xsd>,<folder1>'
====================================================
Usage Examples===================
Instructions to generate C# class
Windows PowerShell > dotnet LinqToXsd gen SmallCompany.xsd
Windows PowerShell > dotnet LinqToXsd gen BigCompany.xsd
====================================
5 生成的 C# 类
这是上述工具根据上面提供的 XSD SmallCompany.xsd 生成的 C# 代码。
该工具生成的类的完整代码很长（780 行），因此我将在此仅展示文件开头部分。
//SmallCompany_ver3_3.cs, 780 lines
//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by a tool.
//
// Changes to this file may cause incorrect behavior and will be lost if
// the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------
namespace https.markpelf.com.SmallCompany.xsd {
using System;
using System.Collections;
using System.Collections.Generic;
using System.ComponentModel;
using System.IO;
using System.Linq;
using System.Diagnostics;
using System.Xml;
using System.Xml.Schema;
using System.Xml.Linq;
using Xml.Schema.Linq;
/// <summary>
/// <para>
/// Regular expression: (CompanyName, Employee+, InfoData+)
/// </para>
/// </summary>
public partial class SmallCompany : XTypedElement, IXMetaData {
public void Save(string xmlFile) {
XTypedServices.Save(xmlFile, Untyped);
}
public void Save(System.IO.TextWriter tw) {
XTypedServices.Save(tw, Untyped);
}
public void Save(System.Xml.XmlWriter xmlWriter) {
XTypedServices.Save(xmlWriter, Untyped);
}
public static SmallCompany Load(string xmlFile) {
return XTypedServices.Load<SmallCompany>(xmlFile);
}
public static SmallCompany Load(System.IO.TextReader xmlFile) {
return XTypedServices.Load<SmallCompany>(xmlFile);
}
public static SmallCompany Parse(string xml) {
return XTypedServices.Parse<SmallCompany>(xml);
}
public static explicit operator SmallCompany(XElement xe) { return XTypedServices.ToXTypedElement<SmallCompany>(xe,LinqToXsdTypeManager.Instance as ILinqToXsdTypeManager); }
public override XTypedElement Clone() {
return XTypedServices.CloneXTypedElement<SmallCompany>(this);
}
/// <summary>
/// <para>
/// Regular expression: (CompanyName, Employee+, InfoData+)
/// </para>
/// </summary>
public SmallCompany() {
}
//
// shorten for readibility, full file 780 lines
///
这是类的类图。
生成的类需要安装非常具体的依赖项来支持。
6 可选 Xml-Elements 的两种 C# API 样式
在生成的 C# 代码中，有两种方法/样式可以标记可选 Xml-Element 的存在。
- 第一种是 bool_flag_style – 使用布尔标志来指示可选 Xml-Element 的存在，flag=false 表示 Xml-Element 不存在。
例如，对于某个 Xml-Element ElemA，如果存在，其值为整数，您将在 C# 中生成两个变量：“bool ElemA_flag, int ElemA_value”。您需要先检查标志 ElemA_flag 来确定元素 ElemA 是否存在；然后，如果为 true，再获取 ElemA_value 的值。如果您不先检查标志 ElemA_flag，而直接获取 ElemA_value 的值，可能会获取到零 (0) 的默认 int 值，而您无法区分这是 C# 变量的默认值（该变量始终存在）但 Xml-Element 不存在，还是元素存在且实际值为零 (0)。 - 第二个是 nullable_type_style – 使用可空类型来指示 Xml 元素是否存在，值为 null 表示 Xml 元素不存在。
例如，对于某个 Xml-Element ElemA，如果存在，其值为整数，您将在 C# 中生成一个变量：“int? ElemA_nullableValue”。您需要先检查 ElemA_nullableValue 是否不为 null 来确定元素 ElemA 是否存在；然后，如果不为 null，则表示元素存在，您可以获取 ElemA_nullableValue 的 int 值。
7 示例 C# 应用程序
下面是一个使用上述生成的 C# 类来加载和处理上面提供的 XML SmallCompanyAAA.xml 的 C# 代码示例。
public static void ProcessVer3_Process1(
string? filePath,
Microsoft.Extensions.Logging.ILogger? logger)
{
try
{
logger?.LogInformation(
"+++ProcessVer3_Process1-Start++++++++++++++++++");
logger?.LogInformation("filePath:" + filePath);
TextReader textReader = File.OpenText(filePath ?? String.Empty);
//string xmlFile = textReader.ReadToEnd();
https.markpelf.com.SmallCompany.xsd.SmallCompany xmlObject =
https.markpelf.com.SmallCompany.xsd.SmallCompany.Load(textReader);
if (xmlObject != null)
{
logger?.LogInformation("CompanyName:" + xmlObject.CompanyName);
foreach(https.markpelf.com.SmallCompany.xsd.SmallCompany.EmployeeLocalType item
in xmlObject.Employee)
{
logger?.LogInformation("------------" );
logger?.LogInformation("Name_String_NO:" + item.Name_String_NO);
logger?.LogInformation("City_String_O:" + (item.City_String_O ?? "null") );
}
foreach (https.markpelf.com.SmallCompany.xsd.SmallCompany.InfoDataLocalType item
in xmlObject.InfoData)
{
logger?.LogInformation("------------");
logger?.LogInformation("Id_Int_NO:" + item.Id_Int_NO.ToString());
logger?.LogInformation("Quantity_Int_O:" + (item.Quantity_Int_O?.ToString() ?? "null"));
}
}
else
{
logger?.LogError("xmlObject == null");
}
logger?.LogInformation(
"+++ProcessVer3_Process1-End++++++++++++++++++");
}
catch (Exception ex)
{
string methodName =
$"Type: {System.Reflection.MethodBase.GetCurrentMethod()?.DeclaringType?.FullName}, " +
$"Method: ProcessVer3_Process1; ";
logger?.LogError(ex, methodName);
}
}
这是执行日志。
+++ProcessVer3_Process1-Start++++++++++++++++++
filePath:C:\TmpXSD\XsdExample_Ver3\Example01\bin\Debug\net8.0\XmlFiles\SmallCompanyAAA.xml
CompanyName:SmallCompanyAAA
------------
Name_String_NO:Mark
City_String_O:Belgrade
------------
Name_String_NO:John
City_String_O:null
------------
Id_Int_NO:11
Quantity_Int_O:123
------------
Id_Int_NO:22
Quantity_Int_O:null
+++ProcessVer3_Process1-End++++++++++++++++++
8 分析
该工具使用“nullable_type_style”方法/样式来标记生成的 C# 代码中可选 Xml-Element 的存在。
- Quantity_Int_O – 是 int? 类型，其含义是
a) null - 表示它不存在。
b) int – 存在并有值。
9 结论
该工具 LinqToXsdCore 非常有趣且免费。生成的 C# 类代码很长（包含一些额外的如 Load、Save、Clone 的方法），但在我的测试中运行稳定。它可能对希望使用 **nullable_type_style** API 的用户感兴趣，这通常是处理可选 Xml-Element 的更现代的方法。
有些地方让我对使用该工具有所保留，例如为什么生成的类如此之大。更重要的是关于那些非常具体的依赖库的问题，它们是否得到维护、是否可靠，以及它们是否会与其他 XML 库发生冲突？要回答这些问题，需要在决定是否在生产环境中使用该工具之前，对此工具进行更深入的研究。
10 参考文献
[1] XML 架构
https://w3schools.org.cn/xml/xml_schema.asp
[2] 可选和非必需的区别
https://www.infopathdev.com/blogs/greg/archive/2004/09/16/The-Difference-Between-Optional-and-Not-Required.aspx
[3] nillable 和 minOccurs XSD 元素属性
https://stackoverflow.com/questions/1903062/nillable-and-minoccurs-xsd-element-attributes
[21] .NET8 中的 XSD 工具 – 第 1 部分 – VS2022
https://codeproject.org.cn/Articles/5388391/XSD-Tools-in-NET8-Part1-VS2022
[22] XSD 工具在 .NET8 中 – 第2部分 – C# 验证
https://codeproject.org.cn/Articles/5388393/XSD-Tools-in-NET8-Part2-Csharp-validation
[23] XSD 工具在 .NET8 中 – 第3部分 – XsdExe – 简单
https://codeproject.org.cn/Articles/5388396/XSD-Tools-in-NET8-Part3-XsdExe-Simple
[24] XSD 工具在 .NET8 中 – 第4部分 – XsdExe - 高级
https://codeproject.org.cn/Articles/5388483/XSD-Tools-in-NET8-Part4-XsdExe-Advanced
[25] XSD 工具在 .NET8 中 – 第5部分 – XmlSchemaClassGenerator – 简单
https://codeproject.org.cn/Articles/5388548/XSD-Tools-in-NET8-Part5-XmlSchemaClassGenerator-Si
[26] XSD 工具在 .NET8 中 – 第6部分 – XmlSchemaClassGenerator – 高级
https://codeproject.org.cn/Articles/5388549/XSD-Tools-in-NET8-Part6-XmlSchemaClassGenerator-Ad
[27] XSD 工具在 .NET8 中 – 第7部分 – LinqToXsdCore – 简单
https://codeproject.org.cn/Articles/5388628/XSD-Tools-in-NET8-Part7-LinqToXsdCore-Simple
[28] XSD 工具在 .NET8 中 – 第8部分 – LinqToXsdCore – 高级
https://codeproject.org.cn/Articles/5388629/XSD-Tools-in-NET8-Part8-LinqToXsdCore-Advanced
[29] XSD 工具在 .NET8 中 – 第9部分 – LiquidXMLObjects – 简单
https://codeproject.org.cn/Articles/5388683/XSD-Tools-in-NET8-Part9-LiquidXMLObjects-Simple
[30] XSD 工具在 .NET8 中 – 第10部分 – LiquidXMLObjects – 高级
https://codeproject.org.cn/Articles/5388684/XSD-Tools-in-NET8-Part10-LiquidXMLObjects-Advanced