设计/图形架构师初学者中级 .NET C#

Cinchoo ETL - FixedLength 读取器

Cinchoo

5.00/5 (3投票s)

2017年1月23日

CPOL

29分钟阅读

20883

.NET 的简单固定长度文件读取器

引言
要求
“Hello World！”示例
1. 快速加载 - 数据优先方法
2. 代码优先方法
3. 配置优先方法
4. 带声明式配置的代码优先方法
读取所有记录
手动读取记录
自定义 FixedLength 记录
自定义 FixedLength 头部
自定义 FixedLength 字段
1. 默认值
2. ChoFallbackValue
3. 类型转换器
  1. 声明式方法
  2. 配置方法
4. 验证
回调机制
1. BeginLoad
2. EndLoad
3. BeforeRecordLoad
4. AfterRecordLoad
5. RecordLoadError
6. BeforeRecordFieldLoad
7. AfterRecordFieldLoad
8. RecordLoadFieldError
自定义
AsDataReader 辅助方法
AsDataTable 辅助方法
使用动态对象
1. 默认值
2. ChoFallbackValue
3. 字段类型
4. 类型转换器
5. 验证
使用密封的 POCO 对象
异常
技巧
1. 多行 FixedLength 列值
2. 带单引号的 FixedLength 列值
使用 MetadataType 注解
配置选项
1. 手动配置
2. 自动映射配置
3. 附加 MetadataType 类
LoadText 辅助方法
高级主题 (Advanced Topics)
1. 覆盖转换器格式规范
2. 货币支持
3. 枚举支持
4. 布尔值支持
5. 日期时间支持
Fluent API
1. WithRecordLength
2. WithFirstLineHeader
3. WithField
4. QuoteAllFields
历史

1. 引言

ChoETL 是一个开源的 .NET ETL（抽取、转换和加载）框架。它是一个基于代码的库，用于从多个源抽取数据，进行转换，并将数据加载到您自己的 .NET 环境数据仓库中。您可以很快地将数据加载到数据仓库中。

本文讨论了使用 ChoETL 框架提供的 FixedLengthReader 组件。它是一个简单的实用类，用于从文件/源中抽取 FixedLength 数据。

特点

遵循 FixedLength 标准文件规则。优雅地处理包含逗号和换行符的数据字段。
公开对象的 IEnumarable 列表 - 通常与 LINQ 查询一起用于投影、聚合和过滤等操作
支持延迟读取
支持处理具有特定文化背景的日期、货币和数字格式的文件。
支持不同的字符编码
读取文件时识别各种日期、货币、枚举、布尔值和数字格式
在写入文件时提供对日期、货币、枚举、布尔值、数字格式的精细控制
详细且强大的错误处理，让您能够快速查找和修复问题
缩短您的开发时间

3. “Hello World!” 示例

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

让我们先来看一个简单的例子，读取一个记录长度为 18 个字符、包含 2 列（Id：8 个字符长，Name：10 个字符长）的 FixedLength 文件。

清单 3.1 示例 FixedLength 数据文件（记录长度：18 个字符）

Id      Name      
1       Carl      
2       Mark

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

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

这是快速加载 FixedLength 文件的方法。不需要 POCO 对象。下面的示例代码展示了如何加载文件。

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

static void QuickDynamicLoadTestUsingIterator()
{
    using (var stream = new MemoryStream())
    using (var reader = new StreamReader(stream))
    using (var writer = new StreamWriter(stream))
    {
        writer.WriteLine("Id      Name      ");
        writer.WriteLine("1       Carl      ");
        writer.WriteLine("2       Mark      ");
        writer.Flush();
        stream.Position = 0;
 
        foreach (dynamic row in new ChoFixedLengthReader(reader).WithFirstLineHeader())
        {
            Console.WriteLine(String.Format("Id: {0}", row.Id));
            Console.WriteLine(String.Format("Name: {0}", row.Name));
        }
    }
}

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

static void QuickDynamicLoadTest()
{
    dynamic row = null;
    using (var stream = new MemoryStream())
    using (var reader = new StreamReader(stream))
    using (var writer = new StreamWriter(stream))
    using (var parser = new ChoFixedLengthReader(reader).WithFirstLineHeader())
    {
        writer.WriteLine("Id      Name      ");
        writer.WriteLine("1       Carl      ");
        writer.WriteLine("2       Mark      ");
        writer.Flush();
        stream.Position = 0;
 
        while ((row = parser.Read()) != null)
        {
            Console.WriteLine(String.Format("Id: {0}", row.Id));
            Console.WriteLine(String.Format("Name: {0}", row.Name));
        }
    }
}

此模型使用通用的 FixedLengthReader 对象来解析文件。FixedLengthReader 会自动从第一行自动检测文件布局模式，仅当第一行的列值之间有空格时。如果自动检测导致文件布局模式不正确，您可以通过配置自行指定模式。稍后会讨论。

如果输入源没有头部，FixedLengthReader 会在动态对象模型中自动将列命名为 Column1, Column2 ...。

3.2. 代码优先方法

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

图 3.2.1 简单的 POCO 实体类

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

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

清单 3.2.2 加载 FixedLength 文件

static void CodeFirstApproach()
{
    EmployeeRecSimple row = null;
    using (var stream = new MemoryStream())
    using (var reader = new StreamReader(stream))
    using (var writer = new StreamWriter(stream))
    using (var parser = new ChoFixedLengthReader<EmployeeRecSimple>
          (reader).WithFirstLineHeader())
    {
        writer.WriteLine("Id      Name      ");
        writer.WriteLine("1       Carl      ");
        writer.WriteLine("2       Mark      ");
        writer.Flush();
        stream.Position = 0;
 
        while ((row = parser.Read()) != null)
        {
            Console.WriteLine(String.Format("Id: {0}", row.Id));
            Console.WriteLine(String.Format("Name: {0}", row.Name));
        }
    }
}

如果头部行的列值之间有空格，FixedLengthReader 会自动从第一行检测文件布局模式。如果自动检测导致文件布局模式不正确，您可以通过配置自行指定模式。

3.3. 配置优先方法

在此模型中，我们定义了包含所有必需解析参数的 FixedLength 配置，以及与底层 FixedLength 文件匹配的 FixedLength 列。

清单 3.3.1 定义 FixedLength 配置

ChoFixedLengthRecordConfiguration config = new ChoFixedLengthRecordConfiguration();
config.FixedLengthRecordFieldConfigurations.Add
       (new ChoFixedLengthRecordFieldConfiguration("Id", 0, 8) 
{ FieldType = typeof(int) });
config.FixedLengthRecordFieldConfigurations.Add
       (new ChoFixedLengthRecordFieldConfiguration("Name", 8, 10) 
{ FieldType = typeof(string) });

在上面，我们定义了与示例 FixedLength 文件模板匹配的配置。

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

static void ConfigFirstApproachReadAsDynamicRecords()
{
    ChoFixedLengthRecordConfiguration config = new ChoFixedLengthRecordConfiguration();
    config.FixedLengthRecordFieldConfigurations.Add
    (new ChoFixedLengthRecordFieldConfiguration("Id", 0, 8) 
    { FieldType = typeof(int) });
    config.FixedLengthRecordFieldConfigurations.Add
    (new ChoFixedLengthRecordFieldConfiguration("Name", 8, 10) 
    { FieldType = typeof(string) });
 
    dynamic row = null;
    using (var stream = new MemoryStream())
    using (var reader = new StreamReader(stream))
    using (var writer = new StreamWriter(stream))
    using (var parser = new ChoFixedLengthReader(reader, config).WithFirstLineHeader())
    {
        writer.WriteLine("Id      Name      ");
        writer.WriteLine("1       Carl      ");
        writer.WriteLine("2       Mark      ");
        writer.Flush();
        stream.Position = 0;
 
        while ((row = parser.Read()) != null)
        {
            Console.WriteLine(String.Format("Id: {0}", row.Id));
            Console.WriteLine(String.Format("Name: {0}", row.Name));
        }
    }
}

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

