From e1d9873e63f339e65e0dee276a86dba0c6178a7e Mon Sep 17 00:00:00 2001 From: hunter Date: Mon, 25 May 2026 19:26:16 +0800 Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=20aiPrompt.md,=20gitHelp.md,?= =?UTF-8?q?=20ppts.html?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- aiPrompt.md | 304 ++++++++++++++++ gitHelp.md | 488 +++++++++++++++++++++++++ ppts.html | 1006 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 1798 insertions(+) create mode 100644 aiPrompt.md create mode 100644 gitHelp.md create mode 100644 ppts.html diff --git a/aiPrompt.md b/aiPrompt.md new file mode 100644 index 0000000..4838acd --- /dev/null +++ b/aiPrompt.md @@ -0,0 +1,304 @@ +# AI 开发提示词 — 项目架构与模块开发规范 + +> 在向 AI 提出开发需求时，将以下提示词附加在需求描述之后，AI 即可按照项目架构规范生成代码，避免多人协作时的合并冲突。 + +--- + +## 提示词内容（复制到你的需求后面） + +``` +## 项目架构与模块开发规范 + +### 一、项目概述 + +Under18 是一个前后端分离的 RBAC 权限管理脚手架，提供用户、角色、权限、字典、标签、日志等通用功能模块。采用模块化自动注册架构，新增功能模块时**严禁修改任何共享/公共文件**，所有新代码必须放在独立模块文件中。 + +**技术栈：** +- 后端：FastAPI + SQLAlchemy（异步）+ PostgreSQL + Alembic +- 前端：Vue 3 + Vite 5 + Element Plus + Pinia + Vue Router 4 +- 缓存：cachetools.TTLCache（进程内，替代 Redis） +- 认证：JWT（HS256），Access Token 120min + Refresh Token 7天 + +### 二、后端规范（FastAPI） + +#### 2.1 分层架构 + +``` +API 层 (app/api/{模块名}.py) — 路由定义、参数校验(Schema)、权限注入、响应封装 + ↓ 调用 +Service 层 (app/services/{模块名}_service.py) — 纯业务逻辑，静态方法，接收 AsyncSession + ↓ 操作 +Model 层 (app/models/{模块名}.py) — ORM 映射，继承 Base + TimestampMixin + SoftDeleteMixin +``` + +#### 2.2 新增模块只需创建以下独立文件，不需要修改任何已有文件： + +1. **`backend/app/models/{模块名}.py`** — ORM 模型定义 + - 从 `app.core.database` 导入 `Base` + - 从 `app.models.mixins` 导入 `TimestampMixin, SoftDeleteMixin`（日志类模型可不加 SoftDeleteMixin） + - 模型类继承：`class SysXxx(Base, TimestampMixin, SoftDeleteMixin)` + - 关联表（many-to-many）使用 `Table()` 定义在同一文件中 + - 每个模型需实现 `to_dict()` 方法手动序列化 + - 表名统一使用 `sys_` 前缀 + +2. **`backend/app/schemas/{模块名}.py`** — Pydantic 请求/响应模型 + - 每个模块的 schema 独立一个文件 + - 命名规范：`XxxCreateRequest`、`XxxUpdateRequest`、`XxxQueryRequest` + - 从 `app.schemas.response` 导入 `PageQuery` 作为分页查询基类 + +3. **`backend/app/services/{模块名}_service.py`** — 业务逻辑层 + - 类名必须以 `Service` 结尾（如 `ArticleService`），全部使用 `@staticmethod` + - 从 `app.models.{模块名}` 导入模型（不要从 app.models 或 app.models.models 导入） + - 从 `app.schemas.{模块名}` 导入 schema（不要从 app.schemas.request 导入） + - 所有方法第一个参数为 `db: AsyncSession` + - 调用方式：`ArticleService.get_list(db, ...)` + +4. **`backend/app/api/{模块名}.py`** — API 路由 + - 必须导出名为 `router` 的 `APIRouter` 实例 + - 示例：`router = APIRouter(prefix="/xxx", tags=["XXX管理"])` + - 所有路由自动加上 `/api` 前缀（由 `api_router = APIRouter(prefix="/api")` 控制） + - 从 `app.core.deps` 导入 `get_current_user`、`require_permission` + - 从 `app.schemas.response` 导入 `success`、`error`、`page_result` + - 路由文件会被 `app/api/__init__.py` 自动扫描注册，**不要修改 __init__.py** + +#### 2.3 自动注册机制 + +| 层 | 扫描规则 | 约定 | +|----|---------|------| +| API 路由 | 扫描 `app/api/` 下所有 `.py`，查找 `router` 变量 | 文件必须导出 `router = APIRouter(...)` | +| Model | 扫描 `app/models/` 下所有 `.py`（跳过 `__init__.py` 和 `mixins.py`） | 确保模型被导入到 Base.metadata | +| Service | 扫描 `app/services/` 下所有 `_service.py`，收集以 `Service` 结尾的类 | 可直接 `from app.services import XxxService` | + +**因此绝对不需要修改任何 `__init__.py` 文件。** + +#### 2.4 已有模型导入路径 + +```python +from app.models.user import SysUser, sys_user_role # 用户 + 用户角色关联表 +from app.models.role import SysRole, sys_role_permission # 角色 + 角色权限关联表 +from app.models.permission import SysPermission # 权限 +from app.models.dict import SysDictType, SysDictData # 字典类型 + 字典数据 +from app.models.log import SysOperationLog, SysLoginLog # 操作日志 + 登录日志 +from app.models.tag import SysTag, sys_tag_object # 标签 + 标签对象关联表 +from app.models.mixins import TimestampMixin, SoftDeleteMixin # 通用混入 +``` + +#### 2.5 响应格式统一 + +```python +from app.schemas.response import success, error, page_result + +# 成功：return success(data=xxx) +# 失败：return error(message="xxx", code=400) +# 分页：return page_result(items=xxx, total=xxx, page=xxx, page_size=xxx) +``` + +响应体格式： +```json +{ "code": 200, "message": "success", "data": {...} } +{ "code": 200, "message": "success", "data": { "items": [], "total": 0, "page": 1, "page_size": 10 } } +{ "code": 400, "message": "错误信息", "data": null } +``` + +#### 2.6 权限校验 + +- **路由级**：`dependencies=[Depends(require_permission("模块:资源:操作"))]` +- **按钮级**：前端使用 `v-permission="'模块:资源:操作'"` 指令 +- **权限编码格式**：`模块:资源:操作`，如 `content:article:list` +- **超级管理员豁免**：角色为 `admin` 的用户自动拥有全部权限 + +#### 2.7 认证与安全 + +- **密码加密**：`SHA-256(password + user_salt + global_salt)`，双重加盐 +- **Token 体系**：Access Token（120min）+ Refresh Token（7天），HS256 算法 +- **登录安全**：连续3次失败强制验证码；同IP 10次失败锁定30分钟；每IP每分钟限20次登录请求 +- **获取客户端IP**：使用 `SecurityMiddleware._get_client_ip(request)` + +#### 2.8 数据库与配置 + +- **数据库**：PostgreSQL，异步驱动 asyncpg，连接由 `app.core.database` 管理 +- **迁移**：Alembic，通过 `alembic revision --autogenerate` 生成 +- **配置**：唯一来源 `config.yaml`，环境变量 `UNDER18_<键名>` 可覆盖 +- **依赖注入**：`get_db()` 提供 AsyncSession，`get_current_user()` 提供当前用户 + +#### 2.9 路由定义注意事项 + +- 批量操作路由（如 `/batch`、`/clear/all`）必须定义在通配符路由（如 `/{id}`）之前，否则会被通配符匹配拦截 + +### 三、前端规范（Vue3 + Vite） + +#### 3.1 新增模块只需创建以下独立文件，不需要修改任何已有文件： + +1. **`frontend/src/router/modules/{模块名}.js`** — 路由配置 + - 必须 `export default` 一个路由配置对象 + - 会被 `router/index.js` 通过 `import.meta.glob` 自动扫描加载 + - **不要修改 `router/index.js`** + +2. **`frontend/src/views/{模块路径}/{子路由}/index.vue`** — 页面组件 + - 视图文件路径必须与路由中的 `component` 导入路径一致 + +3. **`frontend/src/api/{模块名}.js`** — API 调用函数 + - 从 `@/utils/request` 导入 axios 实例 + - 函数命名：`getXxxList`、`createXxx`、`updateXxx`、`deleteXxx` + +#### 3.2 路由配置模板 + +```javascript +// frontend/src/router/modules/{模块名}.js +export default { + path: '/{模块路径}', + component: () => import('@/layout/index.vue'), + redirect: '/{模块路径}/{默认子路由}', + meta: { title: '{菜单名称}', icon: '{ElementPlus图标名}' }, + children: [ + { + path: '{子路由}', + name: '{路由名}', + component: () => import('@/views/{模块路径}/{子路由}/index.vue'), + meta: { title: '{页面标题}', icon: '{图标}', permission: '{权限码}' }, + }, + ], +} +``` + +#### 3.3 侧边栏与权限 + +- 侧边栏菜单从 `router/modules/` 下的路由配置自动生成，**不需要修改 Sidebar.vue** +- 路由级权限：`meta.permission` 字段 + `filterRoutes()` 过滤无权限路由 +- 按钮级权限：`v-permission="'模块:资源:操作'"` 指令，无权限则隐藏元素 + +#### 3.4 Store 与工具 + +- **用户状态**：`store/user.js` — token、userInfo、权限列表，手动同步 localStorage +- **应用状态**：`store/app.js` — 侧边栏折叠、设备类型 +- **HTTP 请求**：`utils/request.js` — Axios 封装，自动添加 Bearer Token，统一错误处理（401弹窗重新登录、403无权限、429限流、500服务异常） +- **日期格式化**：`utils/index.js` 的 `formatDate()` 函数 +- **防抖**：`utils/index.js` 的 `debounce()` 函数 + +#### 3.5 样式约定 + +- 主题色：`#2d9d5e`（绿色系），通过 CSS 变量覆盖 Element Plus 默认主题 +- 布局变量：`--sidebar-width: 220px`，`--header-height: 56px` +- 新页面样式使用 ` + + + +
+ +
+
+ + +
+
+
+
+
+
+
+
+ psychology +
+

