OFD Go Toolkit

用 Go 解析、创建、转换、渲染、校验和分析 OFD 文档。提供 Go API、命令行工具、 HTTP 服务，以及桌面、Android 和浏览器阅读器。

快速开始

下载 Release 中对应平台的命令行程序后运行：

# OFD 转 PDF
ofd-converter input.ofd output.pdf

# 首页输出为 PNG；页码从 1 开始
ofd-converter --page 1 --dpi 150 input.ofd page1.png

# 多页图片输出为 ZIP
ofd-converter --format png input.ofd pages.zip

# PDF 转 OFD
ofd-converter input.pdf output.ofd

# CSV / TSV 表格转 OFD，长表自动分页并重复表头
ofd-converter inventory.csv /tmp/inventory.ofd
ofd-converter --landscape inventory.tsv /tmp/inventory.ofd

# 邮件和 SVG 转 OFD，需要本机 Chrome/Chromium
ofd-converter message.eml /tmp/message.ofd
ofd-converter --landscape drawing.svg /tmp/drawing.ofd

# 从 YAML 或 JSON 清单创建 OFD
ofd-creator -i document.yaml -o result.ofd --validate

# 校验与分析
ofd-validator --format text input.ofd
ofd-analyzer --format json input.ofd

# 加密与解密；口令文件按原始 UTF-8 字节读取
ofd-crypt encrypt --password-file password.txt -o encrypted.ofd input.ofd
ofd-crypt decrypt --password-file password.txt -o plain.ofd encrypted.ofd

# 多份文档与第一份比较，生成可离线查看的图文差异报告
ofd-compare -o comparison.html original.ofd revised.ofd final.ofd

从源码运行时，在仓库根目录将程序名替换为 go run ./cmd/工具名，例如：

go run ./cmd/ofd-converter testdata/ofd-creator/helloworld.ofd /tmp/helloworld.pdf

GM/T 0099-2020 加解密使用不提供认证的 CBC；解密成功不证明内容未被篡改、证书可信或签名有效。 重要场景请独立验证签名和完整性证据，详见密码功能与实现约定及免责声明。

ofd-converter 默认使用 150 DPI 和白色背景，--page 使用多文档体合并后的全局页码。 批量转换、完整选项和退出码见 转换工具说明； 创建清单见 creator 示例，大对比报告可使用 --external-images 将图片保存到报告旁。

常规 OFD 转 PDF、图片及 PDF、CSV/TSV 导入使用 Go 实现。Office、HTML、EML、SVG、XPS 和 OCR 的 外部工具要求见 运行依赖，PDF 的可选 OpenJPEG 后端见 PDF 支持清单。

功能特性

Go API

在已有 Go 项目中添加依赖，Go 工具链要求以 go.mod 为准：

go get github.com/zc310/ofd@latest

下面是一个完整的 OFD 转 PDF 示例。转换入口的首参是 context.Context，长任务可传入 带取消或超时的上下文：

package main

import (
	"context"
	"log"
	"os"

	"github.com/zc310/ofd/pkg/converter"
)

func main() {
	output, err := os.Create("output.pdf")
	if err != nil {
		log.Fatal(err)
	}

	err = converter.PDF(context.Background(), "input.ofd", output)
	closeErr := output.Close()
	if err != nil {
		log.Fatal(err)
	}
	if closeErr != nil {
		log.Fatal(closeErr)
	}
}

输入类型、页码、DPI、格式导入、缓存与字体等细节见 Go API 使用指南。 基于本库的独立应用示例有 ofd-viewer 与 ofd-toolbox。

阅读器

桌面与 Android：ofd-viewer 提供连续阅读、缩略图、 四种页面视图、简体中文/英文界面，以及 PDF、图片和文本导出。安装包见 Releases，系统要求与截图见对应文档。

浏览器：在线阅读器在本地处理 OFD，支持文字选择、 搜索、页面导航、图层与模板显隐、附件和签名检查，以及 PNG/JPG/PDF/TXT 导出。 WASM 阅读器支持使用口令或 SM2 私钥解锁 GM/T 0099-2020 加密文档后浏览。 本地启动方式见 WASM 构建与运行；API 与 Worker 协议见 ofd-wasm。

Fyne Web：在线体验与桌面、Android 版本共用阅读界面， 支持选择本地 OFD 和导出下载，文档在浏览器内处理，需要 WebAssembly 和 WebGL。 构建与运行方式见 Web 打包。

构建与打包

在仓库根目录执行，发行版本由 Makefile 的 VERSION 统一注入：

# 当前平台的命令行工具
make build-tools

# 当前平台的命令行工具 ZIP 包
make package-tools

# 当前平台的桌面阅读器与命令行工具包
make package-desktop

构建输出默认位于 /tmp/ofd/.build，发布包位于 /tmp/ofd/dist，可通过 BUILD_DIR、DIST_DIR 覆盖。默认 make 还会生成 Linux 缩略图 DEB 和 RPM，需先安装 nFPM（make install-nfpm 并将 Go bin 目录加入 PATH，或设置 NFPM）。 Android、WASM、交叉编译、系统依赖与 Windows 7 兼容工具链的试编译说明见 构建指南。

支持清单与工具文档

支持清单区分已支持、部分支持和暂不支持，记录能力边界与兼容处理：

工具的参数与退出码见功能表中的文档。标准资料、截图与维护入口汇总在 文档目录；已发布接口的破坏性变更见 CHANGELOG。 性能对比见 ofd-benchmark，实际表现取决于 文档样本、字体、操作系统和运行环境。

OFD 简介

OFD（Open Fixed-layout Document）是中国电子文件领域常用的版式文档格式，适用于 电子证照、电子发票、数字档案和公文。文件通常以 ZIP 容器组织 XML、页面、文字、 路径、图片、字体、附件和签名等资源，并保留相应的布局和绘制信息。

GB/T 33190-2016 等标准的官方查询链接见标准资料索引。 项目不随仓库分发标准全文；不同生产方的扩展与兼容处理见 OFD 支持清单。

许可证

本项目基于 Apache License 2.0 发布，声明见 LICENSE 和 NOTICE。 第三方依赖的来源与许可见 THIRD-PARTY-LICENSES，测试样例来源见 testdata/README.md，项目图标的来源与许可见图标说明。

使用本项目及其输出结果前，请阅读 免责声明。本项目不保证所有 OFD 文件的解析、转换、校验或渲染结果适用于特定业务、法律或合规场景。如发现仓库、文档 或示例中可能存在侵权内容，请通过 GitHub Issues 联系维护者。