打开 VS.NET 2017 或更高版本
创建一个示例 VS.NET (.NET Framework 4.x / .NET Core 2.x) 控制台应用程序项目
通过 Nuget 命令使用程序包管理器控制台安装 ChoETL
- Install-Package ChoETL
- Install-Package ChoETL.NETStandard
使用 ChoETL 命名空间

让我们从一个读取包含两列的简单 XML 文件的示例开始。

清单 3.1 示例 XML 数据文件

<Employees>
    <Employee Id='1'>
        <Name>Tom</Name>
    </Employee>
    <Employee Id='2'>
        <Name>Mark</Name>
    </Employee>
</Employees>

您可以通过多种方式以最少的设置开始解析 XML 文件。

3.1. 快速加载 - 数据优先方法

这是 零配置、快速加载 XML 文件的方式。无需 POCO 对象。下面的示例代码展示了如何加载文件。

清单 3.1.1 使用迭代器加载 XML 文件

foreach (dynamic rec in new ChoXmlReader("emp.xml"))
{
    Console.WriteLine(rec.Id);
    Console.WriteLine(rec.Name);
}

示例 Fiddle：https://dotnetfiddle.net/X4nJO9

清单 3.1.2 使用循环加载 XML 文件

var reader = new ChoXmlReader("emp.xml");
dynamic rec;
 
while ((rec = reader.Read()) != null)
{
    Console.WriteLine(rec.Id);
    Console.WriteLine(rec.Name);
}

示例 Fiddle：https://dotnetfiddle.net/bm47gw

3.2. 代码优先方法

这是另一种 零配置 的方式，使用 POCO 类解析和加载 XML 文件。首先，定义一个简单的数据类来匹配底层的 XML 文件布局。

图 3.2.1 简单的 POCO 实体类

public partial class EmployeeRec
{
    public int Id { get; set; }
    public string Name { get; set; } 
}

上面，该类定义了两个与示例 XML 文件模板匹配的属性。

清单 3.2.2 加载 XML 文件

foreach (var e in new ChoXmlReader<EmployeeRec>("emp.xml"))
{
    Console.WriteLine(e.Id);
    Console.WriteLine(e.Name);
}

示例 Fiddle：https://dotnetfiddle.net/C2B7KO

3.3. 配置优先方法

在此模型中，我们使用所有必要的解析参数以及与底层 XML 文件匹配的 XML 列来定义 XML 配置。

清单 3.3.1 定义 XML 配置

ChoXmlRecordConfiguration config = new ChoXmlRecordConfiguration();
config.XmlRecordFieldConfigurations.Add(new ChoXmlRecordFieldConfiguration("Id"));
config.XmlRecordFieldConfigurations.Add(new ChoXmlRecordFieldConfiguration("Name"));

上面，该类定义了两个与示例 XML 文件模板匹配的属性。

清单 3.3.2 不带 POCO 对象加载 XML 文件

foreach (dynamic e in new ChoXmlReader("emp.xml", config))
{
    Console.WriteLine(e.Id);
    Console.WriteLine(e.Name);
}

示例 Fiddle：https://dotnetfiddle.net/hHbVLP

清单 3.3.3 带 POCO 对象加载 XML 文件

foreach (var e in new ChoXmlReader<EmployeeRec>("emp.xml", config))
{
    Console.WriteLine(e.Id);
    Console.WriteLine(e.Name);
}

示例 Fiddle：https://dotnetfiddle.net/U3QO5e

3.4. 代码优先声明式配置

这是将 POCO 实体类与 XML 配置参数声明式结合的方法。Id 是必需的列，Name 是可选的值列，默认值为“XXXX”。如果 Name 不存在，则使用默认值。这是 OptIn 方法，仅指示被装饰的成员参与序列化操作。任何未用 ChoXmlNodeRecordFieldAttribute 装饰的成员都将被忽略。

清单 3.4.1 定义 POCO 对象

public class EmployeeRec
{
    [ChoXmlNodeRecordField(XPath = "//@Id")]
    [Required]
    public int Id
    {
        get;
        set;
    }
    [ChoXmlNodeRecordField(XPath = "//Name")]
    [DefaultValue("XXXX")]
    public string Name
    {
        get;
        set;
    }
 