+ AI+OPC培训团队协作经验分享 +

+
+

+ 从项目管理到高效开发的实践探索 +

+
+
person洪涛
+
business昆山市公安局网安大队
+
calendar_today2026年5月25日
+
+
+ +
+ + +
+
+
+ person +

汇报人自我介绍

+
+
+
+
+
+ work_history +

工作经历

+
+
+
+
01
+
+

公安部第三研究所 - 北京锐安科技有限公司

+

JAVA全栈 ——> 技术经理 ——> 客户价值经理

+
+
+
+
02
+
+

武汉语智科技有限公司、合肥今迈信息科技有限公司

+

技术负责人

+
+
+
+
+
+
+ folder_special +

参与项目

+
+
+
SaaS开发：反诈专题、涉毒专题、反恐专题
+
安顺检察院执行监督平台
+
案件系统、重点人系统
+
株洲天元情指行系统
+
时空分析、关系分析
+
江西省厅交叉分析平台、执法办案数据上报系统
+
Paas开发：数据治理、Hadoop生态
+
海南省厅进出岛管理系统
+
数据服务、模型工场...
+
海口缉私图数融合、无人机警航系统
+
......
+
......
+
+
+
+
+
+
+ workspace_premium +

专业资质

+
+
+
+ PMP证书 +
PMP项目管理认证
+
+
+ 软考证书 +
软考高级认证
+
+
+
+
+
+
+ +
+ + +
+
+
+ code +