static void ConfigFirstApproachReadAsTypedRecords()
{
    ChoFixedLengthRecordConfiguration config = new ChoFixedLengthRecordConfiguration();
    config.FixedLengthRecordFieldConfigurations.Add
    (new ChoFixedLengthRecordFieldConfiguration("Id", 0, 8) 
                       { FieldType = typeof(int) });
    config.FixedLengthRecordFieldConfigurations.Add
    (new ChoFixedLengthRecordFieldConfiguration("Name", 8, 10) 
                       { FieldType = typeof(string) });
 
    EmployeeRecSimple row = null;
    using (var stream = new MemoryStream())
    using (var reader = new StreamReader(stream))
    using (var writer = new StreamWriter(stream))
    using (var parser = 
    new ChoFixedLengthReader<EmployeeRecSimple>(reader, config).WithFirstLineHeader())
    {
        writer.WriteLine("Id      Name      ");
        writer.WriteLine("1       Carl      ");
        writer.WriteLine("2       Mark      ");
        writer.Flush();
        stream.Position = 0;
 
        while ((row = parser.Read()) != null)
        {
            Console.WriteLine(String.Format("Id: {0}", row.Id));
            Console.WriteLine(String.Format("Name: {0}", row.Name));
        }
    }
}

3.4. 代码优先声明式配置

这是定义 POCO 实体类以及声明式装饰的 FixedLength 配置参数的组合方法。

清单 3.4.1 定义 POCO 对象

public partial class EmployeeRec
{
    [ChoFixedLengthRecordField(0, 8)]
    public int Id { get; set; }
    [ChoFixedLengthRecordField(8, 10)]
    public string Name { get; set; }
}

上面的代码说明了如何定义 POCO 对象来承载输入文件中每条记录行的值。首先，使用 ChoFixedLengthRecordFieldAttribute 为每个记录字段定义属性，以符合 FixedLength 记录映射。每个属性必须指定 StartIndex, Size 才能映射到 FixedLength 列。StartIndex 是从 0 开始的。

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

清单 3.4.2 主方法

static void CodeFirstWithDeclarativeApproachRead()
{
    EmployeeRec row = null;
    using (var stream = new MemoryStream())
    using (var reader = new StreamReader(stream))
    using (var writer = new StreamWriter(stream))
    using (var parser = 
           new ChoFixedLengthReader<EmployeeRec>(reader).WithFirstLineHeader())
    {
        writer.WriteLine("Id      Name      ");
        writer.WriteLine("1       Carl      ");
        writer.WriteLine("2       Mark      ");
        writer.Flush();
        stream.Position = 0;
 
        while ((row = parser.Read()) != null)
        {
            Console.WriteLine(String.Format("Id: {0}", row.Id));
            Console.WriteLine(String.Format("Name: {0}", row.Name));
        }
    }
}

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

默认情况下，FixedLengthReader 在加载 FixedLength 文件时会自动检测并使用默认配置参数。这些可以根据您的需求进行覆盖。以下各节将详细介绍每个配置属性。

4. 读取所有记录

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

清单 4.1 读取 FixedLength 文件

foreach (var e in new ChoFixedLengthReader<EmployeeRec>("Emp.txt"))
{
    Console.WriteLine(String.Format("Id: {0}", e.Id));
    Console.WriteLine(String.Format("Name: {0}", e.Name));
}

或

清单 4.2 读取 FixedLength 文件流

foreach (var e in new ChoFixedLengthReader<EmployeeRec>(textReader))
{
    Console.WriteLine(String.Format("Id: {0}", e.Id));
    Console.WriteLine(String.Format("Name: {0}", e.Name));
}

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

清单 4.3 使用 LINQ

var list = (from o in new ChoFixedLengthReader<EmployeeRec>("Emp.txt")
           where o.Name != null && o.Name.StartsWith("R")
           select o).ToArray();
 
foreach (var e in list)
    Console.WriteLine(e.ToStringEx());

5. 手动读取记录