    public override string ToString()
    {
        return "{0}. {1}".FormatString(Id, Name);
    }
}

上面的代码说明了如何定义 POCO 对象来承载输入文件中每条记录行的值。首先，为每个记录字段定义一个带有 ChoXmlNodeRecordFieldAttribute 的属性，以符合 XML 记录映射的资格。XPath 是一个可选属性。如果未指定，框架会自动发现并加载 xmlattribute 或 xmlelement 的值。Id 被装饰了 RequiredAttribute，如果值缺失，将引发异常。Name 使用 DefaultValueAttribute 指定了默认值。这意味着如果文件中的 Name XML 列包含空值，它将被默认为“XXXX”值。

它非常简单，并且可以立即提取 XML 数据。

清单 3.4.2 主方法

foreach (var e in new ChoXmlReader<EmployeeRec>("emp.xml"))
{
    Console.WriteLine(e.Id);
    Console.WriteLine(e.Name);
}

我们开始创建一个 ChoXmlReader 对象的新实例。就是这样！解析器在后台完成了解析和将 XML 数据流加载到对象中的所有繁重工作。

默认情况下，ChoXmlReader 在加载 XML 文件时会发现并使用默认配置参数。这些可以根据您的需要进行覆盖。以下部分将详细介绍每个配置属性。

示例 Fiddle：https://dotnetfiddle.net/lnO6ft

3.4.1. 使用 BCL 序列化属性

这是另一种方法，使用 BCL 序列化属性（即 XmlElementAttribute, XmlAttributeAttribute 等）来装饰 POCO 对象的成员。

清单 3.4.1.1 定义 POCO 对象

public class EmployeeRec
{
    [XmlAttribute]
    [Required]
    [ChoXPath("@Id")]   //Optional
    public int Id
    {
        get;
        set;
    }
    [XmlElement]
    [DefaultValue("XXXX")]
    public string Name
    {
        get;
        set;
    }
 
    public override string ToString()
    {
        return "{0}. {1}".FormatString(Id, Name);
    }
}

上面的代码说明了如何定义 POCO 对象来承载输入文件中每条记录行的值。首先，为每个记录字段定义一个带有 XAttributeAttribute / XElementAttribute 的属性，以指定要映射到的节点类型。使用这些属性是可选的。如果未指定，框架会自动发现并适当地加载成员。ChoXPath 是一个可选属性，用于指定要加载的节点的 xpath。Id 被装饰了 RequiredAttribute，如果值缺失，将引发异常。Name 使用 DefaultValueAttribute 指定了默认值。这意味着如果文件中的 Name XML 列包含空值，它将被默认为“XXXX”值。

它非常简单，并且可以立即提取 XML 数据。

清单 3.4.1.2 主方法

foreach (var e in new ChoXmlReader<EmployeeRec>("emp.xml"))
{
    Console.WriteLine(e.Id);
    Console.WriteLine(e.Name);
}

我们开始创建一个 ChoXmlReader 对象的新实例。就是这样。解析器在后台完成了解析和将 XML 数据流加载到对象中的所有繁重工作。

默认情况下，ChoXmlReader 在加载 XML 文件时会发现并使用默认配置参数。这些可以根据您的需要进行覆盖。以下部分将详细介绍每个配置属性。

4. 读取所有记录

就像设置匹配 XML 文件结构的 POCO 对象一样容易，您可以以枚举模式读取整个文件。这是一个延迟执行模式，但在对其进行任何聚合操作时要小心。这将把整个文件记录加载到内存中。

清单 4.1 读取 XML 文件

foreach (var e in new ChoXmlReader<EmployeeRec>("emp.xml"))
{
    Console.WriteLine(e.Id);
    Console.WriteLine(e.Name);
}

或

清单 4.2 读取 XML 文件流

foreach (var e in new ChoXmlReader<EmployeeRec>(textReader))
{
    Console.WriteLine(e.Id);
    Console.WriteLine(e.Name);
}

此模型使您的代码优雅、简洁、易于阅读和维护。还可以利用 LINQ 扩展方法执行分组、连接、投影、聚合等操作。