上次小组协作项目成果

+
+
+
+ + AI编程系统 +
+
+ open_in_new +

点击查看项目

+
+
+ +
+
+
+ schedule +

开发周期

3天

+
+
+ trending_up +

完成度

95%

+
+
+ groups +

团队参与

100%

+
+
+ info +

包括计算机小白在内的所有组员均亲手完成AI编码

+
+
+
+
+ +
+ + +
+
+
+ psychology +

需求协同 — 集思广益达成共识

+
+
+
+ +
+ 协同思维导图 +
+
+

协同思维导图 — 点击查看

+

实时协作 · 集思广益

+
+ +
+
+
+
01
+
+

协同思维导图贡献需求

+

使用在线思维导图工具，所有成员实时编辑，贡献系统功能和业务流的想法

+
+
+
+
02
+
+

集思广益覆盖功能与业务流

+

全方位收集系统功能需求，梳理完整业务流程，不遗漏关键场景

+
+
+
+
03
+
+

小组会议统一调整形成共识

+

召开小组会议讨论调整，确保需求得到全员一致性认可和明确

+
+
+
+ lightbulb +
+

实践意义

+

需求清晰统一，避免后期返工；全员参与需求定义，提升归属感与执行力

+
+
+
+
+
+ +
+ + +
+
+
+ assignment_turned_in +

