feat: AI工具配置文件内嵌完整规则 — 打开项目即自动生效
改为单一信源+内容嵌入模式: - RULES.md: 唯一规范信源(218行) - scripts/sync-ai-rules.sh: 一键同步脚本 - 7个工具配置文件全部内嵌完整规则内容(非引用) 支持的AI工具(打开项目自动加载): - AGENTS.md → Codex CLI / Claude Code - .cursorrules → Cursor IDE - .github/copilot-instructions.md → GitHub Copilot - .windsurfrules → Windsurf / Codeium - .clinerules → Cline - .qwenrules → Qwen Coder / 通义灵码 - .aider.conf.yml → Aider 使用: 编辑 RULES.md 后运行 bash scripts/sync-ai-rules.sh
This commit is contained in:
224
.aider.conf.yml
224
.aider.conf.yml
@@ -1,4 +1,222 @@
|
||||
# Aider configuration for HealthLink-HIS
|
||||
# Aider reads instructions from the files listed below
|
||||
instruction-files:
|
||||
- RULES.md
|
||||
# Aider 自动读取此文件获取开发规范
|
||||
|
||||
instructions: |
|
||||
# HealthLink-HIS — AI 开发规范（自动加载）
|
||||
|
||||
> 🤖 **本文件供所有 AI 编码工具自动读取**。无论使用 Claude Code、Cursor、Codex CLI、Copilot、Qwen、Cline 还是其他工具，进入本项目后必须遵守以下规范。
|
||||
|
||||
---
|
||||
|
||||
## 一、项目概览
|
||||
|
||||
| 属性 | 值 |
|
||||
|------|------|
|
||||
| 项目名 | HealthLink-HIS（医院信息系统） |
|
||||
| 后端路径 | `healthlink-his-server/` |
|
||||
| 前端路径 | `healthlink-his-ui/` |
|
||||
| 文档路径 | `MD/` |
|
||||
| JDK | 25 (OpenJDK) |
|
||||
| Spring Boot | 4.0.6 |
|
||||
| Vue | 3.x + Vite + Element Plus |
|
||||
| 数据库 | PostgreSQL 15+ |
|
||||
| 包名 | `com.healthlink.his` |
|
||||
|
||||
---
|
||||
|
||||
## 二、铁律（必须遵守，违反即失败）
|
||||
|
||||
### 🔴 P0 铁律 — 不可违反
|
||||
|
||||
**铁律1: 修改完必须测试**
|
||||
```
|
||||
后端: mvn clean compile -DskipTests → mvn install -DskipTests → mvn test
|
||||
前端: npm run build:dev → npm run lint
|
||||
```
|
||||
- 白盒：编译通过，无 ERROR
|
||||
- 黑盒：关键接口返回 `{code:200, data:...}`
|
||||
- 冒烟：应用正常启动，核心流程通畅
|
||||
|
||||
**铁律2: Flyway 数据库迁移**
|
||||
- 凡是新建表、新增字段，必须创建 Flyway 迁移脚本
|
||||
- 路径：`healthlink-his-domain/src/main/resources/db/migration/`
|
||||
- 命名：`V{版本号}__{描述}.sql`（双下划线）
|
||||
- 禁止直接在数据库执行 SQL 不走 Flyway
|
||||
|
||||
**铁律3: 测试通过后才提交**
|
||||
- 编译 + 测试全部通过后才能 git commit
|
||||
- 不提交未完成的功能、调试代码、临时文件
|
||||
|
||||
**铁律4: 前后端API路径对齐**
|
||||
- 后端前缀：`/healthlink-his/api/v1/`
|
||||
- 前端 `request.js` 的 baseURL 必须与后端匹配
|
||||
- 接口变更必须同步更新前后端代码
|
||||
|
||||
### 🟡 P1 铁律 — 强烈建议
|
||||
|
||||
**铁律5: 先分解再行动**
|
||||
- 修改超过3个文件、涉及多模块、数据库变更，必须先制定计划
|
||||
|
||||
**铁律6: 验证后信**
|
||||
- 每次修改后必须验证编译通过，不信记忆
|
||||
- 重新编译命令：`mvn clean compile -DskipTests`
|
||||
|
||||
**铁律7: 文档统一管理**
|
||||
- 所有文档存储在 `MD/` 目录
|
||||
- 文件名：大写英文+下划线（如 `BACKEND_CHECKLIST.md`）
|
||||
- 文档头部必须包含元数据块（文档类型、版本、日期）
|
||||
|
||||
**铁律8: 规范文档在 MD/specs/**
|
||||
- 完整铁律：`MD/specs/IRON_RULES.md`
|
||||
- 后端规范：`MD/specs/BACKEND_DEVELOPMENT_STANDARD.md`
|
||||
- 前端规范：`MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md`
|
||||
|
||||
---
|
||||
|
||||
## 三、后端开发规范
|
||||
|
||||
### 分层架构
|
||||
```
|
||||
Controller → AppService → Service → Mapper → Entity
|
||||
接收请求 编排业务 单表CRUD 数据访问 实体定义
|
||||
```
|
||||
|
||||
### 命名规范
|
||||
| 类型 | 规则 | 示例 |
|
||||
|------|------|------|
|
||||
| Controller | `XxxController` | `RegistrationController` |
|
||||
| AppService | `IXxxAppService` / `XxxAppServiceImpl` | `IRegistrationAppService` |
|
||||
| Service | `IXxxService` / `XxxServiceImpl` | `IRegistrationService` |
|
||||
| Mapper | `XxxMapper` | `RegistrationMapper` |
|
||||
| Entity | `Xxx` | `Registration` |
|
||||
| DTO | `XxxDto` / `XxxQueryDto` | `RegistrationDto` |
|
||||
|
||||
### 包结构
|
||||
```
|
||||
com.healthlink.his.web.{module}.controller
|
||||
com.healthlink.his.web.{module}.appservice
|
||||
com.healthlink.his.web.{module}.service
|
||||
com.healthlink.his.web.{module}.mapper
|
||||
com.healthlink.his.web.{module}.dto
|
||||
com.healthlink.his.domain.{module}
|
||||
com.healthlink.his.common.enums
|
||||
```
|
||||
|
||||
### 统一返回格式
|
||||
```java
|
||||
// 成功
|
||||
AjaxResult.success(data)
|
||||
// 失败
|
||||
AjaxResult.error("错误信息")
|
||||
// 列表
|
||||
getDataTable(list)
|
||||
```
|
||||
|
||||
### 关键约束
|
||||
- 所有查询使用 `LambdaQueryWrapper`，禁止字符串拼接 SQL
|
||||
- `@Transactional(rollbackFor = Exception.class)` 管理事务
|
||||
- 所有接口标注 `@PreAuthorize` 权限控制
|
||||
- 患者敏感信息（身份证、手机号）在日志中脱敏
|
||||
- 扩展功能不要修改原有函数签名，新建 Service/AppService
|
||||
|
||||
---
|
||||
|
||||
## 四、前端开发规范
|
||||
|
||||
### 技术栈
|
||||
- Vue 3 + Vite + Element Plus + Pinia + Axios
|
||||
- 基于 RuoYi-Vue3 框架
|
||||
|
||||
### 目录结构
|
||||
```
|
||||
src/api/{module}/ # API接口（kebab-case路径）
|
||||
src/views/{module}/ # 页面组件
|
||||
src/store/modules/ # Pinia状态管理
|
||||
src/components/ # 公共组件
|
||||
```
|
||||
|
||||
### API 路径规范
|
||||
```javascript
|
||||
// 统一前缀 /healthlink-his/api/v1/
|
||||
export function listXxx(query) {
|
||||
return request({ url: '/healthlink-his/api/v1/xxx/list', method: 'get', params: query })
|
||||
}
|
||||
```
|
||||
|
||||
### 组件规范
|
||||
- 页面组件使用 `<script setup>` 语法
|
||||
- 弹窗组件使用 `defineExpose({ open })` 暴露打开方法
|
||||
- 列表必须支持分页（`pagination` 组件）
|
||||
- 按钮权限使用 `v-hasPermi` 指令
|
||||
|
||||
### 关键约束
|
||||
- 路由懒加载：`() => import('@/views/xxx/index.vue')`
|
||||
- 不使用 `v-html`（除非做 XSS 转义）
|
||||
- 不在前端硬编码密码、密钥
|
||||
- `onMounted` 中注册的事件在 `onUnmounted` 中移除
|
||||
|
||||
---
|
||||
|
||||
## 五、开发流程
|
||||
|
||||
```
|
||||
1. 分析需求 → 读相关文档(MD/)
|
||||
2. 制定计划 → update_plan
|
||||
3. 后端开发 → Controller → AppService → Service → Mapper → Entity → Flyway
|
||||
4. 后端测试 → mvn test → 接口测试通过
|
||||
5. 前端开发 → API接口 → 页面组件 → 路由配置
|
||||
6. 前端测试 → npm run build:dev → 功能验证
|
||||
7. 提交代码 → git add → git commit(规范格式) → git push
|
||||
```
|
||||
|
||||
### Git Commit 格式
|
||||
```
|
||||
<type>(<scope>): <subject>
|
||||
|
||||
type: feat|fix|docs|refactor|test|chore
|
||||
scope: 模块名(如 registration, billing, pharmacy)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 六、快速参考命令
|
||||
|
||||
```bash
|
||||
# === 后端 ===
|
||||
export JAVA_HOME=/opt/jdk-25
|
||||
mvn clean compile -DskipTests # 编译
|
||||
mvn install -DskipTests # 完整构建
|
||||
mvn test -pl healthlink-his-application -Dtest="XxxTest" -Dsurefire.failIfNoSpecifiedTests=false # 测试
|
||||
|
||||
# === 前端 ===
|
||||
cd healthlink-his-ui
|
||||
npm run dev # 开发模式
|
||||
npm run build:dev # 构建
|
||||
npm run lint # 代码检查
|
||||
npm run test:run # 单元测试
|
||||
|
||||
# === Git ===
|
||||
git status # 查看变更
|
||||
git add -A # 暂存所有
|
||||
git commit -m "feat(module): description" # 提交
|
||||
git push origin develop # 推送
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 七、详细规范文档索引
|
||||
|
||||
| 文档 | 路径 | 用途 |
|
||||
|------|------|------|
|
||||
| 执行铁律 | `MD/specs/IRON_RULES.md` | 铁律完整版 |
|
||||
| 后端规范 | `MD/specs/BACKEND_DEVELOPMENT_STANDARD.md` | 后端编码标准 |
|
||||
| 前端规范 | `MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md` | 前端编码标准 |
|
||||
| 文档规范 | `MD/DOCUMENTATION_STANDARD.md` | 文档管理标准 |
|
||||
| 后端清单 | `MD/specs/BACKEND_CHECKLIST.md` | 发布前检查 |
|
||||
| 前端清单 | `MD/specs/FRONTEND_CHECKLIST.md` | 发布前检查 |
|
||||
| 三甲标准 | `MD/standards/GRADE3A_HIS_STANDARD.md` | 三甲医院达标标准 |
|
||||
| Flyway指南 | `MD/guides/FLYWAY_USAGE_GUIDE.md` | 数据库迁移指南 |
|
||||
|
||||
---
|
||||
|
||||
> ⚠️ **警告**: 本文件是项目 AI 开发规范的唯一信源。各工具配置文件（AGENTS.md、.cursorrules 等）均引用本文件。修改规范请只修改本文件。
|
||||
|
||||
229
.clinerules
229
.clinerules
@@ -1,3 +1,228 @@
|
||||
# HealthLink-HIS Cline Rules
|
||||
# HealthLink-HIS — AI 开发规范 (Cline)
|
||||
|
||||
Read RULES.md in the project root. It contains all iron rules and development standards for this project.
|
||||
> 🤖 Cline 打开本项目时自动加载此文件。
|
||||
|
||||
---
|
||||
|
||||
# HealthLink-HIS — AI 开发规范（自动加载）
|
||||
|
||||
> 🤖 **本文件供所有 AI 编码工具自动读取**。无论使用 Claude Code、Cursor、Codex CLI、Copilot、Qwen、Cline 还是其他工具，进入本项目后必须遵守以下规范。
|
||||
|
||||
---
|
||||
|
||||
## 一、项目概览
|
||||
|
||||
| 属性 | 值 |
|
||||
|------|------|
|
||||
| 项目名 | HealthLink-HIS（医院信息系统） |
|
||||
| 后端路径 | `healthlink-his-server/` |
|
||||
| 前端路径 | `healthlink-his-ui/` |
|
||||
| 文档路径 | `MD/` |
|
||||
| JDK | 25 (OpenJDK) |
|
||||
| Spring Boot | 4.0.6 |
|
||||
| Vue | 3.x + Vite + Element Plus |
|
||||
| 数据库 | PostgreSQL 15+ |
|
||||
| 包名 | `com.healthlink.his` |
|
||||
|
||||
---
|
||||
|
||||
## 二、铁律（必须遵守，违反即失败）
|
||||
|
||||
### 🔴 P0 铁律 — 不可违反
|
||||
|
||||
**铁律1: 修改完必须测试**
|
||||
```
|
||||
后端: mvn clean compile -DskipTests → mvn install -DskipTests → mvn test
|
||||
前端: npm run build:dev → npm run lint
|
||||
```
|
||||
- 白盒：编译通过，无 ERROR
|
||||
- 黑盒：关键接口返回 `{code:200, data:...}`
|
||||
- 冒烟：应用正常启动，核心流程通畅
|
||||
|
||||
**铁律2: Flyway 数据库迁移**
|
||||
- 凡是新建表、新增字段，必须创建 Flyway 迁移脚本
|
||||
- 路径：`healthlink-his-domain/src/main/resources/db/migration/`
|
||||
- 命名：`V{版本号}__{描述}.sql`（双下划线）
|
||||
- 禁止直接在数据库执行 SQL 不走 Flyway
|
||||
|
||||
**铁律3: 测试通过后才提交**
|
||||
- 编译 + 测试全部通过后才能 git commit
|
||||
- 不提交未完成的功能、调试代码、临时文件
|
||||
|
||||
**铁律4: 前后端API路径对齐**
|
||||
- 后端前缀：`/healthlink-his/api/v1/`
|
||||
- 前端 `request.js` 的 baseURL 必须与后端匹配
|
||||
- 接口变更必须同步更新前后端代码
|
||||
|
||||
### 🟡 P1 铁律 — 强烈建议
|
||||
|
||||
**铁律5: 先分解再行动**
|
||||
- 修改超过3个文件、涉及多模块、数据库变更，必须先制定计划
|
||||
|
||||
**铁律6: 验证后信**
|
||||
- 每次修改后必须验证编译通过，不信记忆
|
||||
- 重新编译命令：`mvn clean compile -DskipTests`
|
||||
|
||||
**铁律7: 文档统一管理**
|
||||
- 所有文档存储在 `MD/` 目录
|
||||
- 文件名：大写英文+下划线（如 `BACKEND_CHECKLIST.md`）
|
||||
- 文档头部必须包含元数据块（文档类型、版本、日期）
|
||||
|
||||
**铁律8: 规范文档在 MD/specs/**
|
||||
- 完整铁律：`MD/specs/IRON_RULES.md`
|
||||
- 后端规范：`MD/specs/BACKEND_DEVELOPMENT_STANDARD.md`
|
||||
- 前端规范：`MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md`
|
||||
|
||||
---
|
||||
|
||||
## 三、后端开发规范
|
||||
|
||||
### 分层架构
|
||||
```
|
||||
Controller → AppService → Service → Mapper → Entity
|
||||
接收请求 编排业务 单表CRUD 数据访问 实体定义
|
||||
```
|
||||
|
||||
### 命名规范
|
||||
| 类型 | 规则 | 示例 |
|
||||
|------|------|------|
|
||||
| Controller | `XxxController` | `RegistrationController` |
|
||||
| AppService | `IXxxAppService` / `XxxAppServiceImpl` | `IRegistrationAppService` |
|
||||
| Service | `IXxxService` / `XxxServiceImpl` | `IRegistrationService` |
|
||||
| Mapper | `XxxMapper` | `RegistrationMapper` |
|
||||
| Entity | `Xxx` | `Registration` |
|
||||
| DTO | `XxxDto` / `XxxQueryDto` | `RegistrationDto` |
|
||||
|
||||
### 包结构
|
||||
```
|
||||
com.healthlink.his.web.{module}.controller
|
||||
com.healthlink.his.web.{module}.appservice
|
||||
com.healthlink.his.web.{module}.service
|
||||
com.healthlink.his.web.{module}.mapper
|
||||
com.healthlink.his.web.{module}.dto
|
||||
com.healthlink.his.domain.{module}
|
||||
com.healthlink.his.common.enums
|
||||
```
|
||||
|
||||
### 统一返回格式
|
||||
```java
|
||||
// 成功
|
||||
AjaxResult.success(data)
|
||||
// 失败
|
||||
AjaxResult.error("错误信息")
|
||||
// 列表
|
||||
getDataTable(list)
|
||||
```
|
||||
|
||||
### 关键约束
|
||||
- 所有查询使用 `LambdaQueryWrapper`，禁止字符串拼接 SQL
|
||||
- `@Transactional(rollbackFor = Exception.class)` 管理事务
|
||||
- 所有接口标注 `@PreAuthorize` 权限控制
|
||||
- 患者敏感信息（身份证、手机号）在日志中脱敏
|
||||
- 扩展功能不要修改原有函数签名，新建 Service/AppService
|
||||
|
||||
---
|
||||
|
||||
## 四、前端开发规范
|
||||
|
||||
### 技术栈
|
||||
- Vue 3 + Vite + Element Plus + Pinia + Axios
|
||||
- 基于 RuoYi-Vue3 框架
|
||||
|
||||
### 目录结构
|
||||
```
|
||||
src/api/{module}/ # API接口（kebab-case路径）
|
||||
src/views/{module}/ # 页面组件
|
||||
src/store/modules/ # Pinia状态管理
|
||||
src/components/ # 公共组件
|
||||
```
|
||||
|
||||
### API 路径规范
|
||||
```javascript
|
||||
// 统一前缀 /healthlink-his/api/v1/
|
||||
export function listXxx(query) {
|
||||
return request({ url: '/healthlink-his/api/v1/xxx/list', method: 'get', params: query })
|
||||
}
|
||||
```
|
||||
|
||||
### 组件规范
|
||||
- 页面组件使用 `<script setup>` 语法
|
||||
- 弹窗组件使用 `defineExpose({ open })` 暴露打开方法
|
||||
- 列表必须支持分页（`pagination` 组件）
|
||||
- 按钮权限使用 `v-hasPermi` 指令
|
||||
|
||||
### 关键约束
|
||||
- 路由懒加载：`() => import('@/views/xxx/index.vue')`
|
||||
- 不使用 `v-html`（除非做 XSS 转义）
|
||||
- 不在前端硬编码密码、密钥
|
||||
- `onMounted` 中注册的事件在 `onUnmounted` 中移除
|
||||
|
||||
---
|
||||
|
||||
## 五、开发流程
|
||||
|
||||
```
|
||||
1. 分析需求 → 读相关文档(MD/)
|
||||
2. 制定计划 → update_plan
|
||||
3. 后端开发 → Controller → AppService → Service → Mapper → Entity → Flyway
|
||||
4. 后端测试 → mvn test → 接口测试通过
|
||||
5. 前端开发 → API接口 → 页面组件 → 路由配置
|
||||
6. 前端测试 → npm run build:dev → 功能验证
|
||||
7. 提交代码 → git add → git commit(规范格式) → git push
|
||||
```
|
||||
|
||||
### Git Commit 格式
|
||||
```
|
||||
<type>(<scope>): <subject>
|
||||
|
||||
type: feat|fix|docs|refactor|test|chore
|
||||
scope: 模块名(如 registration, billing, pharmacy)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 六、快速参考命令
|
||||
|
||||
```bash
|
||||
# === 后端 ===
|
||||
export JAVA_HOME=/opt/jdk-25
|
||||
mvn clean compile -DskipTests # 编译
|
||||
mvn install -DskipTests # 完整构建
|
||||
mvn test -pl healthlink-his-application -Dtest="XxxTest" -Dsurefire.failIfNoSpecifiedTests=false # 测试
|
||||
|
||||
# === 前端 ===
|
||||
cd healthlink-his-ui
|
||||
npm run dev # 开发模式
|
||||
npm run build:dev # 构建
|
||||
npm run lint # 代码检查
|
||||
npm run test:run # 单元测试
|
||||
|
||||
# === Git ===
|
||||
git status # 查看变更
|
||||
git add -A # 暂存所有
|
||||
git commit -m "feat(module): description" # 提交
|
||||
git push origin develop # 推送
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 七、详细规范文档索引
|
||||
|
||||
| 文档 | 路径 | 用途 |
|
||||
|------|------|------|
|
||||
| 执行铁律 | `MD/specs/IRON_RULES.md` | 铁律完整版 |
|
||||
| 后端规范 | `MD/specs/BACKEND_DEVELOPMENT_STANDARD.md` | 后端编码标准 |
|
||||
| 前端规范 | `MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md` | 前端编码标准 |
|
||||
| 文档规范 | `MD/DOCUMENTATION_STANDARD.md` | 文档管理标准 |
|
||||
| 后端清单 | `MD/specs/BACKEND_CHECKLIST.md` | 发布前检查 |
|
||||
| 前端清单 | `MD/specs/FRONTEND_CHECKLIST.md` | 发布前检查 |
|
||||
| 三甲标准 | `MD/standards/GRADE3A_HIS_STANDARD.md` | 三甲医院达标标准 |
|
||||
| Flyway指南 | `MD/guides/FLYWAY_USAGE_GUIDE.md` | 数据库迁移指南 |
|
||||
|
||||
---
|
||||
|
||||
> ⚠️ **警告**: 本文件是项目 AI 开发规范的唯一信源。各工具配置文件（AGENTS.md、.cursorrules 等）均引用本文件。修改规范请只修改本文件。
|
||||
|
||||
---
|
||||
|
||||
> 📅 最后同步: 2026-06-06 09:46 | 源文件: RULES.md | 重新同步: `bash scripts/sync-ai-rules.sh`
|
||||
|
||||
239
.cursorrules
239
.cursorrules
@@ -1,17 +1,228 @@
|
||||
# HealthLink-HIS AI Development Rules
|
||||
# HealthLink-HIS — AI 开发规范 (Cursor)
|
||||
|
||||
Read and follow RULES.md in the project root. It contains all iron rules and development standards.
|
||||
> 🤖 Cursor IDE 打开本项目时自动加载此文件。
|
||||
|
||||
## Key Rules
|
||||
- All code changes must pass compilation tests before commit
|
||||
- Database changes must use Flyway migration scripts
|
||||
- Follow the layered architecture: Controller → AppService → Service → Mapper → Entity
|
||||
- API prefix: /healthlink-his/api/v1/
|
||||
- Package: com.healthlink.his
|
||||
- Backend: Spring Boot 4.0.6, JDK 25, MyBatis-Plus 3.5.16
|
||||
- Frontend: Vue 3, Vite, Element Plus, Pinia
|
||||
---
|
||||
|
||||
## File Structure
|
||||
- Backend: healthlink-his-server/
|
||||
- Frontend: healthlink-his-ui/
|
||||
- Docs: MD/ (all specs in MD/specs/)
|
||||
# HealthLink-HIS — AI 开发规范（自动加载）
|
||||
|
||||
> 🤖 **本文件供所有 AI 编码工具自动读取**。无论使用 Claude Code、Cursor、Codex CLI、Copilot、Qwen、Cline 还是其他工具，进入本项目后必须遵守以下规范。
|
||||
|
||||
---
|
||||
|
||||
## 一、项目概览
|
||||
|
||||
| 属性 | 值 |
|
||||
|------|------|
|
||||
| 项目名 | HealthLink-HIS（医院信息系统） |
|
||||
| 后端路径 | `healthlink-his-server/` |
|
||||
| 前端路径 | `healthlink-his-ui/` |
|
||||
| 文档路径 | `MD/` |
|
||||
| JDK | 25 (OpenJDK) |
|
||||
| Spring Boot | 4.0.6 |
|
||||
| Vue | 3.x + Vite + Element Plus |
|
||||
| 数据库 | PostgreSQL 15+ |
|
||||
| 包名 | `com.healthlink.his` |
|
||||
|
||||
---
|
||||
|
||||
## 二、铁律（必须遵守，违反即失败）
|
||||
|
||||
### 🔴 P0 铁律 — 不可违反
|
||||
|
||||
**铁律1: 修改完必须测试**
|
||||
```
|
||||
后端: mvn clean compile -DskipTests → mvn install -DskipTests → mvn test
|
||||
前端: npm run build:dev → npm run lint
|
||||
```
|
||||
- 白盒：编译通过，无 ERROR
|
||||
- 黑盒：关键接口返回 `{code:200, data:...}`
|
||||
- 冒烟：应用正常启动，核心流程通畅
|
||||
|
||||
**铁律2: Flyway 数据库迁移**
|
||||
- 凡是新建表、新增字段，必须创建 Flyway 迁移脚本
|
||||
- 路径：`healthlink-his-domain/src/main/resources/db/migration/`
|
||||
- 命名：`V{版本号}__{描述}.sql`（双下划线）
|
||||
- 禁止直接在数据库执行 SQL 不走 Flyway
|
||||
|
||||
**铁律3: 测试通过后才提交**
|
||||
- 编译 + 测试全部通过后才能 git commit
|
||||
- 不提交未完成的功能、调试代码、临时文件
|
||||
|
||||
**铁律4: 前后端API路径对齐**
|
||||
- 后端前缀：`/healthlink-his/api/v1/`
|
||||
- 前端 `request.js` 的 baseURL 必须与后端匹配
|
||||
- 接口变更必须同步更新前后端代码
|
||||
|
||||
### 🟡 P1 铁律 — 强烈建议
|
||||
|
||||
**铁律5: 先分解再行动**
|
||||
- 修改超过3个文件、涉及多模块、数据库变更，必须先制定计划
|
||||
|
||||
**铁律6: 验证后信**
|
||||
- 每次修改后必须验证编译通过，不信记忆
|
||||
- 重新编译命令：`mvn clean compile -DskipTests`
|
||||
|
||||
**铁律7: 文档统一管理**
|
||||
- 所有文档存储在 `MD/` 目录
|
||||
- 文件名：大写英文+下划线（如 `BACKEND_CHECKLIST.md`）
|
||||
- 文档头部必须包含元数据块（文档类型、版本、日期）
|
||||
|
||||
**铁律8: 规范文档在 MD/specs/**
|
||||
- 完整铁律：`MD/specs/IRON_RULES.md`
|
||||
- 后端规范：`MD/specs/BACKEND_DEVELOPMENT_STANDARD.md`
|
||||
- 前端规范：`MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md`
|
||||
|
||||
---
|
||||
|
||||
## 三、后端开发规范
|
||||
|
||||
### 分层架构
|
||||
```
|
||||
Controller → AppService → Service → Mapper → Entity
|
||||
接收请求 编排业务 单表CRUD 数据访问 实体定义
|
||||
```
|
||||
|
||||
### 命名规范
|
||||
| 类型 | 规则 | 示例 |
|
||||
|------|------|------|
|
||||
| Controller | `XxxController` | `RegistrationController` |
|
||||
| AppService | `IXxxAppService` / `XxxAppServiceImpl` | `IRegistrationAppService` |
|
||||
| Service | `IXxxService` / `XxxServiceImpl` | `IRegistrationService` |
|
||||
| Mapper | `XxxMapper` | `RegistrationMapper` |
|
||||
| Entity | `Xxx` | `Registration` |
|
||||
| DTO | `XxxDto` / `XxxQueryDto` | `RegistrationDto` |
|
||||
|
||||
### 包结构
|
||||
```
|
||||
com.healthlink.his.web.{module}.controller
|
||||
com.healthlink.his.web.{module}.appservice
|
||||
com.healthlink.his.web.{module}.service
|
||||
com.healthlink.his.web.{module}.mapper
|
||||
com.healthlink.his.web.{module}.dto
|
||||
com.healthlink.his.domain.{module}
|
||||
com.healthlink.his.common.enums
|
||||
```
|
||||
|
||||
### 统一返回格式
|
||||
```java
|
||||
// 成功
|
||||
AjaxResult.success(data)
|
||||
// 失败
|
||||
AjaxResult.error("错误信息")
|
||||
// 列表
|
||||
getDataTable(list)
|
||||
```
|
||||
|
||||
### 关键约束
|
||||
- 所有查询使用 `LambdaQueryWrapper`，禁止字符串拼接 SQL
|
||||
- `@Transactional(rollbackFor = Exception.class)` 管理事务
|
||||
- 所有接口标注 `@PreAuthorize` 权限控制
|
||||
- 患者敏感信息（身份证、手机号）在日志中脱敏
|
||||
- 扩展功能不要修改原有函数签名，新建 Service/AppService
|
||||
|
||||
---
|
||||
|
||||
## 四、前端开发规范
|
||||
|
||||
### 技术栈
|
||||
- Vue 3 + Vite + Element Plus + Pinia + Axios
|
||||
- 基于 RuoYi-Vue3 框架
|
||||
|
||||
### 目录结构
|
||||
```
|
||||
src/api/{module}/ # API接口（kebab-case路径）
|
||||
src/views/{module}/ # 页面组件
|
||||
src/store/modules/ # Pinia状态管理
|
||||
src/components/ # 公共组件
|
||||
```
|
||||
|
||||
### API 路径规范
|
||||
```javascript
|
||||
// 统一前缀 /healthlink-his/api/v1/
|
||||
export function listXxx(query) {
|
||||
return request({ url: '/healthlink-his/api/v1/xxx/list', method: 'get', params: query })
|
||||
}
|
||||
```
|
||||
|
||||
### 组件规范
|
||||
- 页面组件使用 `<script setup>` 语法
|
||||
- 弹窗组件使用 `defineExpose({ open })` 暴露打开方法
|
||||
- 列表必须支持分页（`pagination` 组件）
|
||||
- 按钮权限使用 `v-hasPermi` 指令
|
||||
|
||||
### 关键约束
|
||||
- 路由懒加载：`() => import('@/views/xxx/index.vue')`
|
||||
- 不使用 `v-html`（除非做 XSS 转义）
|
||||
- 不在前端硬编码密码、密钥
|
||||
- `onMounted` 中注册的事件在 `onUnmounted` 中移除
|
||||
|
||||
---
|
||||
|
||||
## 五、开发流程
|
||||
|
||||
```
|
||||
1. 分析需求 → 读相关文档(MD/)
|
||||
2. 制定计划 → update_plan
|
||||
3. 后端开发 → Controller → AppService → Service → Mapper → Entity → Flyway
|
||||
4. 后端测试 → mvn test → 接口测试通过
|
||||
5. 前端开发 → API接口 → 页面组件 → 路由配置
|
||||
6. 前端测试 → npm run build:dev → 功能验证
|
||||
7. 提交代码 → git add → git commit(规范格式) → git push
|
||||
```
|
||||
|
||||
### Git Commit 格式
|
||||
```
|
||||
<type>(<scope>): <subject>
|
||||
|
||||
type: feat|fix|docs|refactor|test|chore
|
||||
scope: 模块名(如 registration, billing, pharmacy)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 六、快速参考命令
|
||||
|
||||
```bash
|
||||
# === 后端 ===
|
||||
export JAVA_HOME=/opt/jdk-25
|
||||
mvn clean compile -DskipTests # 编译
|
||||
mvn install -DskipTests # 完整构建
|
||||
mvn test -pl healthlink-his-application -Dtest="XxxTest" -Dsurefire.failIfNoSpecifiedTests=false # 测试
|
||||
|
||||
# === 前端 ===
|
||||
cd healthlink-his-ui
|
||||
npm run dev # 开发模式
|
||||
npm run build:dev # 构建
|
||||
npm run lint # 代码检查
|
||||
npm run test:run # 单元测试
|
||||
|
||||
# === Git ===
|
||||
git status # 查看变更
|
||||
git add -A # 暂存所有
|
||||
git commit -m "feat(module): description" # 提交
|
||||
git push origin develop # 推送
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 七、详细规范文档索引
|
||||
|
||||
| 文档 | 路径 | 用途 |
|
||||
|------|------|------|
|
||||
| 执行铁律 | `MD/specs/IRON_RULES.md` | 铁律完整版 |
|
||||
| 后端规范 | `MD/specs/BACKEND_DEVELOPMENT_STANDARD.md` | 后端编码标准 |
|
||||
| 前端规范 | `MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md` | 前端编码标准 |
|
||||
| 文档规范 | `MD/DOCUMENTATION_STANDARD.md` | 文档管理标准 |
|
||||
| 后端清单 | `MD/specs/BACKEND_CHECKLIST.md` | 发布前检查 |
|
||||
| 前端清单 | `MD/specs/FRONTEND_CHECKLIST.md` | 发布前检查 |
|
||||
| 三甲标准 | `MD/standards/GRADE3A_HIS_STANDARD.md` | 三甲医院达标标准 |
|
||||
| Flyway指南 | `MD/guides/FLYWAY_USAGE_GUIDE.md` | 数据库迁移指南 |
|
||||
|
||||
---
|
||||
|
||||
> ⚠️ **警告**: 本文件是项目 AI 开发规范的唯一信源。各工具配置文件（AGENTS.md、.cursorrules 等）均引用本文件。修改规范请只修改本文件。
|
||||
|
||||
---
|
||||
|
||||
> 📅 最后同步: 2026-06-06 09:46 | 源文件: RULES.md | 重新同步: `bash scripts/sync-ai-rules.sh`
|
||||
|
||||
235
.github/copilot-instructions.md
vendored
235
.github/copilot-instructions.md
vendored
@@ -1,11 +1,228 @@
|
||||
# HealthLink-HIS — GitHub Copilot Instructions
|
||||
# HealthLink-HIS — AI 开发规范 (GitHub Copilot)
|
||||
|
||||
Read RULES.md in the project root for complete development standards.
|
||||
> 🤖 GitHub Copilot 打开本项目时自动加载此文件。
|
||||
|
||||
## Quick Reference
|
||||
- Backend: healthlink-his-server/ (Spring Boot 4.0.6, JDK 25, MyBatis-Plus 3.5.16)
|
||||
- Frontend: healthlink-his-ui/ (Vue 3, Vite, Element Plus)
|
||||
- Package: com.healthlink.his
|
||||
- API prefix: /healthlink-his/api/v1/
|
||||
- All DB changes via Flyway: healthlink-his-domain/src/main/resources/db/migration/
|
||||
- Test before commit: mvn clean compile -DskipTests && npm run build:dev
|
||||
---
|
||||
|
||||
# HealthLink-HIS — AI 开发规范（自动加载）
|
||||
|
||||
> 🤖 **本文件供所有 AI 编码工具自动读取**。无论使用 Claude Code、Cursor、Codex CLI、Copilot、Qwen、Cline 还是其他工具，进入本项目后必须遵守以下规范。
|
||||
|
||||
---
|
||||
|
||||
## 一、项目概览
|
||||
|
||||
| 属性 | 值 |
|
||||
|------|------|
|
||||
| 项目名 | HealthLink-HIS（医院信息系统） |
|
||||
| 后端路径 | `healthlink-his-server/` |
|
||||
| 前端路径 | `healthlink-his-ui/` |
|
||||
| 文档路径 | `MD/` |
|
||||
| JDK | 25 (OpenJDK) |
|
||||
| Spring Boot | 4.0.6 |
|
||||
| Vue | 3.x + Vite + Element Plus |
|
||||
| 数据库 | PostgreSQL 15+ |
|
||||
| 包名 | `com.healthlink.his` |
|
||||
|
||||
---
|
||||
|
||||
## 二、铁律（必须遵守，违反即失败）
|
||||
|
||||
### 🔴 P0 铁律 — 不可违反
|
||||
|
||||
**铁律1: 修改完必须测试**
|
||||
```
|
||||
后端: mvn clean compile -DskipTests → mvn install -DskipTests → mvn test
|
||||
前端: npm run build:dev → npm run lint
|
||||
```
|
||||
- 白盒：编译通过，无 ERROR
|
||||
- 黑盒：关键接口返回 `{code:200, data:...}`
|
||||
- 冒烟：应用正常启动，核心流程通畅
|
||||
|
||||
**铁律2: Flyway 数据库迁移**
|
||||
- 凡是新建表、新增字段，必须创建 Flyway 迁移脚本
|
||||
- 路径：`healthlink-his-domain/src/main/resources/db/migration/`
|
||||
- 命名：`V{版本号}__{描述}.sql`（双下划线）
|
||||
- 禁止直接在数据库执行 SQL 不走 Flyway
|
||||
|
||||
**铁律3: 测试通过后才提交**
|
||||
- 编译 + 测试全部通过后才能 git commit
|
||||
- 不提交未完成的功能、调试代码、临时文件
|
||||
|
||||
**铁律4: 前后端API路径对齐**
|
||||
- 后端前缀：`/healthlink-his/api/v1/`
|
||||
- 前端 `request.js` 的 baseURL 必须与后端匹配
|
||||
- 接口变更必须同步更新前后端代码
|
||||
|
||||
### 🟡 P1 铁律 — 强烈建议
|
||||
|
||||
**铁律5: 先分解再行动**
|
||||
- 修改超过3个文件、涉及多模块、数据库变更，必须先制定计划
|
||||
|
||||
**铁律6: 验证后信**
|
||||
- 每次修改后必须验证编译通过，不信记忆
|
||||
- 重新编译命令：`mvn clean compile -DskipTests`
|
||||
|
||||
**铁律7: 文档统一管理**
|
||||
- 所有文档存储在 `MD/` 目录
|
||||
- 文件名：大写英文+下划线（如 `BACKEND_CHECKLIST.md`）
|
||||
- 文档头部必须包含元数据块（文档类型、版本、日期）
|
||||
|
||||
**铁律8: 规范文档在 MD/specs/**
|
||||
- 完整铁律：`MD/specs/IRON_RULES.md`
|
||||
- 后端规范：`MD/specs/BACKEND_DEVELOPMENT_STANDARD.md`
|
||||
- 前端规范：`MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md`
|
||||
|
||||
---
|
||||
|
||||
## 三、后端开发规范
|
||||
|
||||
### 分层架构
|
||||
```
|
||||
Controller → AppService → Service → Mapper → Entity
|
||||
接收请求 编排业务 单表CRUD 数据访问 实体定义
|
||||
```
|
||||
|
||||
### 命名规范
|
||||
| 类型 | 规则 | 示例 |
|
||||
|------|------|------|
|
||||
| Controller | `XxxController` | `RegistrationController` |
|
||||
| AppService | `IXxxAppService` / `XxxAppServiceImpl` | `IRegistrationAppService` |
|
||||
| Service | `IXxxService` / `XxxServiceImpl` | `IRegistrationService` |
|
||||
| Mapper | `XxxMapper` | `RegistrationMapper` |
|
||||
| Entity | `Xxx` | `Registration` |
|
||||
| DTO | `XxxDto` / `XxxQueryDto` | `RegistrationDto` |
|
||||
|
||||
### 包结构
|
||||
```
|
||||
com.healthlink.his.web.{module}.controller
|
||||
com.healthlink.his.web.{module}.appservice
|
||||
com.healthlink.his.web.{module}.service
|
||||
com.healthlink.his.web.{module}.mapper
|
||||
com.healthlink.his.web.{module}.dto
|
||||
com.healthlink.his.domain.{module}
|
||||
com.healthlink.his.common.enums
|
||||
```
|
||||
|
||||
### 统一返回格式
|
||||
```java
|
||||
// 成功
|
||||
AjaxResult.success(data)
|
||||
// 失败
|
||||
AjaxResult.error("错误信息")
|
||||
// 列表
|
||||
getDataTable(list)
|
||||
```
|
||||
|
||||
### 关键约束
|
||||
- 所有查询使用 `LambdaQueryWrapper`，禁止字符串拼接 SQL
|
||||
- `@Transactional(rollbackFor = Exception.class)` 管理事务
|
||||
- 所有接口标注 `@PreAuthorize` 权限控制
|
||||
- 患者敏感信息（身份证、手机号）在日志中脱敏
|
||||
- 扩展功能不要修改原有函数签名，新建 Service/AppService
|
||||
|
||||
---
|
||||
|
||||
## 四、前端开发规范
|
||||
|
||||
### 技术栈
|
||||
- Vue 3 + Vite + Element Plus + Pinia + Axios
|
||||
- 基于 RuoYi-Vue3 框架
|
||||
|
||||
### 目录结构
|
||||
```
|
||||
src/api/{module}/ # API接口（kebab-case路径）
|
||||
src/views/{module}/ # 页面组件
|
||||
src/store/modules/ # Pinia状态管理
|
||||
src/components/ # 公共组件
|
||||
```
|
||||
|
||||
### API 路径规范
|
||||
```javascript
|
||||
// 统一前缀 /healthlink-his/api/v1/
|
||||
export function listXxx(query) {
|
||||
return request({ url: '/healthlink-his/api/v1/xxx/list', method: 'get', params: query })
|
||||
}
|
||||
```
|
||||
|
||||
### 组件规范
|
||||
- 页面组件使用 `<script setup>` 语法
|
||||
- 弹窗组件使用 `defineExpose({ open })` 暴露打开方法
|
||||
- 列表必须支持分页（`pagination` 组件）
|
||||
- 按钮权限使用 `v-hasPermi` 指令
|
||||
|
||||
### 关键约束
|
||||
- 路由懒加载：`() => import('@/views/xxx/index.vue')`
|
||||
- 不使用 `v-html`（除非做 XSS 转义）
|
||||
- 不在前端硬编码密码、密钥
|
||||
- `onMounted` 中注册的事件在 `onUnmounted` 中移除
|
||||
|
||||
---
|
||||
|
||||
## 五、开发流程
|
||||
|
||||
```
|
||||
1. 分析需求 → 读相关文档(MD/)
|
||||
2. 制定计划 → update_plan
|
||||
3. 后端开发 → Controller → AppService → Service → Mapper → Entity → Flyway
|
||||
4. 后端测试 → mvn test → 接口测试通过
|
||||
5. 前端开发 → API接口 → 页面组件 → 路由配置
|
||||
6. 前端测试 → npm run build:dev → 功能验证
|
||||
7. 提交代码 → git add → git commit(规范格式) → git push
|
||||
```
|
||||
|
||||
### Git Commit 格式
|
||||
```
|
||||
<type>(<scope>): <subject>
|
||||
|
||||
type: feat|fix|docs|refactor|test|chore
|
||||
scope: 模块名(如 registration, billing, pharmacy)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 六、快速参考命令
|
||||
|
||||
```bash
|
||||
# === 后端 ===
|
||||
export JAVA_HOME=/opt/jdk-25
|
||||
mvn clean compile -DskipTests # 编译
|
||||
mvn install -DskipTests # 完整构建
|
||||
mvn test -pl healthlink-his-application -Dtest="XxxTest" -Dsurefire.failIfNoSpecifiedTests=false # 测试
|
||||
|
||||
# === 前端 ===
|
||||
cd healthlink-his-ui
|
||||
npm run dev # 开发模式
|
||||
npm run build:dev # 构建
|
||||
npm run lint # 代码检查
|
||||
npm run test:run # 单元测试
|
||||
|
||||
# === Git ===
|
||||
git status # 查看变更
|
||||
git add -A # 暂存所有
|
||||
git commit -m "feat(module): description" # 提交
|
||||
git push origin develop # 推送
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 七、详细规范文档索引
|
||||
|
||||
| 文档 | 路径 | 用途 |
|
||||
|------|------|------|
|
||||
| 执行铁律 | `MD/specs/IRON_RULES.md` | 铁律完整版 |
|
||||
| 后端规范 | `MD/specs/BACKEND_DEVELOPMENT_STANDARD.md` | 后端编码标准 |
|
||||
| 前端规范 | `MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md` | 前端编码标准 |
|
||||
| 文档规范 | `MD/DOCUMENTATION_STANDARD.md` | 文档管理标准 |
|
||||
| 后端清单 | `MD/specs/BACKEND_CHECKLIST.md` | 发布前检查 |
|
||||
| 前端清单 | `MD/specs/FRONTEND_CHECKLIST.md` | 发布前检查 |
|
||||
| 三甲标准 | `MD/standards/GRADE3A_HIS_STANDARD.md` | 三甲医院达标标准 |
|
||||
| Flyway指南 | `MD/guides/FLYWAY_USAGE_GUIDE.md` | 数据库迁移指南 |
|
||||
|
||||
---
|
||||
|
||||
> ⚠️ **警告**: 本文件是项目 AI 开发规范的唯一信源。各工具配置文件（AGENTS.md、.cursorrules 等）均引用本文件。修改规范请只修改本文件。
|
||||
|
||||
---
|
||||
|
||||
> 📅 最后同步: 2026-06-06 09:46 | 源文件: RULES.md | 重新同步: `bash scripts/sync-ai-rules.sh`
|
||||
|
||||
233
.qwenrules
233
.qwenrules
@@ -1,9 +1,228 @@
|
||||
# HealthLink-HIS Development Rules
|
||||
# HealthLink-HIS — AI 开发规范 (Qwen Coder)
|
||||
|
||||
Read RULES.md in the project root for all development standards and iron rules.
|
||||
> 🤖 通义灵码 / Qwen Coder 打开本项目时自动加载此文件。
|
||||
|
||||
This is a hospital information system (HIS) project.
|
||||
Backend: healthlink-his-server/ (Spring Boot 4.0.6, JDK 25)
|
||||
Frontend: healthlink-his-ui/ (Vue 3, Vite, Element Plus)
|
||||
Package: com.healthlink.his
|
||||
Always follow the iron rules defined in RULES.md.
|
||||
---
|
||||
|
||||
# HealthLink-HIS — AI 开发规范（自动加载）
|
||||
|
||||
> 🤖 **本文件供所有 AI 编码工具自动读取**。无论使用 Claude Code、Cursor、Codex CLI、Copilot、Qwen、Cline 还是其他工具，进入本项目后必须遵守以下规范。
|
||||
|
||||
---
|
||||
|
||||
## 一、项目概览
|
||||
|
||||
| 属性 | 值 |
|
||||
|------|------|
|
||||
| 项目名 | HealthLink-HIS（医院信息系统） |
|
||||
| 后端路径 | `healthlink-his-server/` |
|
||||
| 前端路径 | `healthlink-his-ui/` |
|
||||
| 文档路径 | `MD/` |
|
||||
| JDK | 25 (OpenJDK) |
|
||||
| Spring Boot | 4.0.6 |
|
||||
| Vue | 3.x + Vite + Element Plus |
|
||||
| 数据库 | PostgreSQL 15+ |
|
||||
| 包名 | `com.healthlink.his` |
|
||||
|
||||
---
|
||||
|
||||
## 二、铁律（必须遵守，违反即失败）
|
||||
|
||||
### 🔴 P0 铁律 — 不可违反
|
||||
|
||||
**铁律1: 修改完必须测试**
|
||||
```
|
||||
后端: mvn clean compile -DskipTests → mvn install -DskipTests → mvn test
|
||||
前端: npm run build:dev → npm run lint
|
||||
```
|
||||
- 白盒：编译通过，无 ERROR
|
||||
- 黑盒：关键接口返回 `{code:200, data:...}`
|
||||
- 冒烟：应用正常启动，核心流程通畅
|
||||
|
||||
**铁律2: Flyway 数据库迁移**
|
||||
- 凡是新建表、新增字段，必须创建 Flyway 迁移脚本
|
||||
- 路径：`healthlink-his-domain/src/main/resources/db/migration/`
|
||||
- 命名：`V{版本号}__{描述}.sql`（双下划线）
|
||||
- 禁止直接在数据库执行 SQL 不走 Flyway
|
||||
|
||||
**铁律3: 测试通过后才提交**
|
||||
- 编译 + 测试全部通过后才能 git commit
|
||||
- 不提交未完成的功能、调试代码、临时文件
|
||||
|
||||
**铁律4: 前后端API路径对齐**
|
||||
- 后端前缀：`/healthlink-his/api/v1/`
|
||||
- 前端 `request.js` 的 baseURL 必须与后端匹配
|
||||
- 接口变更必须同步更新前后端代码
|
||||
|
||||
### 🟡 P1 铁律 — 强烈建议
|
||||
|
||||
**铁律5: 先分解再行动**
|
||||
- 修改超过3个文件、涉及多模块、数据库变更，必须先制定计划
|
||||
|
||||
**铁律6: 验证后信**
|
||||
- 每次修改后必须验证编译通过，不信记忆
|
||||
- 重新编译命令：`mvn clean compile -DskipTests`
|
||||
|
||||
**铁律7: 文档统一管理**
|
||||
- 所有文档存储在 `MD/` 目录
|
||||
- 文件名：大写英文+下划线（如 `BACKEND_CHECKLIST.md`）
|
||||
- 文档头部必须包含元数据块（文档类型、版本、日期）
|
||||
|
||||
**铁律8: 规范文档在 MD/specs/**
|
||||
- 完整铁律：`MD/specs/IRON_RULES.md`
|
||||
- 后端规范：`MD/specs/BACKEND_DEVELOPMENT_STANDARD.md`
|
||||
- 前端规范：`MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md`
|
||||
|
||||
---
|
||||
|
||||
## 三、后端开发规范
|
||||
|
||||
### 分层架构
|
||||
```
|
||||
Controller → AppService → Service → Mapper → Entity
|
||||
接收请求 编排业务 单表CRUD 数据访问 实体定义
|
||||
```
|
||||
|
||||
### 命名规范
|
||||
| 类型 | 规则 | 示例 |
|
||||
|------|------|------|
|
||||
| Controller | `XxxController` | `RegistrationController` |
|
||||
| AppService | `IXxxAppService` / `XxxAppServiceImpl` | `IRegistrationAppService` |
|
||||
| Service | `IXxxService` / `XxxServiceImpl` | `IRegistrationService` |
|
||||
| Mapper | `XxxMapper` | `RegistrationMapper` |
|
||||
| Entity | `Xxx` | `Registration` |
|
||||
| DTO | `XxxDto` / `XxxQueryDto` | `RegistrationDto` |
|
||||
|
||||
### 包结构
|
||||
```
|
||||
com.healthlink.his.web.{module}.controller
|
||||
com.healthlink.his.web.{module}.appservice
|
||||
com.healthlink.his.web.{module}.service
|
||||
com.healthlink.his.web.{module}.mapper
|
||||
com.healthlink.his.web.{module}.dto
|
||||
com.healthlink.his.domain.{module}
|
||||
com.healthlink.his.common.enums
|
||||
```
|
||||
|
||||
### 统一返回格式
|
||||
```java
|
||||
// 成功
|
||||
AjaxResult.success(data)
|
||||
// 失败
|
||||
AjaxResult.error("错误信息")
|
||||
// 列表
|
||||
getDataTable(list)
|
||||
```
|
||||
|
||||
### 关键约束
|
||||
- 所有查询使用 `LambdaQueryWrapper`，禁止字符串拼接 SQL
|
||||
- `@Transactional(rollbackFor = Exception.class)` 管理事务
|
||||
- 所有接口标注 `@PreAuthorize` 权限控制
|
||||
- 患者敏感信息（身份证、手机号）在日志中脱敏
|
||||
- 扩展功能不要修改原有函数签名，新建 Service/AppService
|
||||
|
||||
---
|
||||
|
||||
## 四、前端开发规范
|
||||
|
||||
### 技术栈
|
||||
- Vue 3 + Vite + Element Plus + Pinia + Axios
|
||||
- 基于 RuoYi-Vue3 框架
|
||||
|
||||
### 目录结构
|
||||
```
|
||||
src/api/{module}/ # API接口（kebab-case路径）
|
||||
src/views/{module}/ # 页面组件
|
||||
src/store/modules/ # Pinia状态管理
|
||||
src/components/ # 公共组件
|
||||
```
|
||||
|
||||
### API 路径规范
|
||||
```javascript
|
||||
// 统一前缀 /healthlink-his/api/v1/
|
||||
export function listXxx(query) {
|
||||
return request({ url: '/healthlink-his/api/v1/xxx/list', method: 'get', params: query })
|
||||
}
|
||||
```
|
||||
|
||||
### 组件规范
|
||||
- 页面组件使用 `<script setup>` 语法
|
||||
- 弹窗组件使用 `defineExpose({ open })` 暴露打开方法
|
||||
- 列表必须支持分页（`pagination` 组件）
|
||||
- 按钮权限使用 `v-hasPermi` 指令
|
||||
|
||||
### 关键约束
|
||||
- 路由懒加载：`() => import('@/views/xxx/index.vue')`
|
||||
- 不使用 `v-html`（除非做 XSS 转义）
|
||||
- 不在前端硬编码密码、密钥
|
||||
- `onMounted` 中注册的事件在 `onUnmounted` 中移除
|
||||
|
||||
---
|
||||
|
||||
## 五、开发流程
|
||||
|
||||
```
|
||||
1. 分析需求 → 读相关文档(MD/)
|
||||
2. 制定计划 → update_plan
|
||||
3. 后端开发 → Controller → AppService → Service → Mapper → Entity → Flyway
|
||||
4. 后端测试 → mvn test → 接口测试通过
|
||||
5. 前端开发 → API接口 → 页面组件 → 路由配置
|
||||
6. 前端测试 → npm run build:dev → 功能验证
|
||||
7. 提交代码 → git add → git commit(规范格式) → git push
|
||||
```
|
||||
|
||||
### Git Commit 格式
|
||||
```
|
||||
<type>(<scope>): <subject>
|
||||
|
||||
type: feat|fix|docs|refactor|test|chore
|
||||
scope: 模块名(如 registration, billing, pharmacy)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 六、快速参考命令
|
||||
|
||||
```bash
|
||||
# === 后端 ===
|
||||
export JAVA_HOME=/opt/jdk-25
|
||||
mvn clean compile -DskipTests # 编译
|
||||
mvn install -DskipTests # 完整构建
|
||||
mvn test -pl healthlink-his-application -Dtest="XxxTest" -Dsurefire.failIfNoSpecifiedTests=false # 测试
|
||||
|
||||
# === 前端 ===
|
||||
cd healthlink-his-ui
|
||||
npm run dev # 开发模式
|
||||
npm run build:dev # 构建
|
||||
npm run lint # 代码检查
|
||||
npm run test:run # 单元测试
|
||||
|
||||
# === Git ===
|
||||
git status # 查看变更
|
||||
git add -A # 暂存所有
|
||||
git commit -m "feat(module): description" # 提交
|
||||
git push origin develop # 推送
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 七、详细规范文档索引
|
||||
|
||||
| 文档 | 路径 | 用途 |
|
||||
|------|------|------|
|
||||
| 执行铁律 | `MD/specs/IRON_RULES.md` | 铁律完整版 |
|
||||
| 后端规范 | `MD/specs/BACKEND_DEVELOPMENT_STANDARD.md` | 后端编码标准 |
|
||||
| 前端规范 | `MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md` | 前端编码标准 |
|
||||
| 文档规范 | `MD/DOCUMENTATION_STANDARD.md` | 文档管理标准 |
|
||||
| 后端清单 | `MD/specs/BACKEND_CHECKLIST.md` | 发布前检查 |
|
||||
| 前端清单 | `MD/specs/FRONTEND_CHECKLIST.md` | 发布前检查 |
|
||||
| 三甲标准 | `MD/standards/GRADE3A_HIS_STANDARD.md` | 三甲医院达标标准 |
|
||||
| Flyway指南 | `MD/guides/FLYWAY_USAGE_GUIDE.md` | 数据库迁移指南 |
|
||||
|
||||
---
|
||||
|
||||
> ⚠️ **警告**: 本文件是项目 AI 开发规范的唯一信源。各工具配置文件（AGENTS.md、.cursorrules 等）均引用本文件。修改规范请只修改本文件。
|
||||
|
||||
---
|
||||
|
||||
> 📅 最后同步: 2026-06-06 09:46 | 源文件: RULES.md | 重新同步: `bash scripts/sync-ai-rules.sh`
|
||||
|
||||
233
.windsurfrules
233
.windsurfrules
@@ -1,9 +1,228 @@
|
||||
# HealthLink-HIS Development Rules
|
||||
# HealthLink-HIS — AI 开发规范 (Windsurf)
|
||||
|
||||
Read RULES.md in the project root for all development standards and iron rules.
|
||||
> 🤖 Windsurf 打开本项目时自动加载此文件。
|
||||
|
||||
Backend: Spring Boot 4.0.6 + JDK 25 + MyBatis-Plus 3.5.16
|
||||
Frontend: Vue 3 + Vite + Element Plus + Pinia
|
||||
Package: com.healthlink.his
|
||||
API prefix: /healthlink-his/api/v1/
|
||||
DB migrations: Flyway scripts in healthlink-his-domain/src/main/resources/db/migration/
|
||||
---
|
||||
|
||||
# HealthLink-HIS — AI 开发规范（自动加载）
|
||||
|
||||
> 🤖 **本文件供所有 AI 编码工具自动读取**。无论使用 Claude Code、Cursor、Codex CLI、Copilot、Qwen、Cline 还是其他工具，进入本项目后必须遵守以下规范。
|
||||
|
||||
---
|
||||
|
||||
## 一、项目概览
|
||||
|
||||
| 属性 | 值 |
|
||||
|------|------|
|
||||
| 项目名 | HealthLink-HIS（医院信息系统） |
|
||||
| 后端路径 | `healthlink-his-server/` |
|
||||
| 前端路径 | `healthlink-his-ui/` |
|
||||
| 文档路径 | `MD/` |
|
||||
| JDK | 25 (OpenJDK) |
|
||||
| Spring Boot | 4.0.6 |
|
||||
| Vue | 3.x + Vite + Element Plus |
|
||||
| 数据库 | PostgreSQL 15+ |
|
||||
| 包名 | `com.healthlink.his` |
|
||||
|
||||
---
|
||||
|
||||
## 二、铁律（必须遵守，违反即失败）
|
||||
|
||||
### 🔴 P0 铁律 — 不可违反
|
||||
|
||||
**铁律1: 修改完必须测试**
|
||||
```
|
||||
后端: mvn clean compile -DskipTests → mvn install -DskipTests → mvn test
|
||||
前端: npm run build:dev → npm run lint
|
||||
```
|
||||
- 白盒：编译通过，无 ERROR
|
||||
- 黑盒：关键接口返回 `{code:200, data:...}`
|
||||
- 冒烟：应用正常启动，核心流程通畅
|
||||
|
||||
**铁律2: Flyway 数据库迁移**
|
||||
- 凡是新建表、新增字段，必须创建 Flyway 迁移脚本
|
||||
- 路径：`healthlink-his-domain/src/main/resources/db/migration/`
|
||||
- 命名：`V{版本号}__{描述}.sql`（双下划线）
|
||||
- 禁止直接在数据库执行 SQL 不走 Flyway
|
||||
|
||||
**铁律3: 测试通过后才提交**
|
||||
- 编译 + 测试全部通过后才能 git commit
|
||||
- 不提交未完成的功能、调试代码、临时文件
|
||||
|
||||
**铁律4: 前后端API路径对齐**
|
||||
- 后端前缀：`/healthlink-his/api/v1/`
|
||||
- 前端 `request.js` 的 baseURL 必须与后端匹配
|
||||
- 接口变更必须同步更新前后端代码
|
||||
|
||||
### 🟡 P1 铁律 — 强烈建议
|
||||
|
||||
**铁律5: 先分解再行动**
|
||||
- 修改超过3个文件、涉及多模块、数据库变更，必须先制定计划
|
||||
|
||||
**铁律6: 验证后信**
|
||||
- 每次修改后必须验证编译通过，不信记忆
|
||||
- 重新编译命令：`mvn clean compile -DskipTests`
|
||||
|
||||
**铁律7: 文档统一管理**
|
||||
- 所有文档存储在 `MD/` 目录
|
||||
- 文件名：大写英文+下划线（如 `BACKEND_CHECKLIST.md`）
|
||||
- 文档头部必须包含元数据块（文档类型、版本、日期）
|
||||
|
||||
**铁律8: 规范文档在 MD/specs/**
|
||||
- 完整铁律：`MD/specs/IRON_RULES.md`
|
||||
- 后端规范：`MD/specs/BACKEND_DEVELOPMENT_STANDARD.md`
|
||||
- 前端规范：`MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md`
|
||||
|
||||
---
|
||||
|
||||
## 三、后端开发规范
|
||||
|
||||
### 分层架构
|
||||
```
|
||||
Controller → AppService → Service → Mapper → Entity
|
||||
接收请求 编排业务 单表CRUD 数据访问 实体定义
|
||||
```
|
||||
|
||||
### 命名规范
|
||||
| 类型 | 规则 | 示例 |
|
||||
|------|------|------|
|
||||
| Controller | `XxxController` | `RegistrationController` |
|
||||
| AppService | `IXxxAppService` / `XxxAppServiceImpl` | `IRegistrationAppService` |
|
||||
| Service | `IXxxService` / `XxxServiceImpl` | `IRegistrationService` |
|
||||
| Mapper | `XxxMapper` | `RegistrationMapper` |
|
||||
| Entity | `Xxx` | `Registration` |
|
||||
| DTO | `XxxDto` / `XxxQueryDto` | `RegistrationDto` |
|
||||
|
||||
### 包结构
|
||||
```
|
||||
com.healthlink.his.web.{module}.controller
|
||||
com.healthlink.his.web.{module}.appservice
|
||||
com.healthlink.his.web.{module}.service
|
||||
com.healthlink.his.web.{module}.mapper
|
||||
com.healthlink.his.web.{module}.dto
|
||||
com.healthlink.his.domain.{module}
|
||||
com.healthlink.his.common.enums
|
||||
```
|
||||
|
||||
### 统一返回格式
|
||||
```java
|
||||
// 成功
|
||||
AjaxResult.success(data)
|
||||
// 失败
|
||||
AjaxResult.error("错误信息")
|
||||
// 列表
|
||||
getDataTable(list)
|
||||
```
|
||||
|
||||
### 关键约束
|
||||
- 所有查询使用 `LambdaQueryWrapper`，禁止字符串拼接 SQL
|
||||
- `@Transactional(rollbackFor = Exception.class)` 管理事务
|
||||
- 所有接口标注 `@PreAuthorize` 权限控制
|
||||
- 患者敏感信息（身份证、手机号）在日志中脱敏
|
||||
- 扩展功能不要修改原有函数签名，新建 Service/AppService
|
||||
|
||||
---
|
||||
|
||||
## 四、前端开发规范
|
||||
|
||||
### 技术栈
|
||||
- Vue 3 + Vite + Element Plus + Pinia + Axios
|
||||
- 基于 RuoYi-Vue3 框架
|
||||
|
||||
### 目录结构
|
||||
```
|
||||
src/api/{module}/ # API接口（kebab-case路径）
|
||||
src/views/{module}/ # 页面组件
|
||||
src/store/modules/ # Pinia状态管理
|
||||
src/components/ # 公共组件
|
||||
```
|
||||
|
||||
### API 路径规范
|
||||
```javascript
|
||||
// 统一前缀 /healthlink-his/api/v1/
|
||||
export function listXxx(query) {
|
||||
return request({ url: '/healthlink-his/api/v1/xxx/list', method: 'get', params: query })
|
||||
}
|
||||
```
|
||||
|
||||
### 组件规范
|
||||
- 页面组件使用 `<script setup>` 语法
|
||||
- 弹窗组件使用 `defineExpose({ open })` 暴露打开方法
|
||||
- 列表必须支持分页（`pagination` 组件）
|
||||
- 按钮权限使用 `v-hasPermi` 指令
|
||||
|
||||
### 关键约束
|
||||
- 路由懒加载：`() => import('@/views/xxx/index.vue')`
|
||||
- 不使用 `v-html`（除非做 XSS 转义）
|
||||
- 不在前端硬编码密码、密钥
|
||||
- `onMounted` 中注册的事件在 `onUnmounted` 中移除
|
||||
|
||||
---
|
||||
|
||||
## 五、开发流程
|
||||
|
||||
```
|
||||
1. 分析需求 → 读相关文档(MD/)
|
||||
2. 制定计划 → update_plan
|
||||
3. 后端开发 → Controller → AppService → Service → Mapper → Entity → Flyway
|
||||
4. 后端测试 → mvn test → 接口测试通过
|
||||
5. 前端开发 → API接口 → 页面组件 → 路由配置
|
||||
6. 前端测试 → npm run build:dev → 功能验证
|
||||
7. 提交代码 → git add → git commit(规范格式) → git push
|
||||
```
|
||||
|
||||
### Git Commit 格式
|
||||
```
|
||||
<type>(<scope>): <subject>
|
||||
|
||||
type: feat|fix|docs|refactor|test|chore
|
||||
scope: 模块名(如 registration, billing, pharmacy)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 六、快速参考命令
|
||||
|
||||
```bash
|
||||
# === 后端 ===
|
||||
export JAVA_HOME=/opt/jdk-25
|
||||
mvn clean compile -DskipTests # 编译
|
||||
mvn install -DskipTests # 完整构建
|
||||
mvn test -pl healthlink-his-application -Dtest="XxxTest" -Dsurefire.failIfNoSpecifiedTests=false # 测试
|
||||
|
||||
# === 前端 ===
|
||||
cd healthlink-his-ui
|
||||
npm run dev # 开发模式
|
||||
npm run build:dev # 构建
|
||||
npm run lint # 代码检查
|
||||
npm run test:run # 单元测试
|
||||
|
||||
# === Git ===
|
||||
git status # 查看变更
|
||||
git add -A # 暂存所有
|
||||
git commit -m "feat(module): description" # 提交
|
||||
git push origin develop # 推送
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 七、详细规范文档索引
|
||||
|
||||
| 文档 | 路径 | 用途 |
|
||||
|------|------|------|
|
||||
| 执行铁律 | `MD/specs/IRON_RULES.md` | 铁律完整版 |
|
||||
| 后端规范 | `MD/specs/BACKEND_DEVELOPMENT_STANDARD.md` | 后端编码标准 |
|
||||
| 前端规范 | `MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md` | 前端编码标准 |
|
||||
| 文档规范 | `MD/DOCUMENTATION_STANDARD.md` | 文档管理标准 |
|
||||
| 后端清单 | `MD/specs/BACKEND_CHECKLIST.md` | 发布前检查 |
|
||||
| 前端清单 | `MD/specs/FRONTEND_CHECKLIST.md` | 发布前检查 |
|
||||
| 三甲标准 | `MD/standards/GRADE3A_HIS_STANDARD.md` | 三甲医院达标标准 |
|
||||
| Flyway指南 | `MD/guides/FLYWAY_USAGE_GUIDE.md` | 数据库迁移指南 |
|
||||
|
||||
---
|
||||
|
||||
> ⚠️ **警告**: 本文件是项目 AI 开发规范的唯一信源。各工具配置文件（AGENTS.md、.cursorrules 等）均引用本文件。修改规范请只修改本文件。
|
||||
|
||||
---
|
||||
|
||||
> 📅 最后同步: 2026-06-06 09:46 | 源文件: RULES.md | 重新同步: `bash scripts/sync-ai-rules.sh`
|
||||
|
||||
237
AGENTS.md
237
AGENTS.md
@@ -1,26 +1,229 @@
|
||||
# HealthLink-HIS — AI 开发规范
|
||||
|
||||
> 🤖 本文件由 Codex CLI、Claude Code 等工具自动读取。
|
||||
> 完整规范请阅读 **[RULES.md](RULES.md)**，必须严格遵守。
|
||||
> 工具进入项目目录时会自动加载此文件作为开发规范上下文。
|
||||
|
||||
## 快速铁律
|
||||
---
|
||||
|
||||
1. **修改完必须测试** — `mvn clean compile -DskipTests` + `npm run build:dev`
|
||||
2. **Flyway 迁移** — 新建表/字段必须走 Flyway 脚本
|
||||
3. **测试通过才提交** — 编译+测试全通过才能 commit
|
||||
4. **API路径对齐** — 后端 `/healthlink-his/api/v1/`，前端同步
|
||||
5. **先分解再行动** — 非平凡任务先出计划
|
||||
6. **文档在 MD 目录** — 大写下划线命名，含元数据块
|
||||
# HealthLink-HIS — AI 开发规范（自动加载）
|
||||
|
||||
## 项目结构
|
||||
> 🤖 **本文件供所有 AI 编码工具自动读取**。无论使用 Claude Code、Cursor、Codex CLI、Copilot、Qwen、Cline 还是其他工具，进入本项目后必须遵守以下规范。
|
||||
|
||||
- 后端: `healthlink-his-server/` (Spring Boot 4.0.6 + JDK 25)
|
||||
- 前端: `healthlink-his-ui/` (Vue 3 + Vite + Element Plus)
|
||||
- 文档: `MD/` (30个规范文档)
|
||||
---
|
||||
|
||||
## 详细规范
|
||||
## 一、项目概览
|
||||
|
||||
→ 完整铁律: `MD/specs/IRON_RULES.md`
|
||||
→ 后端规范: `MD/specs/BACKEND_DEVELOPMENT_STANDARD.md`
|
||||
→ 前端规范: `MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md`
|
||||
→ 本文档完整版: `RULES.md`
|
||||
| 属性 | 值 |
|
||||
|------|------|
|
||||
| 项目名 | HealthLink-HIS（医院信息系统） |
|
||||
| 后端路径 | `healthlink-his-server/` |
|
||||
| 前端路径 | `healthlink-his-ui/` |
|
||||
| 文档路径 | `MD/` |
|
||||
| JDK | 25 (OpenJDK) |
|
||||
| Spring Boot | 4.0.6 |
|
||||
| Vue | 3.x + Vite + Element Plus |
|
||||
| 数据库 | PostgreSQL 15+ |
|
||||
| 包名 | `com.healthlink.his` |
|
||||
|
||||
---
|
||||
|
||||
## 二、铁律（必须遵守，违反即失败）
|
||||
|
||||
### 🔴 P0 铁律 — 不可违反
|
||||
|
||||
**铁律1: 修改完必须测试**
|
||||
```
|
||||
后端: mvn clean compile -DskipTests → mvn install -DskipTests → mvn test
|
||||
前端: npm run build:dev → npm run lint
|
||||
```
|
||||
- 白盒：编译通过，无 ERROR
|
||||
- 黑盒：关键接口返回 `{code:200, data:...}`
|
||||
- 冒烟：应用正常启动，核心流程通畅
|
||||
|
||||
**铁律2: Flyway 数据库迁移**
|
||||
- 凡是新建表、新增字段，必须创建 Flyway 迁移脚本
|
||||
- 路径：`healthlink-his-domain/src/main/resources/db/migration/`
|
||||
- 命名：`V{版本号}__{描述}.sql`（双下划线）
|
||||
- 禁止直接在数据库执行 SQL 不走 Flyway
|
||||
|
||||
**铁律3: 测试通过后才提交**
|
||||
- 编译 + 测试全部通过后才能 git commit
|
||||
- 不提交未完成的功能、调试代码、临时文件
|
||||
|
||||
**铁律4: 前后端API路径对齐**
|
||||
- 后端前缀：`/healthlink-his/api/v1/`
|
||||
- 前端 `request.js` 的 baseURL 必须与后端匹配
|
||||
- 接口变更必须同步更新前后端代码
|
||||
|
||||
### 🟡 P1 铁律 — 强烈建议
|
||||
|
||||
**铁律5: 先分解再行动**
|
||||
- 修改超过3个文件、涉及多模块、数据库变更，必须先制定计划
|
||||
|
||||
**铁律6: 验证后信**
|
||||
- 每次修改后必须验证编译通过，不信记忆
|
||||
- 重新编译命令：`mvn clean compile -DskipTests`
|
||||
|
||||
**铁律7: 文档统一管理**
|
||||
- 所有文档存储在 `MD/` 目录
|
||||
- 文件名：大写英文+下划线（如 `BACKEND_CHECKLIST.md`）
|
||||
- 文档头部必须包含元数据块（文档类型、版本、日期）
|
||||
|
||||
**铁律8: 规范文档在 MD/specs/**
|
||||
- 完整铁律：`MD/specs/IRON_RULES.md`
|
||||
- 后端规范：`MD/specs/BACKEND_DEVELOPMENT_STANDARD.md`
|
||||
- 前端规范：`MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md`
|
||||
|
||||
---
|
||||
|
||||
## 三、后端开发规范
|
||||
|
||||
### 分层架构
|
||||
```
|
||||
Controller → AppService → Service → Mapper → Entity
|
||||
接收请求 编排业务 单表CRUD 数据访问 实体定义
|
||||
```
|
||||
|
||||
### 命名规范
|
||||
| 类型 | 规则 | 示例 |
|
||||
|------|------|------|
|
||||
| Controller | `XxxController` | `RegistrationController` |
|
||||
| AppService | `IXxxAppService` / `XxxAppServiceImpl` | `IRegistrationAppService` |
|
||||
| Service | `IXxxService` / `XxxServiceImpl` | `IRegistrationService` |
|
||||
| Mapper | `XxxMapper` | `RegistrationMapper` |
|
||||
| Entity | `Xxx` | `Registration` |
|
||||
| DTO | `XxxDto` / `XxxQueryDto` | `RegistrationDto` |
|
||||
|
||||
### 包结构
|
||||
```
|
||||
com.healthlink.his.web.{module}.controller
|
||||
com.healthlink.his.web.{module}.appservice
|
||||
com.healthlink.his.web.{module}.service
|
||||
com.healthlink.his.web.{module}.mapper
|
||||
com.healthlink.his.web.{module}.dto
|
||||
com.healthlink.his.domain.{module}
|
||||
com.healthlink.his.common.enums
|
||||
```
|
||||
|
||||
### 统一返回格式
|
||||
```java
|
||||
// 成功
|
||||
AjaxResult.success(data)
|
||||
// 失败
|
||||
AjaxResult.error("错误信息")
|
||||
// 列表
|
||||
getDataTable(list)
|
||||
```
|
||||
|
||||
### 关键约束
|
||||
- 所有查询使用 `LambdaQueryWrapper`，禁止字符串拼接 SQL
|
||||
- `@Transactional(rollbackFor = Exception.class)` 管理事务
|
||||
- 所有接口标注 `@PreAuthorize` 权限控制
|
||||
- 患者敏感信息（身份证、手机号）在日志中脱敏
|
||||
- 扩展功能不要修改原有函数签名，新建 Service/AppService
|
||||
|
||||
---
|
||||
|
||||
## 四、前端开发规范
|
||||
|
||||
### 技术栈
|
||||
- Vue 3 + Vite + Element Plus + Pinia + Axios
|
||||
- 基于 RuoYi-Vue3 框架
|
||||
|
||||
### 目录结构
|
||||
```
|
||||
src/api/{module}/ # API接口（kebab-case路径）
|
||||
src/views/{module}/ # 页面组件
|
||||
src/store/modules/ # Pinia状态管理
|
||||
src/components/ # 公共组件
|
||||
```
|
||||
|
||||
### API 路径规范
|
||||
```javascript
|
||||
// 统一前缀 /healthlink-his/api/v1/
|
||||
export function listXxx(query) {
|
||||
return request({ url: '/healthlink-his/api/v1/xxx/list', method: 'get', params: query })
|
||||
}
|
||||
```
|
||||
|
||||
### 组件规范
|
||||
- 页面组件使用 `<script setup>` 语法
|
||||
- 弹窗组件使用 `defineExpose({ open })` 暴露打开方法
|
||||
- 列表必须支持分页（`pagination` 组件）
|
||||
- 按钮权限使用 `v-hasPermi` 指令
|
||||
|
||||
### 关键约束
|
||||
- 路由懒加载：`() => import('@/views/xxx/index.vue')`
|
||||
- 不使用 `v-html`（除非做 XSS 转义）
|
||||
- 不在前端硬编码密码、密钥
|
||||
- `onMounted` 中注册的事件在 `onUnmounted` 中移除
|
||||
|
||||
---
|
||||
|
||||
## 五、开发流程
|
||||
|
||||
```
|
||||
1. 分析需求 → 读相关文档(MD/)
|
||||
2. 制定计划 → update_plan
|
||||
3. 后端开发 → Controller → AppService → Service → Mapper → Entity → Flyway
|
||||
4. 后端测试 → mvn test → 接口测试通过
|
||||
5. 前端开发 → API接口 → 页面组件 → 路由配置
|
||||
6. 前端测试 → npm run build:dev → 功能验证
|
||||
7. 提交代码 → git add → git commit(规范格式) → git push
|
||||
```
|
||||
|
||||
### Git Commit 格式
|
||||
```
|
||||
<type>(<scope>): <subject>
|
||||
|
||||
type: feat|fix|docs|refactor|test|chore
|
||||
scope: 模块名(如 registration, billing, pharmacy)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 六、快速参考命令
|
||||
|
||||
```bash
|
||||
# === 后端 ===
|
||||
export JAVA_HOME=/opt/jdk-25
|
||||
mvn clean compile -DskipTests # 编译
|
||||
mvn install -DskipTests # 完整构建
|
||||
mvn test -pl healthlink-his-application -Dtest="XxxTest" -Dsurefire.failIfNoSpecifiedTests=false # 测试
|
||||
|
||||
# === 前端 ===
|
||||
cd healthlink-his-ui
|
||||
npm run dev # 开发模式
|
||||
npm run build:dev # 构建
|
||||
npm run lint # 代码检查
|
||||
npm run test:run # 单元测试
|
||||
|
||||
# === Git ===
|
||||
git status # 查看变更
|
||||
git add -A # 暂存所有
|
||||
git commit -m "feat(module): description" # 提交
|
||||
git push origin develop # 推送
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 七、详细规范文档索引
|
||||
|
||||
| 文档 | 路径 | 用途 |
|
||||
|------|------|------|
|
||||
| 执行铁律 | `MD/specs/IRON_RULES.md` | 铁律完整版 |
|
||||
| 后端规范 | `MD/specs/BACKEND_DEVELOPMENT_STANDARD.md` | 后端编码标准 |
|
||||
| 前端规范 | `MD/specs/FRONTEND_DEVELOPMENT_STANDARD.md` | 前端编码标准 |
|
||||
| 文档规范 | `MD/DOCUMENTATION_STANDARD.md` | 文档管理标准 |
|
||||
| 后端清单 | `MD/specs/BACKEND_CHECKLIST.md` | 发布前检查 |
|
||||
| 前端清单 | `MD/specs/FRONTEND_CHECKLIST.md` | 发布前检查 |
|
||||
| 三甲标准 | `MD/standards/GRADE3A_HIS_STANDARD.md` | 三甲医院达标标准 |
|
||||
| Flyway指南 | `MD/guides/FLYWAY_USAGE_GUIDE.md` | 数据库迁移指南 |
|
||||
|
||||
---
|
||||
|
||||
> ⚠️ **警告**: 本文件是项目 AI 开发规范的唯一信源。各工具配置文件（AGENTS.md、.cursorrules 等）均引用本文件。修改规范请只修改本文件。
|
||||
|
||||
---
|
||||
|
||||
> 📅 最后同步: 2026-06-06 09:46 | 源文件: RULES.md | 重新同步: `bash scripts/sync-ai-rules.sh`
|
||||
|
||||
156
scripts/sync-ai-rules.sh
Executable file
156
scripts/sync-ai-rules.sh
Executable file
@@ -0,0 +1,156 @@
|
||||
#!/usr/bin/env bash
|
||||
# ============================================================
|
||||
# sync-ai-rules.sh — 将 RULES.md 完整内容同步到所有 AI 工具配置文件
|
||||
#
|
||||
# 用法: bash scripts/sync-ai-rules.sh
|
||||
#
|
||||
# 设计原则:
|
||||
# RULES.md 是唯一信源，本脚本将其内容嵌入到各工具配置文件
|
||||
# 开发者只需编辑 RULES.md，然后运行本脚本即可同步所有工具
|
||||
# ============================================================
|
||||
|
||||
set -euo pipefail
|
||||
cd "$(dirname "$0")/.."
|
||||
|
||||
RULES_FILE="RULES.md"
|
||||
if [ ! -f "$RULES_FILE" ]; then
|
||||
echo "❌ $RULES_FILE not found"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
RULES_CONTENT=$(cat "$RULES_FILE")
|
||||
TIMESTAMP=$(date '+%Y-%m-%d %H:%M')
|
||||
|
||||
echo "📝 Syncing RULES.md → AI tool configs..."
|
||||
|
||||
# ============================================================
|
||||
# 1. AGENTS.md (Codex CLI / Claude Code)
|
||||
# ============================================================
|
||||
cat > AGENTS.md << HEREDOC
|
||||
# HealthLink-HIS — AI 开发规范
|
||||
|
||||
> 🤖 本文件由 Codex CLI、Claude Code 等工具自动读取。
|
||||
> 工具进入项目目录时会自动加载此文件作为开发规范上下文。
|
||||
|
||||
---
|
||||
|
||||
${RULES_CONTENT}
|
||||
|
||||
---
|
||||
|
||||
> 📅 最后同步: ${TIMESTAMP} | 源文件: RULES.md | 重新同步: \`bash scripts/sync-ai-rules.sh\`
|
||||
HEREDOC
|
||||
echo " ✅ AGENTS.md"
|
||||
|
||||
# ============================================================
|
||||
# 2. .cursorrules (Cursor IDE / Codeium Windsurf)
|
||||
# ============================================================
|
||||
cat > .cursorrules << HEREDOC
|
||||
# HealthLink-HIS — AI 开发规范 (Cursor)
|
||||
|
||||
> 🤖 Cursor IDE 打开本项目时自动加载此文件。
|
||||
|
||||
---
|
||||
|
||||
${RULES_CONTENT}
|
||||
|
||||
---
|
||||
|
||||
> 📅 最后同步: ${TIMESTAMP} | 源文件: RULES.md | 重新同步: \`bash scripts/sync-ai-rules.sh\`
|
||||
HEREDOC
|
||||
echo " ✅ .cursorrules"
|
||||
|
||||
# ============================================================
|
||||
# 3. .github/copilot-instructions.md (GitHub Copilot)
|
||||
# ============================================================
|
||||
mkdir -p .github
|
||||
cat > .github/copilot-instructions.md << HEREDOC
|
||||
# HealthLink-HIS — AI 开发规范 (GitHub Copilot)
|
||||
|
||||
> 🤖 GitHub Copilot 打开本项目时自动加载此文件。
|
||||
|
||||
---
|
||||
|
||||
${RULES_CONTENT}
|
||||
|
||||
---
|
||||
|
||||
> 📅 最后同步: ${TIMESTAMP} | 源文件: RULES.md | 重新同步: \`bash scripts/sync-ai-rules.sh\`
|
||||
HEREDOC
|
||||
echo " ✅ .github/copilot-instructions.md"
|
||||
|
||||
# ============================================================
|
||||
# 4. .windsurfrules (Windsurf / Codeium)
|
||||
# ============================================================
|
||||
cat > .windsurfrules << HEREDOC
|
||||
# HealthLink-HIS — AI 开发规范 (Windsurf)
|
||||
|
||||
> 🤖 Windsurf 打开本项目时自动加载此文件。
|
||||
|
||||
---
|
||||
|
||||
${RULES_CONTENT}
|
||||
|
||||
---
|
||||
|
||||
> 📅 最后同步: ${TIMESTAMP} | 源文件: RULES.md | 重新同步: \`bash scripts/sync-ai-rules.sh\`
|
||||
HEREDOC
|
||||
echo " ✅ .windsurfrules"
|
||||
|
||||
# ============================================================
|
||||
# 5. .clinerules (Cline)
|
||||
# ============================================================
|
||||
cat > .clinerules << HEREDOC
|
||||
# HealthLink-HIS — AI 开发规范 (Cline)
|
||||
|
||||
> 🤖 Cline 打开本项目时自动加载此文件。
|
||||
|
||||
---
|
||||
|
||||
${RULES_CONTENT}
|
||||
|
||||
---
|
||||
|
||||
> 📅 最后同步: ${TIMESTAMP} | 源文件: RULES.md | 重新同步: \`bash scripts/sync-ai-rules.sh\`
|
||||
HEREDOC
|
||||
echo " ✅ .clinerules"
|
||||
|
||||
# ============================================================
|
||||
# 6. .qwenrules (Qwen Coder / 通义灵码)
|
||||
# ============================================================
|
||||
cat > .qwenrules << HEREDOC
|
||||
# HealthLink-HIS — AI 开发规范 (Qwen Coder)
|
||||
|
||||
> 🤖 通义灵码 / Qwen Coder 打开本项目时自动加载此文件。
|
||||
|
||||
---
|
||||
|
||||
${RULES_CONTENT}
|
||||
|
||||
---
|
||||
|
||||
> 📅 最后同步: ${TIMESTAMP} | 源文件: RULES.md | 重新同步: \`bash scripts/sync-ai-rules.sh\`
|
||||
HEREDOC
|
||||
echo " ✅ .qwenrules"
|
||||
|
||||
# ============================================================
|
||||
# 7. .aider.conf.yml (Aider) — YAML格式，嵌入指令
|
||||
# ============================================================
|
||||
# Aider 支持 instruction-files 指向文件，同时也支持直接在 .aider.conf.yml 中写 instructions
|
||||
# 这里用 instructions 指令把内容内联
|
||||
cat > .aider.conf.yml << HEREDOC
|
||||
# Aider configuration for HealthLink-HIS
|
||||
# Aider 自动读取此文件获取开发规范
|
||||
|
||||
instructions: |
|
||||
$(echo "$RULES_CONTENT" | sed 's/^/ /')
|
||||
HEREDOC
|
||||
echo " ✅ .aider.conf.yml"
|
||||
|
||||
echo ""
|
||||
echo "🎉 All 7 AI tool configs synced from RULES.md"
|
||||
echo " 文件大小:"
|
||||
for f in AGENTS.md .cursorrules .github/copilot-instructions.md .windsurfrules .clinerules .qwenrules .aider.conf.yml; do
|
||||
size=$(wc -c < "$f" 2>/dev/null || echo "0")
|
||||
echo " $f: ${size} bytes"
|
||||
done
|
||||
Reference in New Issue
Block a user