Skip to content
JINGHAN YU edited this page Nov 16, 2026 · 13 revisions

本 Wiki 是 WeFlow 的技术文档,内容包括项目的使用方式、设计方式和所遵循的原则。

核心原则

只读。 WeFlow 从不写入微信的文件。数据库通过只读 VFS 打开,会修改数据库的命令一律拒绝。原因是微信同时打开着这些数据库,写入可能损坏它们,SQLCipher 文件也需要逐页重新加密。

数据库明文不落盘。 数据库页在内存中按需解密,解密结果不写入磁盘。媒体不在此列:解密后的图片和解码后的语音保存在 WeFlow 自己的缓存中,由 weflow cache 管理。密钥不写入缓存;为避免重复校验,只保存无法反推密钥的单向指纹。

运行中的微信不影响结果。 每次查询都在一致的快照上进行。微信在读取期间做 checkpoint 时,查询在新快照上重新执行,不会混合两个时间点的数据。

数据库与解码不依赖闭源组件。 数据库层、WXGF 解码、朋友圈的 ISAAC-64 都是 Rust 实现,不加载 wcdb_api,也不需要 ffmpeg。macOS 的三个密钥辅助程序也都由 Rust 实现,内嵌二进制只作对照,列在平台辅助程序中。

命令行与 HTTP 行为一致。 HTTP 路由由命令树生成,响应就是命令的 --json 输出。高频读取在服务进程内执行,有测试逐字节比较两者。

结果可比。 消息解码和各导出格式的文本与桌面版保持一致,以便对照。

用测量决定优化。 是否增加进程内路由、线程数上限、页大小等决定都依据实测数据,基准结果长期保存,见测试与基准。

系统总览

flowchart LR
    CLI["weflow 命令行"] --> Reads["类型化读取与服务层<br/>weflow-core"]
    Serve["weflow serve"] -->|"/api/ 进程内"| Reads
    Serve -->|"其他路由,子进程"| CLI
    Web["WebUI"] -->|HTTP / SSE| Serve
    Reads --> Native["只读数据库层<br/>weflow-native"]
    Reads --> Silk["SILK 解码<br/>weflow-silk"]
    Native --> VFS["按需解密的 VFS"]
    VFS --> DB[("微信数据库<br/>db_storage")]
    Reads --> Files[("媒体文件<br/>msg/")]
Loading

各 crate 的职责和数据流见架构。

阅读路径

目的 从这里开始
第一次使用 README 的首次设置
查某条命令的行为 命令参考
查 chat、image、video、biz 的参数 聊天与媒体命令
导出聊天记录,或了解输出格式 消息导出
用脚本或其他程序调用 WeFlow 命令 API
确认某个功能是否可用 不支持的功能
命令报错、取不到密钥、媒体取不到、网页连不上 故障排查
查退出码、错误码和 HTTP 状态码 命令参考、命令 API
遇到不熟悉的术语 术语表
了解微信的数据如何存放 微信数据目录 → 数据库解密 → 消息存储与读取
修改后端 架构 → 服务端实现
了解网页各页面的功能 WebUI 使用
搭建开发环境、提交改动 开发指南
修改网页 WebUI 实现
运行测试或测量性能 测试与基准
发布版本 发布与 CI

Clone this wiki locally