清单 4.3 使用 LINQ

var list = (from o in new ChoXmlReader<EmployeeRec>("emp.xml")
           where o.Name != null && o.Name.StartsWith("R")
           select o).ToArray();
 
foreach (var e in list)
{
    Console.WriteLine(e.Id);
    Console.WriteLine(e.Name);
}

5. 手动读取记录

就像设置匹配 XML 文件结构的 POCO 对象一样容易，您可以以枚举模式读取整个文件。

清单 5.1 读取 XML 文件

var reader = new ChoXmlReader<EmployeeRec>("emp.xml");
EmployeeRec rec = null;
 
while ((rec = reader.Read()) != null)
{
    Console.WriteLine(rec.Id);
    Console.WriteLine(rec.Name);
}

示例 Fiddle：https://dotnetfiddle.net/BYK1n4

6. 自定义 XML 记录

使用 ChoXmlRecordObjectAttribute，您可以声明式地自定义 POCO 实体对象。

图 6.1 为每条记录自定义 POCO 对象

[ChoXmlRecordObject]
public class EmployeeRec
{
    [ChoXmlNodeRecordField(XPath = "/@Id")] 
    public int Id { get; set; }
    [ChoXmlNodeRecordField(XPath = "/Name")] 
    [Required]
    [DefaultValue("ZZZ")]
    public string Name { get; set; }
}

以下是用于执行文件上 XML 加载操作自定义的可用属性：

XPath - 可选。XPath 表达式用于选择要加载的元素。如果未指定，将自动发现并加载成员值。
ColumnCountStrict - 此标志指示在读取预期字段丢失时是否应抛出异常。
ErrorMode - 此标志指示在读取时是否应抛出异常，并且预期的字段加载失败。这可以每隔属性覆盖。可能的值是
- IgnoreAndContinue - 忽略错误，记录将被跳过并继续处理下一条。
- ReportAndContinue - 如果 POCO 实体是 IChoNotifyRecordRead 类型，则向其报告错误
- ThrowAndStop - 抛出错误并停止执行
IgnoreFieldValueMode - 一个标志，告知读取器在读取时是否应跳过空/null 的记录。这可以每隔属性覆盖。可能的值是
- Null - N/A
- DBNull - N/A
- Empty - 如果记录值为空，则跳过
- WhiteSpace - 如果记录值仅包含空格，则跳过
ObjectValidationMode - 一个标志，告知读取器关于记录对象要执行的验证类型。可能的值是
- Off - 不执行对象验证。(默认)
- MemberLevel - 在加载每个 XML 属性并赋予值时执行验证。
- ObjectLevel - 在所有属性都加载到 POCO 对象后执行验证。

7. 自定义 XML 字段

对于每个 XML 列，您可以使用 ChoXmlNodeRecordFieldAttribute 在 POCO 实体属性中指定映射。只有当您想使用自定义 xpath 映射到此列时才使用此属性。否则，请使用简单的变体属性，即 ChoXmlElementRecordFieldAttribute/ChoXmlAttributeRecordFieldAttribute。

清单 7.1 自定义 POCO 对象以匹配 XML 列

public class EmployeeRec
{
    [ChoXmlNodeRecordField(XPath="/@Id")]
    public int Id { get; set; }
    [ChoXmlNodeRecordField(XPath="/Name")]
    [Required]
    [DefaultValue("ZZZ")]
    public string Name { get; set; }
}

以下是您可以为每个属性添加自定义的可用成员

XPath - 可选。XPath 表达式使用路径表示法，类似于 URL 中使用的表示法，用于定位 XML 文档的各个部分。如果未指定，ChoXmlReader 会自动发现并从 XmlElement 或 XmlAttribute 加载值。如果未指定，ChoXmlReader 会自动发现并从与字段名匹配的 XElement 或 XAttribute 加载值。
ErrorMode - 此标志指示在读取时是否应抛出异常，并且预期的字段加载失败。可能的值是
- IgnoreAndContinue - 忽略错误，继续加载记录的其他属性。
- ReportAndContinue - 如果 POCO 实体是 IChoRecord 类型，则向其报告错误。
- ThrowAndStop - 抛出错误并停止执行。
IgnoreFieldValueMode - 一个标志，告知读取器在读取时是否应跳过空/null 的记录。可能的值是
- Null - N/A
- DBNull - N/A
- Empty - 如果记录值为空，则跳过。
- WhiteSpace - 如果记录值仅包含空格，则跳过。

