Files
cmbone/docs/method-map.md
T

116 lines
6.5 KiB
Markdown
Raw Normal View History

2026-07-08 15:27:21 +08:00
# 方法地图
> 维护者查找入口时先看这里,再进入具体文件。
## 应用启动
| 文件 | 方法 / 内容 | 说明 |
| --- | --- | --- |
| `main.go` | `main()` | 创建 Wails app、注册服务、嵌入资源、启动应用 |
| `internal/services/appservice.go` | `ConfigureAppService` | 配置窗口、托盘、语言资源和生命周期 |
2026-07-09 00:34:47 +08:00
| `internal/services/window_state.go` | main window state helpers | 读取和保存主窗口尺寸、最大化状态;第二窗口不参与 |
2026-07-08 15:27:21 +08:00
## 存储
| 文件 | 方法 / 内容 | 说明 |
| --- | --- | --- |
| `internal/services/store.go` | `NewSuiStore` | 打开 SQLite 并执行初始化 |
| `internal/services/store.go` | migration / CRUD 方法 | 初始化 `hotkeys`、`appconfig` 并提供基础读写 |
| `internal/services/store_test.go` | store 测试 | 覆盖存储初始化和关键读写 |
## 配置
| 文件 | 方法 / 内容 | 说明 |
| --- | --- | --- |
| `internal/services/appconfig_service.go` | `GetAppConfig` / `SetAppConfig` | 前端配置读写入口 |
| `internal/services/appconfig_service.go` | `GetLanguage` / `SetLanguage` | 语言配置读写入口 |
2026-07-09 00:12:30 +08:00
| `internal/services/appconfig_service.go` | `GetSettingsSchema` | 返回设置分组、默认值和当前值 |
| `internal/services/settings_schema.go` | settings schema | 集中定义主题、语言、窗口、快捷键、数据目录、日志策略和登录配置 |
| `internal/models/settings.go` | `AppSettingGroup` / `AppSettingDefinition` | 设置 schema 前端绑定模型 |
2026-07-08 15:27:21 +08:00
2026-07-08 23:37:19 +08:00
## 登录
| 文件 | 方法 / 内容 | 说明 |
| --- | --- | --- |
| `internal/services/auth_service.go` | `AuthService` | 登录、退出、当前会话和 auth mode |
| `internal/services/auth_service.go` | `LocalAuthProvider` | 校验后端初始化的本地固定账号 |
| `internal/services/auth_service.go` | `RemoteAuthProvider` | 真实后端登录 provider 预留边界 |
| `internal/models/auth.go` | `AuthSession` / `AuthProviderOption` | 前端绑定模型 |
| `frontend/src/modules/auth/LoginPage.vue` | 登录页 | 调用后端 AuthService,不写死账号密码 |
2026-07-09 00:47:35 +08:00
## 图片优化任务
| 文件 | 方法 / 内容 | 说明 |
| --- | --- | --- |
| `internal/services/image_optimization_service.go` | `ImageOptimizationService` | 创建本地模拟图片优化任务、查询任务和结果 |
| `internal/models/image_task.go` | `ImageTask` / `ImageTaskResult` / `ImageTaskDetail` | 图片优化任务绑定模型 |
| `frontend/bindings/cmbone/internal/services/imageoptimizationservice.js` | Wails binding | 前端调用图片优化任务服务的生成绑定 |
2026-07-09 00:55:46 +08:00
## 日志
| 文件 | 方法 / 内容 | 说明 |
| --- | --- | --- |
| `internal/services/log_service.go` | `AuditLogService` | 记录和查询用户动作审计日志 |
| `internal/services/log_service.go` | `AppLogService` | 记录和查询运行排错日志 |
| `internal/models/log.go` | `AuditLogFilter` / `AppLog` / `AppLogFilter` | 日志查询绑定模型 |
| `frontend/bindings/cmbone/internal/services/auditlogservice.js` | Wails binding | 前端调用审计日志服务的生成绑定 |
| `frontend/bindings/cmbone/internal/services/applogservice.js` | Wails binding | 前端调用运行日志服务的生成绑定 |
2026-07-09 01:04:50 +08:00
## 数据统计
| 文件 | 方法 / 内容 | 说明 |
| --- | --- | --- |
| `internal/services/metrics_service.go` | `MetricsService` | 查询 P0 统计卡片和最近 N 天处理趋势 |
| `internal/models/metrics.go` | `DashboardMetrics` / `DailyMetric` | 统计服务绑定模型 |
| `frontend/bindings/cmbone/internal/services/metricsservice.js` | Wails binding | 前端调用统计服务的生成绑定 |
## 目标模板模块
| 模块 | 目标服务 | 说明 |
| --- | --- | --- |
2026-07-08 23:37:19 +08:00
| 登录 | `AuthService` | 已实现本地固定账号 provider,真实后端 provider 保留边界 |
2026-07-09 00:55:46 +08:00
| 审计日志 | `AuditLogService` | 已实现记录和查询;登录、设置变更、图片任务创建已接入 |
| 运行日志 | `AppLogService` | 已实现记录和查询;图片任务失败和服务错误已接入 |
2026-07-09 01:11:48 +08:00
| 商品图片 AI 优化 | `ImageOptimizationService` | 已实现本地模拟任务模型和页面闭环 |
2026-07-09 01:04:50 +08:00
| 数据统计 | `MetricsService` | 已实现后端聚合;统计页面展示待后续扩展 |
2026-07-08 15:27:21 +08:00
## 热键
| 文件 | 方法 / 内容 | 说明 |
| --- | --- | --- |
| `internal/services/hotkey_service.go` | `GetHotkeys` | 返回当前热键配置 |
| `internal/services/hotkey_service.go` | `UpHotkey` | 更新热键并重新注册 |
| `platform/hotkey_windows.go` | Windows 热键实现 | Windows 平台注册逻辑 |
| `platform/hotkey_darwin.go` | macOS 热键实现 | macOS 平台注册逻辑 |
## 前端
| 文件 | 方法 / 内容 | 说明 |
| --- | --- | --- |
| `frontend/src/main.ts` | Vue 入口 | 注册应用、路由和国际化 |
2026-07-08 23:06:48 +08:00
| `frontend/src/router/index.ts` | routes | 登录、主应用模块和第二窗口路由 |
| `frontend/src/layouts/MainLayout.vue` | 主窗口布局 | 侧边导航、顶部窗口区和 `RouterView` 内容区 |
| `frontend/src/components/template/ModulePageShell.vue` | 模块页共享壳 | 模块标题、状态和摘要卡片 |
2026-07-08 23:37:19 +08:00
| `frontend/src/modules/auth/LoginPage.vue` | 登录页 | 调用 AuthService 登录并处理错误 |
2026-07-08 23:06:48 +08:00
| `frontend/src/modules/dashboard/DashboardPage.vue` | 工作台骨架 | P0 指标和近期任务入口 |
2026-07-09 01:11:48 +08:00
| `frontend/src/modules/image-optimizer/ImageOptimizerPage.vue` | 主业务页面 | 商品图片 AI 优化任务创建、列表、状态和结果预览 |
2026-07-08 23:06:48 +08:00
| `frontend/src/modules/logs/LogsPage.vue` | 日志页骨架 | 审计日志和运行日志入口 |
| `frontend/src/modules/statistics/StatisticsPage.vue` | 统计页骨架 | P0 指标和 7 天趋势入口 |
2026-07-09 00:12:30 +08:00
| `frontend/src/modules/settings/SettingsPage.vue` | 设置页 | 复用存量设置组件,并展示后端统一设置 schema |
2026-07-08 23:06:48 +08:00
| `frontend/src/modules/components-demo/ComponentsDemoPage.vue` | 组件示例骨架 | 常用表单、筛选、表格和状态标签 |
2026-07-08 15:27:21 +08:00
| `frontend/src/pages/Home/Index.vue` | 第二窗口入口 | OCR 示例页面 |
| `frontend/src/utils/ThemeManager.ts` | 主题工具 | 主题切换和持久化协作 |
| `frontend/src/utils/i18n.ts` | 国际化工具 | 语言资源和切换 |
## 目标前端目录
| 目录 | 说明 |
| --- | --- |
| `frontend/src/layouts/` | 登录布局和主应用布局 |
| `frontend/src/modules/auth/` | 登录和会话 |
| `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/` | 常用组件示例 |