任务分配与规范约束

+
+
+
+
+
+ account_tree +
+
Step 01
+

协同思维导图

+

明确功能与业务流

+
+
arrow_forward
+
+
+ how_to_reg +
+
Step 02
+

每人认领模块

+

对照导图分配开发

+
+
arrow_forward
+
+
+ construction +
+
Step 03
+

搭建脚手架

+

技术负责人搭建框架

+
+
arrow_forward
+
+
+ rule +
+
Step 04
+

统一规范

+

同框架同规范协作

+
+
+
+
+ person_add +
+

全员参与

+

包括计算机小白，每人对照需求思维导图认领独立模块，保证参与度和培训成效

+
+
+
+ source +
+

GIT仓库

+

技术负责人搭建GIT仓库，集中式版本控制，高效协作无冲突

+
+
+
+ verified +
+

规范约束

+

代码风格、命名约定、目录结构统一，降低协作摩擦成本

+
+
+
+
+ lightbulb +
+

实践意义

+

责任明确 → 参与充分 → 规范统一 → 零冲突协作。每个组员有明确的主人翁意识，技术负责人用架构和规范护航

+
+
+
+
+ +
+ + +
+
+
+ architecture +

零冲突协作架构设计

+
+
+
+
+
+ layers +

自动注册层

+
+
+
+

API Router

+

自动扫描注册

+
+
+

Model

+

ORM模型自动导入

+
+
+

Service

+

业务逻辑自动收集

+
+
+
+ +
+
+ settings +

核心基础设施层 (core/)

+
+
+
+

config.py

+

配置管理

+
+
+

database.py

+

数据库连接

+
+
+

security.py

+

安全认证

+
+
+

cache.py

+

缓存服务

+
+
+

middleware.py

+

中间件

+
+
+

deps.py

+

依赖注入

+
+
+
+ +
+
+ web +

前端分层架构

+
+
+
+

router/

+

路由自动扫描

+
+
+

views/

+

页面组件隔离

+
+
+

api/

+

API请求层

+
+
+

store/

+

状态管理

+
+
+
+
+ +
+
+
+ rule +

核心原则

+
+
+
+
+

每人只在独立模块文件工作

+
+
+
+

自动扫描注册机制

+
+
+
+

依赖注入解耦

+
+
+
+ +
+
+ verified_user +

模块自治

+
+
+
+ folder +

文件物理隔离

+
+
+ table_chart +

数据库表隔离

+
+
+ code +

命名空间隔离

+
+
+
+ +
+ lightbulb +
+