就像设置与 FixedLength 文件结构匹配的 POCO 对象一样简单，您可以将整个文件作为可枚举模式读取。

清单 5.1 读取 FixedLength 文件

var reader = new ChoFixedLengthReader<EmployeeRec>("Emp.txt");
var rec = (object)null;
 
while ((rec = reader.Read()) != null)
{
    Console.WriteLine(String.Format("Id: {0}", rec.Id));
    Console.WriteLine(String.Format("Name: {0}", rec.Name));
}

6. 自定义 FixedLength 记录

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

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

[ChoFixedLengthRecordObject(18)]
public class EmployeeRec
{
    [ChoFixedLengthRecordField(0, 8, FieldName = "id")]
    public int Id { get; set; }
    [ChoFixedLengthRecordField(8, 10, FieldName ="Name", QuoteField = true)]
    [Required]
    [DefaultValue("ZZZ")]
    public string Name { get; set; }
}

以下是用于定制 FixedLength 文件加载操作的可用属性。

RecordLength - 可选。如果未指定，则将从 POCO 类中定义的所有属性计算。
EOLDelimiter - 用于分隔 FixedLength 行的值。默认值为 \r\n (NewLine)。
CultureName - 用于读取和写入 FixedLength 数据的区域名称（例如，en-US，en-GB）。
IgnoreEmptyLine - 一个标志，告知读取器在读取时是否应跳过空记录。如果所有字段都为空，则认为记录为空。
Comments - 用于表示被注释掉的行的值。可以指定多个注释。必须用逗号分隔。
QuoteChar - 用于转义包含分隔符、引号或行结尾的字段的值。
QuoteAllFields - 读取器不适用。
Encoding - FixedLength 文件的编码。
HasExcelSeperator - 读取器不适用。读取器会无缝识别 FixedLength 文件中指定的 Excel 分隔符，并将其用于解析。
ColumnCountStrict - 此标志指示在读取预期字段丢失时是否应抛出异常。
ColumnOrderStrict - 此标志指示在文件中的错误位置读取预期字段时是否应引发异常。仅当 ColumnCountStrict 为 true 时执行此检查。
BufferSize - 在从 StreamReader 读取时使用的内部缓冲区的大小。
ErrorMode - 此标志指示在读取时是否应抛出异常，并且预期的字段加载失败。这可以每隔属性覆盖。可能的值是
- IgnoreAndContinue - 忽略错误，跳过记录并继续处理下一条。
- ReportAndContinue - 如果 POCO 实体是 IChoNotifyRecordRead 类型，则向其报告错误
- ThrowAndStop - 抛出错误并停止执行
IgnoreFieldValueMode - 一个标志，告知读取器在读取时是否应跳过空/null 的记录。这可以每隔属性覆盖。可能的值是
- Null - N/A
- DBNull - N/A
- Empty - 如果记录值为空，则跳过
- WhiteSpace - 如果记录值仅包含空格，则跳过
ObjectValidationMode - 一个标志，告知读取器关于记录对象要执行的验证类型。可能的值是
- Off - 不执行对象验证
- MemberLevel - 在加载每个 FixedLength 属性时执行验证
- ObjectLevel - 在所有属性加载到 POCO 对象后执行验证

7. 自定义 FixedLength 头部

如果 FixedLength 文件包含头部，您可以使用 ChoFixedLengthFileHeaderAttribute 来指示 POCO 实体。

清单 6.1 为文件标题自定义 POCO 对象

[ChoFixedLengthFileHeader]
public class EmployeeRec
{
    [ChoFixedLengthRecordField(0, 8, FieldName = "id")]
    public int Id { get; set; }
    [ChoFixedLengthRecordField(8, 10, FieldName ="Name", QuoteField = true)]
    [Required]
    [DefaultValue("ZZZ")]
    public string Name { get; set; }
}

以下是您可以根据需要添加一些自定义的可用成员。

FillChar - 对读取器无效
Justification - 对读取器无效
TrimOption - 此标志告诉读取器在读取 FixedLength 列头部时修剪开头和结尾的空格。可能的值包括 Trim、TrimStart、TrimEnd。
Truncate - 对读取器无效

