FileReadActivity
分类: 文件操作
命名空间: CMS.Plugin.FlowManagement.Domain.FlowBusiness.Activitys
基类: ActionActivity
模块: FlowManagement.Domain
概述
FileReadActivity(读文件)是用于在流程中读取文件内容的节点。它继承自 ActionActivity,支持读取指定路径的文件内容,并将读取结果写入流程上下文。该节点支持配置文件访问模式、共享类型和缓冲区大小,可以灵活地处理各种文件读取场景。
业务场景
适用场景
- 配置读取: 读取配置文件内容
- 数据导入: 读取数据文件进行处理
- 日志分析: 读取日志文件进行分析
- 模板加载: 读取模板文件用于生成内容
- 文件校验: 读取文件内容进行校验
在系统中的作用
FileReadActivity 在 LMES 流程系统中提供文件读取能力:
- 读取本地文件系统中的文件
- 支持多种文件访问模式
- 将文件内容写入流程上下文供后续节点使用
与其他节点的协作
- FileWriteActivity: 配合使用实现文件读写操作
- TextTemplateActivity: 读取模板文件后进行模板处理
- CsvReadActivity: 如需读取 CSV 格式,使用专用节点
配置说明
基本配置
| 属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| FilePath | string | 是 | - | 文件路径 |
| FileMode | FileMode | 否 | Open | 文件模式 |
| FileAccess | FileAccess | 否 | Read | 操作类型 |
| FileShare | FileShare | 否 | None | 共享类型 |
| BufferSize | int | 否 | 1024 | 缓冲区大小 |
| FlowItemKey | string | 否 | - | 流程上下文键名,将读取结果写入 |
配置项详解
FilePath
说明: 要读取的文件的完整路径。 注意事项: 支持绝对路径和相对路径,文件不存在时节点会跳过执行。
FileMode
说明: 指定文件打开模式。 可选值: Open, OpenOrCreate, Create, CreateNew, Truncate, Append
FileAccess
说明: 指定对文件的访问类型。 可选值: Read, Write, ReadWrite
FileShare
说明: 指定其他线程对该文件的访问类型。 可选值: None, Read, Write, ReadWrite, Delete, Inheritable
流程上下文
输出参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| {FlowItemKey} | string | 读取的文件内容 |
使用示例
基本示例
{
"Type": "FileReadActivity",
"Name": "读取配置文件",
"Alias": "ReadConfig",
"FilePath": "C:\\Config\\settings.json",
"FlowItemKey": "ConfigContent_Value"
}
完整配置示例
{
"Type": "FileReadActivity",
"Name": "读取数据文件",
"Alias": "ReadData",
"FilePath": "D:\\Data\\input.txt",
"FileMode": "Open",
"FileAccess": "Read",
"FileShare": "Read",
"BufferSize": 4096,
"FlowItemKey": "FileContent_Value"
}
注意事项
- ⚠️ 文件不存在时节点会跳过执行,不会抛出异常
- ⚠️ 大文件读取可能影响性能,建议调整 BufferSize
- ⚠️ 确保流程运行账户有文件读取权限
- 💡 读取后的内容存储在 FlowItemKey 指定的流程上下文中
相关节点
- FileWriteActivity: 写文件节点
- FileCopyActivity: 复制文件节点
- CsvReadActivity: CSV 读取节点
更新历史
| 日期 |
|---|