一、简介

FFReader 是一款通用的接口数据文件解析阅读编辑工具。本手册介绍图形界面(GUI)的基本使用方法,适用于桌面用户:借助 FFReader,你可以轻松解析和阅读接口数据,将数据导出为 Excel(xlsx)/ CSV / HTML,还可以使用文件比对(含批量比对)、主键冲突检查、字段必填校验等高级功能。

如需无界面批量转换、批量比对,或接入 AI 工具进行数据分析,请参阅CLI/AI使用手册

二、安装与启动

  • Windows用户:下载后解压压缩包,双击运行 FFReader.exe 即可
  • macOS用户:下载后解压,双击 FFReader.app 运行
  • Linux用户:自 V1.12.1 起统一使用 AppImage 格式,下载后解压得到 FFReader-x86_64.AppImage(x64)或 FFReader-aarch64.AppImage(ARM64):
    • 首次运行前需赋予执行权限:chmod +x FFReader-x86_64.AppImage
    • 直接运行即启动图形界面:./FFReader-x86_64.AppImage
    • 部分发行版(如麒麟 Kylin 等)FUSE 挂载不可用,启动时报 execv error: Socket not connected 时,改用 ./FFReader-x86_64.AppImage --appimage-extract-and-run 运行即可

如 Linux 下安装或运行遇到异常,请参阅Linux特别说明获取详细的排查与系统安装指引。

三、基本功能介绍

文件解析

FFReader支持多类文件解析,打开文件时自动识别文件类型与解析配置:

  • OFD文件 — 基金行业广泛使用的字段定长文件,分「数据文件」与「索引文件」两类
  • 通用字段定长文件 — 自定义字段长度的固定格式文件
  • 通用固定分隔符文件 — CSV、TXT等使用分隔符的文件
  • DBF文件 — dBase/FoxPro 数据库文件

当某文件同时命中多套解析配置时,会弹出窗口让你选择解析方案;也可从压缩包中选择文件,自动解压后解析。

数据浏览

解析后的数据以表格形式展示,支持:

  • 分页查看 — 每页行数可调(10万/20万/50万/100万/200万行/页),采用懒加载与滚动内存回收机制,超大文件也能流畅浏览
  • 标准/精简视图 — 精简视图隐藏空列,快捷键 Ctrl+G
  • 高亮方式 — 按行高亮或按单元格高亮,可在视图菜单自由切换
  • 自适应列宽 — 快捷键 Alt+W
  • 列模式显示 — 单独查看某一列的数据
  • 字典翻译 — 显示枚举字段的翻译值
  • 字段详情/Tips — 查看每个字段的注释说明
  • 表格行记录查看 — 查看某一行完整字段明细
  • 数据放大镜 — 放大查看指定行列的数据
  • 数值展示 — 数值列右对齐,千位分隔符

数据搜索

强大的搜索功能支持:

  • 全文搜索 — 从当前单元格向上/向下全文件搜索
  • 列搜索/列跳转 — 输入字段中文名或英文名,快速定位到对应列
  • 行跳转 — 跳转到指定行或源文件行
  • 特殊字符搜索 — 搜索空格、制表符、零宽空格等不可见字符
  • 正则表达式搜索 — 支持高级正则匹配

数据编辑

支持对解析数据进行编辑(OFD/类OFD/字段定长文件):

  • 编辑单元格 — 快捷键 Ctrl+E
  • 编辑整行 — 快捷键 Ctrl+Shift+E
  • 复制单元格 — 快捷键 Ctrl+C
  • 新建OFD/类OFD空文件 — 快捷键 Ctrl+N,方便生成空接口文件
  • 编辑/查看文件头文件尾 — 仅OFD/类OFD文件
  • 从Excel导入数据 — 仅OFD/类OFD/字段定长文件
  • 保存自动备份原文件 — 快捷键 Ctrl+S,另存为 Ctrl+Alt+S

数据导出

图形界面可将解析后的数据导出为:

  • Excel格式 — .xlsx 文件,支持分页导出,方便分析
  • HTML格式 — 网页格式,便于分享查看
  • CSV格式 — 支持竖线/制表符/逗号三种分隔符,可选 UTF-8 编码
  • 导出范围 — 可导出当前页或整个文件
  • 一键在Excel中打开 — 快捷键 Ctrl+Alt+E