8. 自定义 FixedLength 字段

对于每个 FixedLength 列，您可以使用 ChoFixedLengthRecordFieldAttribute 在 POCO 实体属性中指定映射。*

清单 6.1 自定义 FixedLength 列的 POCO 对象

[ChoFixedLengthFileHeader]
public class EmployeeRec
{
    [ChoFixedLengthRecordField(0, 8, FieldName = "id")]
    public int Id { get; set; }
    [ChoFixedLengthRecordField(8, 10, FieldName ="Name", QuoteField = true)]
    [Required]
    [DefaultValue("ZZZ")]
    public string Name { get; set; }
}

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

StartIndex - 固定长度行中列的零基起始字符位置。
Size - 列中的字符数。
FieldName - 按名称映射时，您需要指定要用于该属性的 FixedLength 列的名称。为此，FixedLength 文件必须有头部记录。您指定的名称必须与头部记录的名称匹配。
FillChar - 对读取器无效。
FieldValueJustification - 对读取器无效。
FieldValueTrimOption - 此标志指示读取器在读取时修剪字段值开头和结尾的空白。可能的值是 Trim、TrimStart、TrimEnd。
Truncate - 读取器不适用。
Size - 读取器不适用。
QuoteField - 一个标志，告诉读取器 FixedLength 列值被引号包围。
ErrorMode - 此标志指示在读取时是否应抛出异常，并且预期的字段加载失败。可能的值是
- IgnoreAndContinue - 忽略错误，继续加载记录的其他属性。
- ReportAndContinue - 如果 POCO 实体是 IChoRecord 类型，则向其报告错误。
- ThrowAndStop - 抛出错误并停止执行。
IgnoreFieldValueMode - 一个标志，告知读取器在读取时是否应跳过空/null 的记录。可能的值是
- Null - N/A
- DBNull - N/A
- Empty - 如果记录值为空，则跳过
- WhiteSpace - 如果记录值仅包含空格，则跳过

8.1. DefaultValue

当 FixedLength 值为空或为空白时，用于并设置为属性的值（通过 IgnoreFieldValueMode 控制）。

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

8.2. ChoFallbackValue

当 FixedLength 值未能设置时，用于并设置为属性的值。Fallback 值仅在 ErrorMode 为 IgnoreAndContinue 或 ReportAndContinue 时设置。

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

8.3. 类型转换器

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

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

声明式方法
配置方法

8.3.1. 声明式方法

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

清单 8.3.1.1 指定类型转换器

[ChoFixedLengthFileHeader]
public class EmployeeRec
{
    [ChoFixedLengthRecordField(0, 8)]
    [ChoTypeConverter(typeof(IntConverter))]
    public int Id { get; set; }
    [ChoFixedLengthRecordField(8, 10, QuoteField = true)]
    [Required]
    [DefaultValue("ZZZ")]
    public string Name { get; set; }
}

清单 8.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'* FixedLength 属性。

8.3.2. 配置式方法

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

清单 8.3.2.2 指定 TypeConverters

ChoFixedLengthRecordConfiguration config = new ChoFixedLengthRecordConfiguration();
config.FileHeaderConfiguration.HasHeaderRecord = true;
config.ThrowAndStopOnMissingField = false;

ChoFixedLengthRecordFieldConfiguration idConfig = 
        new ChoFixedLengthRecordFieldConfiguration("Id", 0, 8);
idConfig.AddConverter(new IntConverter());
config.FixedLengthRecordFieldConfigurations.Add(idConfig);

config.FixedLengthRecordFieldConfigurations.Add
       (new ChoFixedLengthRecordFieldConfiguration("Name", 8, 10));

在上面，我们通过 ChoFixedLengthRecordFieldConfiguration 对象中的 AddConverter 辅助方法构造并附加了 IntConverter 到 'Id' 字段。

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

8.4. 验证

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

清单 8.4.1 在 POCO 实体中使用验证属性

[ChoFixedLengthFileHeader]
[ChoFixedLengthRecordObject(18)]
public partial class EmployeeRec
{
    [ChoFixedLengthRecordField(0, 8, FieldName = "id")]
    [ChoTypeConverter(typeof(IntConverter))]
    [Range(1, int.MaxValue, ErrorMessage = "Id must be > 0.")]
    [ChoFallbackValue(1)]
    public int Id { get; set; }
 
    [ChoFixedLengthRecordField(8, 10, FieldName = "Name")]
    [Required]
    [DefaultValue("ZZZ")]
    [ChoFallbackValue("XXX")]
    public string Name { get; set; }
}

在上面的示例中，我们为 Id* 属性使用了 Range 验证属性。为 Name* 属性使用了 Required* 验证属性。FixedLengthReader 在加载期间根据 Configuration.ObjectValidationMode 设置为 ChoObjectValidationMode.MemberLevel 或 ChoObjectValidationMode.ObjectLevel 执行验证。

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

static void ValidationOverridePOCOTest()
{
    ChoFixedLengthRecordConfiguration config = new ChoFixedLengthRecordConfiguration();
    var idConfig = new ChoFixedLengthRecordFieldConfiguration("Id", 0, 8);
    idConfig.Validators = new ValidationAttribute[] { new RequiredAttribute() };
    config.FixedLengthRecordFieldConfigurations.Add(idConfig);
    config.FixedLengthRecordFieldConfigurations.Add
    (new ChoFixedLengthRecordFieldConfiguration("Name", 8, 10));
    config.FixedLengthRecordFieldConfigurations.Add
    (new ChoFixedLengthRecordFieldConfiguration("Salary", 8, 10) 
                             { FieldType = typeof(ChoCurrency) });
 
    using (var stream = new MemoryStream())
    using (var reader = new StreamReader(stream))
    using (var writer = new StreamWriter(stream))
    using (var parser = 
           new ChoFixedLengthReader<EmployeeRecWithCurrency>(reader, config))
    {
        writer.WriteLine(",Carl,$100000");
        writer.WriteLine("2,Mark,$50000");
        writer.WriteLine("3,Tom,1000");
 
        writer.Flush();
        stream.Position = 0;
 
        object rec;
        while ((rec = parser.Read()) != null)
        {
            Console.WriteLine(String.Format("Id: {0}", rec.Id));
            Console.WriteLine(String.Format("Name: {0}", rec.Name));
            Console.WriteLine(String.Format("Salary: {0}", rec.Salary));
        }
    }
}
 
public class EmployeeRecWithCurrency
{
    public int? Id { get; set; }
    public string Name { get; set; }
    public ChoCurrency Salary { get; set; }
}

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

清单 8.4.2 对 POCO 实体进行手动验证

[ChoFixedLengthFileHeader]
[ChoFixedLengthRecordObject(18)]
public partial class EmployeeRec : IChoValidatable
{
    [ChoFixedLengthRecordField(0, 8, FieldName = "id")]
    [ChoTypeConverter(typeof(IntConverter))]
    [Range(1, int.MaxValue, ErrorMessage = "Id must be > 0.")]
    [ChoFallbackValue(1)]
    public int Id { get; set; }
 