7.1. 默认值

当 XML 值为空或仅包含空格时（通过 IgnoreFieldValueMode 控制），使用的值将被设置到属性。

可以使用 System.ComponentModel.DefaultValueAttribute 为任何 POCO 实体属性指定默认值。

7.2. 后备值

当 XML 值未能设置时使用的值。Fallback 值仅在 ErrorMode 为 IgnoreAndContinue 或 ReportAndContinue 时设置。

可以使用 ChoETL.ChoFallbackValueAttribute 为任何 POCO 实体属性指定回退值。

7.3. 类型转换器

大多数基本类型都会自动转换并设置到属性。如果 XML 字段的值无法自动转换为属性的类型，您可以指定自定义/内置 .NET 转换器来转换该值。这些可以是 IValueConverter 或 TypeConverter 转换器。

有几种方法可以为每个字段指定转换器

声明式方法
配置方法

7.3.1. 声明式方法

此模型适用于 POCO 实体对象。如果您有 POCO 类，您可以为每个属性指定转换器以进行必要的转换。下面的示例展示了如何操作。

图 7.3.1.1 指定类型转换器

public class EmployeeRec
{
    [ChoXmlNodeRecordField(XPath: "/@Id")]
    [ChoTypeConverter(typeof(IntConverter))]
    public int Id { get; set; }
    [ChoXmlNodeRecordField(XPath: "/Name")]
    [Required]
    [DefaultValue("ZZZ")]
    public string Name { get; set; }
}

图 7.3.1.2 IntConverter 实现

public class IntConverter : IValueConverter
{
    public object Convert(object value, Type targetType, 
                          object parameter, CultureInfo culture)
    {
        return value;
    }
 
    public object ConvertBack(object value, Type targetType, 
                              object parameter, CultureInfo culture)
    {
        return value;
    }
}

在上面的示例中，我们定义了一个自定义的 IntConverter 类。并展示了如何使用它来处理“Id”XML 属性。

7.3.2. 配置式方法

此模型适用于动态和 POCO 实体对象。这使得可以在运行时将转换器附加到每个属性。这优先于 POCO 类上的声明式转换器。

清单 7.3.2.2 指定类型转换器

ChoXmlRecordConfiguration config = new ChoXmlRecordConfiguration();

ChoXmlNodeRecordFieldConfiguration idConfig = 
      new ChoXmlNodeRecordFieldConfiguration("Id", XPath: "/@Id");
idConfig.AddConverter(new IntConverter());
config.XmlRecordFieldConfigurations.Add(idConfig);

config.XmlRecordFieldConfigurations.Add
       (new ChoXmlNodeRecordFieldConfiguration("Name", XPath: "/Name"));
config.XmlRecordFieldConfigurations.Add
       (new ChoXmlNodeRecordFieldConfiguration("Name1", XPath: "/Name1"));

在上面，我们使用 ChoXmlNodeRecordFieldConfiguration 对象中的 AddConverter 辅助方法来构建和附加 IntConverter 到“Id”字段。

同样，如果您想从中删除任何转换器，可以在 ChoXmlNodeRecordFieldConfiguration 对象上使用 RemoveConverter。

7.4. 验证

ChoXmlReader 利用 System.ComponentModel.DataAnnotations 和 Validation Block 验证属性来为 POCO 实体的各个字段指定验证规则。有关可用的 DataAnnotations 验证属性列表，请参阅 MSDN 网站。

图 7.4.1 在 POCO 实体中使用验证属性

[ChoXmlRecordObject]
public partial class EmployeeRec
{
    [ChoXmlNodeRecordField(FieldName = "id", XPath: "/@Id")]
    [ChoTypeConverter(typeof(IntConverter))]
    [Range(1, int.MaxValue, ErrorMessage = "Id must be > 0.")]
    [ChoFallbackValue(1)]
    public int Id { get; set; }
 
    [ChoXmlNodeRecordField(FieldName = "Name", XPath: "/Name")]
    [Required]
    [DefaultValue("ZZZ")]
    [ChoFallbackValue("XXX")]
    public string Name { get; set; }
}

在上面的示例中，为 Id 属性使用了 Range 验证属性。为 Name 属性使用了 Required 验证属性。当 Configuration.ObjectValidationMode 设置为 ChoObjectValidationMode.MemberLevel 或 ChoObjectValidationMode.ObjectLevel 时，ChoXmlReader 会在加载期间进行验证。

有时，您可能希望覆盖 POCO 类自带的声明式验证行为，您可以通过 Cinchoo ETL 的配置方法来实现。下面的示例展示了如何覆盖它们。

static void ValidationOverridePOCOTest()
{
    ChoXmlRecordConfiguration config = new ChoXmlRecordConfiguration();
    var idConfig = new ChoXmlNodeRecordFieldConfiguration("Id", XPath: "/@Id");
    idConfig.Validators = new ValidationAttribute[] { new RequiredAttribute() };
    config.XmlRecordFieldConfigurations.Add(idConfig);
    config.XmlRecordFieldConfigurations.Add
      (new ChoXmlNodeRecordFieldConfiguration("Name", XPath: "/Name));
    config.XmlRecordFieldConfigurations.Add
      (new ChoXmlNodeRecordFieldConfiguration("Salary", XPath: "/Salary"));
 
    using (var parser = new ChoXmlReader<EmployeeRecWithCurrency>("emp.xml", config))
    {
        object rec;
        while ((rec = parser.Read()) != null)
        {
            Console.WriteLine(rec.ToStringEx());
        }
    }
}
 
public class EmployeeRecWithCurrency
{
    public int? Id { get; set; }
    public string Name { get; set; }
    public ChoCurrency Salary { get; set; }
}

在某些情况下，您可能希望获得控制权并在 POCO 实体类中执行手动**自验证**。这可以通过继承 POCO 对象并实现 IChoValidatable 接口来实现。

图 7.4.2 在 POCO 实体上手动验证

[ChoXmlRecordObject]
public partial class EmployeeRec : IChoValidatable
{
    [ChoXmlNodeRecordField(FieldName = "id", XPath: "/@Id")]
    [ChoTypeConverter(typeof(IntConverter))]
    [Range(1, int.MaxValue, ErrorMessage = "Id must be > 0.")]
    [ChoFallbackValue(1)]
    public int Id { get; set; }
 
    [ChoXmlNodeRecordField(FieldName = "Name", XPath: "/Name")]
    [Required]
    [DefaultValue("ZZZ")]
    [ChoFallbackValue("XXX")]
    public string Name { get; set; }
 
    public bool TryValidate
    (object target, ICollection<ValidationResult> validationResults)
    {
        return true;
    }
 
    public bool TryValidateFor
    (object target, string memberName, ICollection<ValidationResult> validationResults)
    {
        return true;
    }
 
    public void Validate(object target)
    {
    }
 
    public void ValidateFor(object target, string memberName)
    {
    }
}

上面的示例展示了如何在 POCO 对象中实现自定义自验证。

IChoValidatable 接口公开以下方法

TryValidate - 验证整个对象，如果所有验证都通过则返回 true。否则返回 false。
Validate - 验证整个对象，如果验证未通过则抛出异常。
TryValidateFor - 验证对象的特定属性，如果所有验证都通过则返回 true。否则返回 false。
ValidateFor - 验证对象的特定属性，如果验证未通过则抛出异常。

8. 回调机制

ChoXmlReader 提供开箱即用的行业标准 XML 解析功能，以满足大多数解析需求。如果解析不满足任何需求，您可以使用 ChoXmlReader 提供的回调机制来处理这些情况。为了参与回调机制，您可以使用以下任一模型：

使用 ChoXmlReader 通过 IChoReader 接口公开的事件处理程序。
继承 POCO 实体对象，实现 IChoNotifyRecordRead / IChoNotifyFileRead / IChoNotifyRecordFieldRead 接口
继承 DataAnnotation 的 MetadataType 类型对象，并实现 IChoNotifyRecordRead / IChoNotifyFileRead / IChoNotifyRecordFieldRead 接口。
继承 IChoNotifyRecordFieldConfigurable / IChoNotifyRecordFieldConfigurable 配置接口

注意：从此接口方法抛出的任何异常都将被忽略。

IChoReader 公开了以下事件

BeginLoad - 在 XML 文件加载开始时调用
EndLoad - 在 XML 文件加载结束时调用
BeforeRecordLoad - 在 XML 记录加载之前引发
AfterRecordLoad - 在 XML 记录加载之后引发
RecordLoadError - 在 XML 记录加载出错时引发
BeforeRecordFieldLoad - 在 XML 字段值加载之前引发
AfterRecordFieldLoad - 在 XML 字段值加载之后引发
RecordFieldLoadError - 在 XML 字段值加载出错时引发
SkipUntil - 在 XML 解析开始之前引发，用于添加自定义逻辑以跳过记录行。
DoWhile - 在 XML 解析过程中引发，您可以在其中添加自定义逻辑以停止解析。

IChoNotifyRecordRead 公开了以下方法

BeforeRecordLoad - 在 XML 记录加载之前引发
AfterRecordLoad - 在 XML 记录加载之后引发
RecordLoadError - 在 XML 记录加载出错时引发

IChoNotifyFileRead 公开了以下方法

BeginLoad - 在 XML 文件加载开始时调用
EndLoad - 在 XML 文件加载结束时调用
SkipUntil - 在 XML 解析开始之前引发，用于添加自定义逻辑以跳过记录行。
DoWhile - 在 XML 解析过程中引发，您可以在其中添加自定义逻辑以停止解析。

IChoNotifyRecordFieldRead 公开以下方法

BeforeRecordFieldLoad - 在 XML 字段值加载之前引发
AfterRecordFieldLoad - 在 XML 字段值加载之后引发
RecordFieldLoadError - 在 XML 字段值加载出错时引发

IChoNotifyRecordConfigurable 公开了以下方法：

RecordConfigure - 在 XML 记录配置时引发

IChoNotifyRecordFieldConfigurable 公开了以下方法：

RecondFieldConfigure - 在每个 XML 记录字段配置时引发

8.1. 使用 ChoXmlReader 事件

这是订阅回调事件并处理 XML 文件解析中特殊情况的最直接、最简单的方法。缺点是代码无法像通过使用 POCO 记录对象实现 IChoNotifyRecordRead 那样实现重用。

下面的示例展示了如何使用 BeforeRecordLoad 回调方法来跳过 Id < 100 的节点。

static void IgnoreNodeTest()
{
    using (var parser = new ChoXmlReader("emp.xml"))
    {
        parser.BeforeRecordLoad += (o, e) =>
        {
            if (e.Source != null)
            {
                e.Skip = ((XElement)e.Source).Attribute["Id"].Value < 100;
            }
        };
        foreach (var e in parser)
            Console.WriteLine(e.Dump());
    }
}

同样，您也可以使用 ChoXmlReader 的其他回调方法。

8.2. 实现 IChoNotifyRecordRead 接口

下面的示例展示了如何为直接 POCO 类实现 IChoNotifyRecordRead 接口。

清单 8.2.1 直接 POCO 回调机制实现

[ChoXmlRecordObject]
public partial class EmployeeRec : IChoNotifyRecordRead
{
    [ChoXmlNodeRecordField(FieldName = "Id", XPath: "/@Id")]
    [ChoTypeConverter(typeof(IntConverter))]
    [Range(1, int.MaxValue, ErrorMessage = "Id must be > 0.")]
    [ChoFallbackValue(1)]
    public int Id { get; set; }
    
    [ChoXmlNodeRecordField(FieldName = "Name", XPath: "/Name")]
    [Required]
    [DefaultValue("ZZZ")]
    [ChoFallbackValue("XXX")]
    public string Name { get; set; }
 
    public bool AfterRecordLoad(object target, int index, object source)
    {
        throw new NotImplementedException();
    }
 
    public bool BeforeRecordLoad(object target, int index, ref object source)
    {
        throw new NotImplementedException();
    }
 
    public bool RecordFieldLoadError
    (object target, int index, string propName, object value, Exception ex)
    {
        throw new NotImplementedException();
    }
}

下面的示例展示了如何通过在 POCO 类上使用 MetadataTypeAttribute 来附加 Metadata 类。

清单 8.2.2 基于 MetaDataType 的回调机制实现

[ChoXmlRecordObject]
public class EmployeeRecMeta : IChoNotifyRecordRead
{
    [ChoXmlNodeRecordField(FieldName = "Id", XPath: "/@Id")]
    [ChoTypeConverter(typeof(IntConverter))]
    [Range(1, int.MaxValue, ErrorMessage = "Id must be > 0.")]
    [ChoFallbackValue(1)]
    public int Id { get; set; }

    [ChoXmlNodeRecordField(FieldName = "Name", XPath: "/Name")]
    [Required]
    [DefaultValue("ZZZ")]
    [ChoFallbackValue("XXX")]
    public string Name { get; set; }
 
    public bool AfterRecordLoad(object target, int index, object source)
    {
        throw new NotImplementedException();
    }
 
    public bool BeforeRecordLoad(object target, int index, ref object source)
    {
        throw new NotImplementedException();
    }
 
    public bool RecordFieldLoadError
    (object target, int index, string propName, object value, Exception ex)
    {
        throw new NotImplementedException();
    }
} 

[MetadataType(typeof(EmployeeRecMeta))]
public partial class EmployeeRec
{
    public int Id { get; set; }
    public string Name { get; set; }
}

下面的示例展示了如何通过在 POCO 类上使用 ChoMetaDataRefTypeAttribute 来为密封类或第三方 POCO 类附加 Metadata 类。

清单 8.2.3 基于 ChoMetaDataRefType 的回调机制实现

[ChoMetadataRefType(typeof(EmployeeRec))]
[ChoXmlRecordObject]
public class EmployeeRecMeta : IChoNotifyRecordRead
{
    [ChoXmlNodeRecordField(FieldName = "Id", XPath: "/@Id")]
    [ChoTypeConverter(typeof(IntConverter))]
    [Range(1, int.MaxValue, ErrorMessage = "Id must be > 0.")]
    [ChoFallbackValue(1)]
    public int Id { get; set; }

    [ChoXmlNodeRecordField(FieldName = "Name", XPath: "/Name")]
    [Required]
    [DefaultValue("ZZZ")]
    [ChoFallbackValue("XXX")]
    public string Name { get; set; }
 
    public bool AfterRecordLoad(object target, int index, object source)
    {
        throw new NotImplementedException();
    }
 
    public bool BeforeRecordLoad(object target, int index, ref object source)
    {
        throw new NotImplementedException();
    }
 
    public bool RecordLoadError(object target, int index, object source, Exception ex)
    {
        throw new NotImplementedException();
    }
} 

public partial class EmployeeRec
{
    public int Id { get; set; }    
    public string Name { get; set; }
}

8.3. BeginLoad

此回调在 XML 文件加载的开始时调用一次。source 是 XML 文件流对象。在这里，您可以检查流，返回 true 继续 XML 加载。返回 false 停止解析。

清单 10.3.1 BeginLoad 回调示例

public bool BeginLoad(object source)
{
    StreamReader sr = source as StreamReader;
    return true;
}

8.4. EndLoad

此回调在 XML 文件加载的结束时调用一次。source 是 XML 文件流对象。在这里，您可以检查流，执行任何要在流上执行的后续步骤。

清单 8.4.1 EndLoad 回调示例

public void EndLoad(object source)
{
    StreamReader sr = source as StreamReader;
}

8.5. BeforeRecordLoad

此回调在 XML 文件中的每个记录行加载之前调用。target 是 POCO 记录对象的实例。index 是文件中的行索引。source 是 XML 记录行。在这里，您可以检查该行，并根据需要用新行覆盖它。

提示：如果您想跳过 XNode 的加载，请将 source 设置为 null。

提示：如果您想自己控制解析和加载记录属性，请将 source 设置为 String.Empty。