FileHelpers 技术文档

本文档旨在帮助用户安装、使用和深入了解 FileHelpers 项目。以下是文档的主要内容：

1. 安装指南

通过 NuGet 包管理器安装

1. 打开 Visual Studio。
2. 在项目上点击右键，选择“管理 NuGet 包”。
3. 选择“联机”选项卡。
4. 在搜索框中输入 "FileHelpers"，然后选择相应的包。
5. 点击“安装”完成安装。

通过 .NET CLI 安装

在项目目录中打开命令行，然后执行以下命令：

dotnet add package FileHelpers

2. 项目使用说明

FileHelpers 是一个免费的、易于使用的 .NET 库，用于从文件、字符串或流中读取/写入固定长度或分隔记录的数据。

主要功能

• FileHelperEngine：用于读取和写入固定长度或分隔记录的数据。
• MasterDetailEngine：用于处理主从记录。
• Attributes：提供用于自定义数据处理的属性。
• Converters：提供数据转换功能。
• Events：提供事件处理功能。
• ErrorManager：用于处理错误。
• 对大文件的排序。

不包含的功能

• Dynamic：ClassBuilder 和 CsvClassBuilder。由于 ClassBuilder 维护困难，且在 .NET Core/Standard 中重写将需要引用三个 NuGet 包，因此暂时不提供。
• SmartFormatDetector：依赖于 ClassBuilder。
• DataLink：代码较旧，不值得维护。

3. 项目 API 使用文档

以下是 FileHelpers 的一些主要 API 使用示例：

读取固定长度文件

using FileHelpers;

public class FixedLengthRecord
{
    [FieldFixedLength(10)]
    public string Field1;

    [FieldFixedLength(20)]
    public string Field2;
}

var engine = new FileHelperEngine<FixedLengthRecord>();
var records = engine.ReadFile("fixedlengthfile.txt");

读取分隔记录文件

using FileHelpers;

public class DelimitedRecord
{
    [FieldDelimiter(",")]
    public string Field1;

    [FieldDelimiter(",")]
    public string Field2;
}

var engine = new FileHelperEngine<DelimitedRecord>();
var records = engine.ReadFile("delimitedfile.csv");

写入文件

using FileHelpers;

public class RecordToWrite
{
    public string Field1;

    public int Field2;
}

var engine = new FileHelperEngine<RecordToWrite>();
var records = new List<RecordToWrite>
{
    new RecordToWrite { Field1 = "Record 1", Field2 = 1 },
    new RecordToWrite { Field1 = "Record 2", Field2 = 2 }
};

engine.WriteFile("outputfile.txt", records);

4. 项目安装方式

请参考本文档的“1. 安装指南”部分。

以上内容为 FileHelpers 项目的详细技术文档，希望对您的使用有所帮助。