kris/datai-vue
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
develop
datai-vue/docs/PROJECT_OVERVIEW.md

13 KiB
Raw Permalink Blame History

Datai-Vue 项目完整文档概览

生成时间：2026-02-02 项目路径：d:\idea_demo\datai-vue

📚 文档目录结构

docs/
├── Prompt/                          # AI 提示词库
│   ├── 0001-元提示词.md
│   ├── 0002-创建-trae-项目规则.md
│   ├── 0003-需求澄清提示词.md
│   ├── 0004-单一真源文档驱动架构师.md
│   ├── 0005-项目单一真源初始化专家.md
│   ├── 0006-api-docs-提示词.md
│   ├── 0007-changelog-提示词.md
│   ├── 0008-decisions-提示词.md
│   ├── 0009-design-提示词.md
│   ├── 0010-implementation-提示词.md
│   ├── 0011-method-logic-提示词.md
│   ├── 0012-prompts-提示词.md
│   ├── 0013-reference-code-提示词.md
│   ├── 0014-requirements-提示词.md
│   ├── 0015-retros-提示词.md
│   ├── 0016-sessions-提示词.md
│   ├── 0017-skill-提示词.md
│   ├── 0018-sql-提示词.md
│   └── README.md
│
├── api-docs/                        # API 接口文档
│   ├── system/                      # 系统模块 API
│   │   ├── 后端国际化 (2026-01-21-002-02)
│   │   │   ├── 2026-01-21-002-02-01-api-刷新国际化资源.md
│   │   │   ├── 2026-01-21-002-02-02-api-获取当前语言偏好.md
│   │   │   └── 2026-01-21-002-02-03-api-更新用户语言偏好.md
│   │   │
│   │   ├── 时区国际化 (2026-01-21-002-04)
│   │   │   ├── 2026-01-21-002-04-01-api-获取时区列表.md
│   │   │   ├── 2026-01-21-002-04-02-api-获取当前用户时区.md
│   │   │   ├── 2026-01-21-002-04-03-api-切换时区.md
│   │   │   ├── 2026-01-21-002-04-04-api-获取默认时区.md
│   │   │   ├── 2026-01-21-002-04-05-api-获取时区详细信息.md
│   │   │   └── 2026-01-21-002-04-06-api-刷新时区缓存.md
│   │   │
│   │   ├── 货币格式化 (2026-01-21-002-05)
│   │   │   ├── 2026-01-21-002-05-01-api-获取货币列表.md
│   │   │   ├── 2026-01-21-002-05-02-api-获取当前用户货币偏好.md
│   │   │   ├── 2026-01-21-002-05-03-api-切换货币.md
│   │   │   ├── 2026-01-21-002-05-04-api-获取系统默认货币.md
│   │   │   ├── 2026-01-21-002-05-05-api-获取汇率列表.md
│   │   │   ├── 2026-01-21-002-05-06-api-格式化货币.md
│   │   │   └── 2026-01-21-002-05-07-api-刷新汇率缓存.md
│   │   │
│   │   ├── 日期格式化 (2026-01-21-002-06)
│   │   │   ├── 2026-01-21-002-06-01-api-获取日期格式列表.md
│   │   │   ├── 2026-01-21-002-06-02-api-获取当前用户日期格式偏好.md
│   │   │   ├── 2026-01-21-002-06-03-api-切换日期格式.md
│   │   │   ├── 2026-01-21-002-06-04-api-获取系统默认日期格式.md
│   │   │   ├── 2026-01-21-002-06-05-api-格式化日期.md
│   │   │   └── 2026-01-21-002-06-06-api-刷新日期格式缓存.md
│   │   │
│   │   ├── 数字格式化 (2026-01-21-002-07)
│   │   │   ├── 2026-01-21-002-07-01-api-获取数字格式列表.md
│   │   │   ├── 2026-01-21-002-07-02-api-获取当前用户数字格式偏好.md
│   │   │   ├── 2026-01-21-002-07-03-api-切换数字格式.md
│   │   │   ├── 2026-01-21-002-07-04-api-获取系统默认数字格式.md
│   │   │   ├── 2026-01-21-002-07-05-api-格式化数字.md
│   │   │   └── 2026-01-21-002-07-06-api-刷新数字格式缓存.md
│   │   │
│   │   ├── 语言管理 (2026-01-26-002-08)
│   │   │   ├── 2026-01-26-002-08-01-api-查询语言列表.md
│   │   │   ├── 2026-01-26-002-08-02-api-获取语言详细信息.md
│   │   │   ├── 2026-01-26-002-08-03-api-新增语言.md
│   │   │   ├── 2026-01-26-002-08-04-api-修改语言.md
│   │   │   ├── 2026-01-26-002-08-05-api-删除语言.md
│   │   │   ├── 2026-01-26-002-08-06-api-设置默认语言.md
│   │   │   ├── 2026-01-26-002-08-07-api-修改语言状态.md
│   │   │   ├── 2026-01-26-002-08-08-api-获取默认语言.md
│   │   │   └── 2026-01-26-002-08-09-api-刷新语言缓存.md
│   │   │
│   │   ├── 国际化资源管理 (2026-01-26-002-09)
│   │   │   ├── 2026-01-26-002-09-01-api-查询国际化资源列表.md
│   │   │   ├── 2026-01-26-002-09-02-api-导出国际化资源.md
│   │   │   ├── 2026-01-26-002-09-03-api-获取资源详细信息.md
│   │   │   ├── 2026-01-26-002-09-04-api-新增国际化资源.md
│   │   │   ├── 2026-01-26-002-09-05-api-修改国际化资源.md
│   │   │   └── 2026-01-26-002-09-06-api-删除国际化资源.md
│   │   │
│   │   ├── 字典数据管理 (30个接口)
│   │   │   └── 2026-01-21-002-03-01 ~ 2026-01-21-002-03-30
│   │   │
│   │   ├── 汇总文档
│   │   │   ├── 2026-01-21-002-02-api-后端国际化.md
│   │   │   ├── 2026-01-21-002-03-api-数据库国际化.md
│   │   │   ├── 2026-01-21-002-04-api-时区国际化.md
│   │   │   ├── 2026-01-21-002-05-api-货币格式化.md
│   │   │   ├── 2026-01-21-002-06-api-日期格式化.md
│   │   │   ├── 2026-01-21-002-07-api-数字格式化.md
│   │   │   ├── 2026-01-26-002-08-api-语言管理.md
│   │   │   └── 2026-01-26-002-09-api-国际化资源管理.md
│   │
│   ├── 2026-01-26-002-02-api.md
│   ├── 2026-01-26-002-03-api.md
│   ├── README.md
│   └── index.md
│
├── changelog/                       # 变更日志
│   ├── 2026-01-26-002-01-changelog.md
│   ├── 2026-01-26-002-02-changelog.md
│   ├── 2026-01-26-002-03-changelog.md
│   └── README.md
│
├── decisions/                       # 架构决策记录 (ADR)
│   ├── 2026-01-26-002-01-ADR-前端国际化技术选型与架构决策.md
│   ├── 2026-01-26-002-02-ADR-前端国际化-核心模块实现策略决策.md
│   ├── 2026-01-26-002-03-ADR-前端国际化-动态资源实现策略决策.md
│   ├── 2026-01-26-002-04-ADR-前端国际化-业务模块实现策略决策.md
│   └── README.md
│
├── design/                          # 设计文档
│   ├── 2026-01-26-002-01-前端国际化技术方案.md
│   ├── 2026-01-26-002-01-前端国际化-基础架构-设计.md
│   ├── 2026-01-26-002-02-前端国际化-核心模块-设计.md
│   ├── 2026-01-26-002-03-前端国际化-动态资源-设计.md
│   ├── 2026-01-26-002-04-前端国际化-业务模块-设计.md
│   └── README.md
│
├── implementation/                  # 实现文档
│   └── README.md
│
├── method-logic/                    # 方法逻辑文档
│   └── README.md
│
├── prompts/                         # 提示词文档
│   ├── 2026-01-26-002-01-prompt-前端国际化-基础架构.md
│   ├── 2026-01-26-002-02-prompt-前端国际化-核心模块.md
│   ├── 2026-01-26-002-03-prompt-前端国际化-动态资源.md
│   ├── 2026-01-26-002-04-prompt-前端国际化-业务模块.md
│   └── README.md
│
├── reference-code/                  # 参考代码
│   └── README.md
│
├── requirements/                    # 需求文档
│   ├── 2026-01-26-001-前端国际化详细需求.md
│   ├── 2026-01-26-002-01-前端国际化-基础架构.md
│   ├── 2026-01-26-002-02-前端国际化-核心模块.md
│   ├── 2026-01-26-002-03-前端国际化-动态资源.md
│   ├── 2026-01-26-002-04-前端国际化-业务模块.md
│   └── README.md
│
├── retros/                          # 复盘文档
│   ├── 2026-01-26-002-01-retro.md
│   ├── 2026-01-26-002-02-retro.md
│   ├── 2026-01-26-002-03-retro.md
│   ├── 2026-01-26-002-04-retro.md
│   ├── 2026-01-26-002-split-session.md
│   └── README.md
│
├── sessions/                        # 会话记录
│   ├── 2026-01-26-002-01-session.md
│   ├── 2026-01-26-002-02-session.md
│   ├── 2026-01-26-002-03-session.md
│   ├── 2026-01-26-002-04-session.md
│   ├── 2026-01-26-002-split-session.md
│   └── README.md
│
├── skill/                           # 技能文档
│   └── README.md
│
├── sql/                             # SQL 文档
│   └── README.md
│
├── Authentication.canvas            # 认证流程图
├── PROJECT_OVERVIEW.md              # 本文档
└── index.md                         # 文档首页

