Files
cmbone/docs/04-architecture.md
T

237 lines
8.5 KiB
Markdown
Raw Normal View History

2026-07-08 15:27:21 +08:00
# 架构设计
## 总览
```text
main.go
├─ Wails application
├─ embedded frontend/dist
├─ embedded frontend/src/locales/*.json
└─ services
├─ AppService
├─ AppConfigService
├─ HotkeyService
├─ SystemInfo
├─ OCRService # 当前存量示例
2026-07-08 23:37:19 +08:00
├─ AuthService # 已实现 provider 边界
├─ AuditLogService # 目标模块
├─ AppLogService # 目标模块
├─ ImageOptimizationService # 目标业务样例
└─ MetricsService # 目标模块
2026-07-08 15:27:21 +08:00
frontend/src
├─ router
├─ layouts
2026-07-08 15:27:21 +08:00
├─ pages
├─ components
├─ modules
2026-07-08 15:27:21 +08:00
├─ utils
└─ locales
```
前端通过 `frontend/bindings` 调用 Wails 暴露的 Go 服务。后端服务访问本地 SQLite、平台热键、文件系统、真实后端或 AI provider。
2026-07-08 15:27:21 +08:00
## 后端边界
- `main.go`:只负责应用组装、资源嵌入、服务注册和启动。
- `internal/models/`:定义数据库和服务返回的结构体。
- `internal/services/store.go`:负责 SQLite 连接、迁移和基础读写。
- `internal/services/appservice.go`:负责窗口、托盘、语言资源和应用生命周期。
- `internal/services/appconfig_service.go`:负责配置读写的 Wails 服务边界。
2026-07-09 00:12:30 +08:00
- `internal/services/settings_schema.go`:集中定义设置模块 schema、默认值、选项和初始化 SQL。
2026-07-08 15:27:21 +08:00
- `internal/services/hotkey_service.go`:负责热键读取、更新和重新注册。
- `internal/services/ocr_service.go`:当前 OCR 存量示例,后续可演进为图片 AI 能力的一部分。
2026-07-08 15:27:21 +08:00
- `platform/`:隔离 Windows / macOS 热键和系统能力差异。
2026-07-08 23:37:19 +08:00
已实现边界:
- `AuthService`:登录、退出、会话读取;内部通过 `AuthProvider` 接入本地固定账号或真实后端。当前 `LocalAuthProvider` 可用,`RemoteAuthProvider` 保留边界并返回未配置错误。
2026-07-09 00:12:30 +08:00
- `AppConfigService`:通过统一设置 schema 初始化和校验主题、语言、窗口行为、快捷键展示、数据目录、日志策略和登录配置。
2026-07-08 23:37:19 +08:00
目标新增边界:
- `AuditLogService`:记录和查询用户操作审计日志。
- `AppLogService`:记录和查询运行错误,必要时可落本地滚动日志文件。
- `ImageOptimizationService`:商品图片 AI 优化任务的创建、状态、结果和失败原因。
- `MetricsService`:对业务任务和日志做基础聚合,输出统计卡片和趋势数据。
2026-07-08 15:27:21 +08:00
服务之间不要互相绕过边界直接操作平台实现。新增平台能力时,优先放在 `platform/`,再由 `internal/services/` 暴露稳定方法。
## 前端边界
- `frontend/src/router/index.ts`:维护页面路由。
- `frontend/src/layouts/`:目标目录,放登录布局和主应用布局。
- `frontend/src/modules/auth/`:目标目录,放登录页面、会话状态和 provider 调用。
- `frontend/src/modules/settings/`:目标目录,放设置页和设置项。
- `frontend/src/modules/image-optimizer/`:目标目录,放商品图片 AI 优化样例。
- `frontend/src/modules/logs/`:目标目录,放审计日志和运行日志页面。
2026-07-08 23:06:48 +08:00
- `frontend/src/modules/statistics/`:放统计卡片和趋势图。
- `frontend/src/modules/components-demo/`:目标目录,放常用组件示例。
2026-07-08 23:06:48 +08:00
- `frontend/src/components/template/`:放当前模块占位页共享壳。
- `frontend/src/components/`:通用展示组件和组合控件。
- `frontend/src/utils/`:国际化、主题、OS、热键等工具函数。
2026-07-08 15:27:21 +08:00
- `frontend/bindings/`:由 Wails 生成或按 Wails 合约维护,不写业务逻辑。
## 登录架构
2026-07-08 23:37:19 +08:00
登录已经通过 provider 边界实现:
```text
AuthService
└─ AuthProvider
├─ LocalAuthProvider
└─ RemoteAuthProvider
```
- `LocalAuthProvider`:用于模板演示和离线模式,固定账号密码由后端配置或安全哈希保存,不写死在前端。
2026-07-08 23:37:19 +08:00
- `RemoteAuthProvider`:用于真实后端,负责请求登录接口并保存 token / session;当前只保留接口边界并返回未配置错误。
- 前端只关心登录、退出和当前会话,不关心 provider 细节。
2026-07-08 23:37:19 +08:00
- 默认本地账号由 `appconfig` 初始化,用户名为 `admin`,默认密码为 `admin123`,密码以 salt + SHA-256 hash 形式保存。
- 登录成功、失败和退出会写入 `audit_logs`。
## 日志架构
审计日志和运行日志分开:
- 审计日志:记录用户可解释动作,支持查询、筛选和导出。
- 运行日志:记录系统错误和排错信息,支持按时间、级别、模块查看。
审计日志用于“责任链”,运行日志用于“故障定位”。不要用一张表混合两种语义。
2026-07-08 15:27:21 +08:00
## 数据模型
SQLite 数据库位于用户配置目录下的 `cmbone/cmbone.db`,不进入 git。
当前核心表:
```sql
hotkeys(
id INTEGER PRIMARY KEY,
keycode INTEGER,
modifiers INTEGER,
description TEXT,
target TEXT
)
```
```sql
appconfig(
id INTEGER PRIMARY KEY,
key TEXT,
type TEXT,
value TEXT,
description TEXT,
state INTEGER
)
```
2026-07-09 00:12:30 +08:00
当前 `appconfig` 默认配置由统一设置 schema 生成:
- `theme.mode`、`language`
- `window.start_state`、`window.width`、`window.height`、`window.remember_state`
- `shortcut.open_second_window`、`shortcut.open_main_window`
- `data.root_mode`、`data.custom_directory`
- `logs.level`、`logs.audit_retention_days`、`logs.app_retention_days`
- `auth.provider`、`auth.local.username`、`auth.local.password_salt`、`auth.local.password_hash`
```sql
auth_sessions(
id INTEGER PRIMARY KEY,
user_id TEXT,
username TEXT,
provider TEXT,
token TEXT,
2026-07-08 23:37:19 +08:00
created_at TEXT,
expires_at TEXT,
active INTEGER
)
```
```sql
audit_logs(
id INTEGER PRIMARY KEY,
actor TEXT,
action TEXT,
target_type TEXT,
target_id TEXT,
detail TEXT,
2026-07-08 23:37:19 +08:00
created_at TEXT
)
```
2026-07-08 23:37:19 +08:00
目标新增表:
```sql
app_logs(
id INTEGER PRIMARY KEY,
level TEXT,
module TEXT,
message TEXT,
detail TEXT,
created_at DATETIME
)
```
```sql
image_tasks(
id INTEGER PRIMARY KEY,
source_path TEXT,
status TEXT,
operation TEXT,
duration_ms INTEGER,
error_message TEXT,
created_at DATETIME,
updated_at DATETIME
)
```
```sql
image_task_results(
id INTEGER PRIMARY KEY,
task_id INTEGER,
output_path TEXT,
before_size INTEGER,
after_size INTEGER,
created_at DATETIME
)
```
统计数据早期直接用 SQL 聚合,不急着落 `daily_metrics` 缓存表。数据量变大后再增加缓存表。
2026-07-08 15:27:21 +08:00
迁移要求:
- 初始化必须幂等。
- 新字段必须有默认值或迁移逻辑。
- schema 变化必须同步 `store_test.go`、`api.md` 和 `current-state.md`。
## 窗口与页面
2026-07-08 15:27:21 +08:00
2026-07-08 23:06:48 +08:00
- 主窗口路由:`/#/` 重定向到 `/#/dashboard`
2026-07-08 15:27:21 +08:00
- 第二窗口路由:`/#/second`
2026-07-08 23:06:48 +08:00
- 已实现主应用骨架路由:`/#/login`、`/#/dashboard`、`/#/image-optimizer`、`/#/logs`、`/#/statistics`、`/#/settings`、`/#/components`。
- 兼容目标文档路由:`/#/business/image-optimizer`、`/#/logs/audit`、`/#/logs/app` 会重定向到当前主入口。
2026-07-08 15:27:21 +08:00
- 托盘菜单由 `AppService` 配置。
- 热键触发目标可以是打开主窗口、打开快捷功能或创建快速任务。
2026-07-08 15:27:21 +08:00
2026-07-08 15:49:44 +08:00
窗口策略:
- 主窗口承载长期业务操作,默认不最大化。
- 主窗口初始尺寸为 `1280x800`,最小尺寸为 `1024x720`。
- 主窗口启动时居中,并允许用户调整大小。
- 前端根容器使用 `width: 100%` 和 `height: 100vh`。
- 主应用布局内部使用 flex 或 grid 填满窗口。
- 阅读型内容保留最大宽度,列表、仪表盘、设置页等工作型页面自适应拉伸。
- 第二窗口保持当前小窗定位,不参与最大化、尺寸恢复和主布局填充逻辑。
- 后续增强再保存主窗口尺寸和最大化状态,下次启动恢复用户选择。
2026-07-09 00:12:30 +08:00
实现状态:主窗口初始尺寸、居中、可调整大小、根容器和主布局填充已落地;主应用路由骨架已落地;登录 provider 边界已落地;设置模块统一 schema 已落地。窗口尺寸持久化下一步基于 `window.*` 配置实现。
2026-07-08 15:27:21 +08:00
## 关键风险
- 范围膨胀:模板容易变成“大而全平台”,必须按任务小步交付。
2026-07-08 15:27:21 +08:00
- Wails v3 仍是 alpha,CLI、Go 模块和 runtime 必须保持匹配。
- bindings 若与 Go 服务签名不一致,前端会在运行时失败。
- 登录 provider、AI provider 和日志模块必须有清晰边界,否则后续替换困难。
- OCR、热键、托盘依赖平台能力,跨平台修改必须分别验证。
2026-07-08 15:27:21 +08:00
- Vite 构建可能出现 chunk size warning,警告不等于失败,但需要避免无节制增加前端体积。