对照 ledgerly 自文档上次更新以来的全部改动,补充新功能文档、修正品牌与版本残留,并新增下载与安装页;配图已重新截取并上传 OSS,本地截图目录不纳入版本管理。 变更内容: - 新增「智能查数」「账单关系」两个使用文档页,并登记侧边栏与总览 - 设置页扩充为八个面板(账号安全、数据库实时进度、外观、导航等)并改为即时保存 - 收支记录补充关系列、批量操作、AI 搜索浮窗、可配置分页与「账单详情」弹窗 - 统计面板补充饼图/渠道图下钻与筛选双向联动;规则管理补充批量删除 - AI 能力补充智能查数与关系命名;新增下载与安装页 - 开发文档同步:AI 13 类调用、数据模型 24 张表、API、前端偏好、构建部署 - 统一「汇账 Ledgerly」品牌与「设置/日志」菜单文案,版本号对齐 0.1 - 截图脚本新增账单详情等场景并更新登记 说明: - download.md 的 OSS 下载链接保持待发布产物回填,暂不调整 - 已通过 npm run docs:build 与 npm run typecheck:scripts
1.3 KiB
1.3 KiB
开发文档
本章面向开发者,介绍系统的分层架构、关键设计、工程结构与开发规范。
设计与实现
- 整体架构:技术栈、后端分层、请求流程、认证与前端结构
- 数据模型:24 张表的字段与关系、双数据库脚本差异
- 账单解析:解析器策略模式、两阶段导入、去重与 zip 解密
- 规则引擎:规则模型与匹配逻辑
- AI 集成:RestClient 客户端、13 类调用类型与用量记录
- 定时通知:调度、渠道与发送日志
- 动态数据源:SQLite / MySQL 运行时配置与切换
- 前端用户偏好:偏好的存储介质、读写时机与完整清单
工程与规范
- 项目结构:目录组织与各包职责
- 构建与部署:
bootJar/bootGuiJar、jpackage 免安装包、发布产物下载与云服务器部署 - 开发环境与规范:AI 测试环境、前后端开发流程、代码规范、Git 提交规范
- 账单字段说明:支付宝账单导入字段的读取与丢弃情况
- API 文档:Knife4j(OpenAPI 3)接口文档
使用说明请查看使用文档。