    [ChoFixedLengthRecordField(8, 10, FieldName = "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 - 验证对象的特定属性，如果验证未通过则抛出异常。

9. 回调机制

FixedLengthReader 提供开箱即用的行业标准 FixedLength 解析功能，以满足大多数解析需求。* 如果解析不能满足任何需求，您可以使用 FixedLengthReader 提供的回调机制来处理这种情况。为了参与回调机制，POCO 实体对象或 DataAnnotation 的 MetadataType 类型对象必须继承 IChoNotifyRecordRead 接口。

提示：从此接口方法中引发的任何异常都将被忽略。

IChoNotifyRecordRead 公开了以下方法

BeginLoad - 在 FixedLength 文件加载开始时调用
EndLoad - 在 FixedLength 文件加载结束时调用
BeforeRecordLoad - 在 FixedLength 记录加载之前引发
AfterRecordLoad - 在 FixedLength 记录加载之后引发
RecordLoadError - 在 FixedLength 记录加载失败时引发
BeforeRecordFieldLoad - 在 FixedLength 列值加载之前引发
AfterRecordFieldLoad - 在 FixedLength 列值加载之后引发
RecordFieldLoadError - 在 FixedLength 列值加载失败时引发

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

[ChoFixedLengthFileHeader]
[ChoFixedLengthRecordObject(18)]
public partial class EmployeeRec : IChoNotifyRecordRead
{
    [ChoFixedLengthRecordField(0, 8, FieldName = "id")]
    [ChoTypeConverter(typeof(IntConverter))]
    [Range(1, int.MaxValue, ErrorMessage = "Id must be > 0.")]
    [ChoFallbackValue(1)]
    public int Id { get; set; }
    
    [ChoFixedLengthRecordField(8, 10, FieldName = "Name", QuoteField = true)]
    [Required]
    [DefaultValue("ZZZ")]
    [ChoFallbackValue("XXX")]
    public string Name { get; set; }
 
    public bool AfterRecordFieldLoad(object target, int index, 
                                     string propName, object value)
    {
        throw new NotImplementedException();
    }
 
    public bool AfterRecordLoad(object target, int index, object source)
    {
        throw new NotImplementedException();
    }
 
    public bool BeforeRecordFieldLoad(object target, int index, 
                                      string propName, ref object value)
    {
        throw new NotImplementedException();
    }
 
    public bool BeforeRecordLoad(object target, int index, ref object source)
    {
        throw new NotImplementedException();
    }
 
    public bool BeginLoad(object source)
    {
        throw new NotImplementedException();
    }
 
    public void EndLoad(object source)
    {
        throw new NotImplementedException();
    }
 
    public bool RecordFieldLoadError(object target, int index, 
                string propName, object value, Exception ex)
    {
        throw new NotImplementedException();
    }
 
    public bool RecordLoadError
    (object target, int index, object source, Exception ex)
    {
        throw new NotImplementedException();
    }
}

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

[ChoFixedLengthFileHeader]
[ChoFixedLengthRecordObject(18)]
public class EmployeeRecMeta : IChoNotifyRecordRead
{
    [ChoFixedLengthRecordField(0, 8, FieldName = "id")]
    [ChoTypeConverter(typeof(IntConverter))]
    [Range(1, int.MaxValue, ErrorMessage = "Id must be > 0.")]
    [ChoFallbackValue(1)]
    public int Id { get; set; }

    [ChoFixedLengthRecordField(8, 10, FieldName = "Name", QuoteField = true)]
    [Required]
    [DefaultValue("ZZZ")]
    [ChoFallbackValue("XXX")]
    public string Name { get; set; }
 
    public bool AfterRecordFieldLoad(object target, int index, 
                                     string propName, object value)
    {
        throw new NotImplementedException();
    }
 
    public bool AfterRecordLoad(object target, int index, object source)
    {
        throw new NotImplementedException();
    }
 
    public bool BeforeRecordFieldLoad(object target, int index, 
                                      string propName, ref object value)
    {
        throw new NotImplementedException();
    }
 
    public bool BeforeRecordLoad(object target, int index, ref object source)
    {
        throw new NotImplementedException();
    }
 
    public bool BeginLoad(object source)
    {
        throw new NotImplementedException();
    }
 
    public void EndLoad(object source)
    {
        throw new NotImplementedException();
    }
 
    public bool RecordFieldLoadError(object target, int index, 
                string propName, object value, Exception ex)
    {
        throw new NotImplementedException();
    }
 
    public bool RecordLoadError
    (object target, int index, object source, Exception ex)
    {
        throw new NotImplementedException();
    }
} 

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

9.1 BeginLoad

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

清单 9.1.1 BeginLoad 回调示例

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

9.2 EndLoad

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

清单 9.2.1 EndLoad 回调示例

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

9.3 BeforeRecordLoad

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

**提示**：如果您想跳过该行不加载，请将源设置为 null。

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