🎯 核心功能模块

1. 国际化功能 (i18n)

已实现功能

  • ✅ 基础国际化框架 (Vue I18n)
  • ✅ 语言切换 (中文/英文)
  • ✅ 动态资源加载
  • ✅ 业务模块国际化 (Form, Flowable, Integration, Metadata, ModelMessage, Setting, Online, Tool, Auth, System)

待实现功能

  • ⏳ 时区管理 (7个接口)
  • ⏳ 货币格式化 (7个接口)
  • ⏳ 日期格式化 (6个接口)
  • ⏳ 数字格式化 (6个接口)
  • ⏳ 语言管理 (9个接口)
  • ⏳ 国际化资源管理 (6个接口)

2. 系统管理模块

  • 字典数据管理 (30个接口)
  • 参数配置管理
  • 菜单管理
  • 角色管理
  • 用户管理
  • 部门管理
  • 岗位管理

📊 API 接口统计

模块 接口数量 状态
后端国际化 3 ✅ 已设计
时区国际化 6 ⏳ 待实现
货币格式化 7 ⏳ 待实现
日期格式化 6 ⏳ 待实现
数字格式化 6 ⏳ 待实现
语言管理 9 ⏳ 待实现
国际化资源管理 6 ⏳ 待实现
字典数据管理 30 ✅ 已设计
总计 73 -

🔧 前端技术栈

  • 框架: Vue 3 + TypeScript
  • 构建工具: Vite
  • UI 组件库: Element Plus
  • 状态管理: Pinia
  • 路由: Vue Router
  • 国际化: Vue I18n
  • HTTP 客户端: Axios
  • 图表: ECharts
  • 流程图: bpmn-js

📁 关键源码文件

国际化相关

src/
├── locales/
│   ├── index.ts              # i18n 初始化
│   ├── zh-CN.ts              # 中文语言包
│   ├── en-US.ts              # 英文语言包
│   └── loader.ts             # 动态资源加载
│
├── components/LangSelect/    # 语言切换组件
│   └── index.vue
│
├── store/modules/app.ts      # 应用状态 (语言、尺寸等)
│
├── utils/
│   ├── formatCurrency.ts     # 货币格式化
│   ├── formatDuration.ts     # 时长格式化
│   ├── formatFileSize.ts     # 文件大小格式化
│   └── ruoyi.js              # 日期格式化 (parseTime)
│
└── api/system/
    └── language.js           # 语言相关 API

🚀 开发计划

第一阶段：基础架构 (已完成)

  • ✅ Vue I18n 集成
  • ✅ 语言切换组件
  • ✅ 基础语言包 (zh-CN, en-US)
  • ✅ 动态资源加载

第二阶段：业务模块国际化 (已完成)

  • ✅ Form 模块
  • ✅ Flowable 模块
  • ✅ Integration 模块
  • ✅ Metadata 模块
  • ✅ ModelMessage 模块
  • ✅ Setting 模块
  • ✅ Online 模块
  • ✅ Tool 模块
  • ✅ Auth 模块
  • ✅ System 模块

第三阶段：高级国际化功能 (待实现)

  • ⏳ 时区管理
  • ⏳ 货币格式化
  • ⏳ 日期格式管理
  • ⏳ 数字格式管理
  • ⏳ 语言管理后台
  • ⏳ 国际化资源管理后台

📌 待办事项

高优先级

  1. 扩展 App Store 支持时区、货币、日期格式、数字格式
  2. 创建时区、货币、日期格式、数字格式的 API 模块
  3. 更新前端工具函数支持动态 locale
  4. 重构 LangSelect 组件，集成多种偏好设置

中优先级

  1. 实现时区管理页面
  2. 实现货币管理页面
  3. 实现日期格式管理页面
  4. 实现数字格式管理页面

低优先级

  1. 实现语言管理后台
  2. 实现国际化资源管理后台
  3. 各种缓存刷新功能

📝 文档维护指南

新增文档命名规范

  • API 文档: YYYY-MM-DD-XXX-api-功能名称.md
  • 需求文档: YYYY-MM-DD-XXX-需求名称.md
  • 设计文档: YYYY-MM-DD-XXX-设计名称.md
  • 决策记录: YYYY-MM-DD-XXX-ADR-决策名称.md
  • 变更日志: YYYY-MM-DD-XXX-changelog.md
  • 复盘文档: YYYY-MM-DD-XXX-retro.md
  • 会话记录: YYYY-MM-DD-XXX-session.md

文档更新流程

  1. 在对应目录创建新文档
  2. 更新本概览文档
  3. 更新索引文件 (index.md)
  4. 提交到版本控制

🔗 相关链接

本文档由 SSOT 架构师维护，最后更新时间：2026-02-02