协作价值

+

零冲突协作，大幅降低协作成本

+
+
+
+
+
+ +
+ + +
+
+
+ description +

开发规范与提示词工程

+
+
+
+
+

+ verified提示词审核流程 +

+
+
+
1
+

组员编写提示词

基于脚手架规范撰写

+
+
arrow_downward
+
+
2
+

技术负责人审核修改

质量把控与优化

+
+
arrow_downward
+
+
3
+

返回组员使用

一轮对话生成可交付代码

+
+
+
+
+ lightbulb +
+

实践意义

+

审核机制保证提示词质量 → 一轮对话生成可交付级代码

+
+
+
+
+
+
+ code +
+

统一代码开发规范提示词

+

提供项目级别的开发规范提示词模板，所有组员在AI编码时附上该提示词，确保编码风格、命名约定、目录结构的一致性

+
+
+
+
+
+ stars +
+

高质量提示词样例

+

针对功能模块开发，提供一个高质量提示词样例供组员模仿。包含：上下文描述、技术约束、输入输出定义、边界条件等关键要素

+
+
+
+
+
+ fact_check +
+

提示词审核机制

+

组员写好的提示词先发给技术负责人修改审核，再发回组员使用。确保提示词的准确性、完整性和可执行性

+
+
+
+
+
+ auto_stories +
+

傻瓜式Git操作文档

+

提供一份简明的Git操作指南，讲清Git的作用和基础使用方法，让零基础的组员也能顺利参与版本控制

+
+
+
+
+
+
+ +
+ + +
+
+
+ source +

Git版本控制与团队协作

+
+
+
+
+ Git工作流程 +
+
+ account_tree +

Git协作工作流

+
+
+
+
+
+
+
+
+ info +

什么是Git

+
+

分布式版本控制系统，记录代码的每次变更，支持多人并行开发

+
+
+
+ sync +

基础操作

+
+

pull → branch → commit → push → merge

+
+
+
+

+ folderGit仓库地址 +

+
+ + link +

http://XX.72.101.113:8888/users/sign_in

+ + + link +

https://111.229.199.210

+ +
+
+
+
+ description +

傻瓜式操作文档

+
+

详细步骤说明，新手友好。从克隆仓库到提交代码，每一步都有截图和说明，零基础也能快速上手

+
+
+ lightbulb +
+

协作价值

+

Git让团队并行开发、版本可追溯、变更可回滚，是多人协作的必备基础设施

+
+
+
+
+
+ +
+ + +
+
+
+ check_circle +

核心要点总结

+
+
+
+
+ account_tree +

协同导图

+

集思广益

+
+
+ assignment_ind +

认领分工

+

全员参与

+
+
+ autorenew +

零冲突架构

+

自动注册机制

+
+
+ rule +

规范约束

+

统一标准

+
+
+
+
+ psychology +

提示词工程

+

模板样例+审核

+
+
+ source +

Git协作

+

版本可控

+
+
+ verified +

模块自治

+

低耦合

+
+
+ rocket_launch +

高效交付

+

3天完成

+
+
+
+ emoji_objects +

+ 协同导图 + + 认领分工 + + 自动注册 + + 规范约束 + + 提示词工程 + + Git协作 = + 高效AI开发 +

+
+
+
+ +
+ + +
+
+
+
+
+
+
+ favorite +
+

感谢聆听

+
+

欢迎交流探讨

+
+
+ phone +

139-1357-9181

+
+
+ forum +

期待您的反馈

+
+
+
+
emoji_objects

持续学习

+
trending_up

共同进步

+
groups

携手前行

+
+
+
+

AI+OPC培训团队协作经验分享 © 2026

+
+ +
+ +
+
+ + +
+
+ 提示词审核流程 +
+ chevron_right +
+
+
+ chevron_right + 点击继续翻页进入下一节 + chevron_right +
+
+ + + + + + +
1 / 10
+ + +
0分0秒
+ + + + +