需要导出 JSON(含AI解读元信息)或 SQL 语句时,请使用命令行模式,见CLI/AI使用手册

四、高级功能

文件比对

对两份接口数据文件做数据接口级别的比对(依赖配置主键),支持:

  • 单文件比对 — 对比两个文件,输出 Excel/JSON/HTML 差异报告
  • 批量比对 — 对比两个目录,输出汇总与单文件差异报告
  • 行比对器 — 将当前行加入/移出比对器视图(快捷键 Ctrl+X 打开),逐行对比数据
  • 文本编辑器 — 以文本方式打开当前文件(Ctrl+Alt+F)

主键冲突检查

检查文件中是否存在主键冲突数据,可自由配置主键字段(快捷键 Alt+9 执行,Alt+F10 导出报告),帮助发现数据异常。

字段必填校验

按配置规则检查字段必填情况,支持:

  • 列出当前文件适用的必填检查规则
  • 定位上一处/下一处必填缺失(Alt+F2 / Alt+F3)
  • 导出字段必填检查报告(Alt+F11)
  • 字段必填/主键规则配置工具,自由配置检查规则

不可见字符检查

定位文件中的不可见字符,分为两类:

  • 零宽空格类(Alt+F5 / Alt+F6 定位上/下一处)
  • 空格、制表符等 ASCII 不可见字符(Alt+F7 / Alt+F8 定位上/下一处)

编码解析

将字段翻译成文件编码的 16 进制、2 进制展示,方便查看字符的实际编码。

二维码分享

使用二维码分享单元格数据,方便在移动设备上查看(S 版本不含此功能)。

截图

对当前窗口截图保存,快捷键 Ctrl+Alt+R(macOS 为 command+option+R)。

从压缩包解析

从压缩包中选择文件后自动解压并解析,方便查看压缩的接口文件。

生僻字支持

支持 GB18030-2022 编码规范解析(Level3 等级),可正确处理生僻汉字。如需处理生僻字场景,建议下载「生僻字测试补充说明包」。

字体设置

自定义软件界面字体样式和大小,适应不同显示需求。

DBF工具箱

针对 DBF 文件提供专用工具:

  • 数据过滤器 — 显示全部 / 仅未删除 / 仅已删除的数据
  • 代码页(编码)选择 — GB18030/GBK、Big5、Shift-JIS、IBM437/850/866、Windows1250/1251/1252 等
  • 字符串空格修剪方式 — 全部修剪 / 左边修剪 / 右边修剪
  • 表结构信息查看

其它附加工具

  • 文件时间戳修改 — 批量更新文件的修改时间
  • OK文件工具 — 一键创建/删除/刷新 OFD 的 OK 回执文件
  • 配置文件同步检查 — 将程序包内的配置文件同步到用户配置目录

Web插件平台(Windows)

Windows 版本提供基于 Web 的插件平台,可用 H5 开发小功能嵌入到 FFReader。

五、配置说明

FFReader采用主程序和配置分离的方式,配置文件位于程序包的 conf 目录下:

  • A_配置说明_配置前必读.txt:配置说明文档
  • 接口配置文件:定义各种接口的字段解析规则
  • 字典配置文件:定义字段值翻译映射

升级版本时,请保留自己本地配置的私有接口解析规则,复制到新版本程序包的 conf 目录下。

六、常见问题

文件无法正确解析?

请检查:

  • 文件编码是否正确(支持UTF-8、GBK、GB18030等多种编码)
  • 文件格式是否与选择的解析配置匹配
  • 换行符是否正确(支持CR、CRLF、LF三种换行符)

生僻字显示为方块?

可能原因:

  • 操作系统字库版本过低,建议升级操作系统
  • 系统缺少相应字体,可从新版本操作系统复制字体安装
  • 建议下载生僻字测试补充说明包并按指引操作

导出Excel数值精度丢失?

如数值长度超过16位,Excel会存在精度丢失问题,建议使用V1.9.26及以上版本,已修复此问题。

Linux 下 AppImage 启动失败?

部分发行版(如麒麟 Kylin)FUSE 挂载不可用时会报 execv error: Socket not connected,与程序本身无关。改用 --appimage-extract-and-run 参数运行即可:

./FFReader-x86_64.AppImage --appimage-extract-and-run

七、技术支持

如遇到问题或需要反馈bug,可通过以下方式联系: