初始化

This commit is contained in:
SunYF
2026-08-28 14:07:22 +08:00
parent a185247ab1
commit b34325a16f
971 changed files with 291 additions and 220360 deletions
+45
View File
@@ -0,0 +1,45 @@
# 技术约束与编码规范
本文件收录本项目(bj_power 装配线统一仓库)必须遵守的技术约束与编码约定。其余历史文档均已清理。
## 全局规则
- **禁止自动提交 git**:所有 commit/push 必须等用户明确要求后才执行。
- **单一 Git 仓库**MES / Dashboard / WMS / WMS客户端 / 工位终端 统一为 `bj_power` 一个仓库;各子项目内部命名(Go module、package.json、import 路径、配置文件名)必须与其文件夹名对齐。
## 命名规范
- **驼峰命名(camelCase)**:接口参数、默认、字段、前端 JSON 均采用 camelCaseGo 结构体字段为 PascalCasejson tag 用 camelCase。
- 常量、枚举等大写开头,用户可读中文文案单独维护。
## 代码分层
- **handler 保持薄层**,业务逻辑写在 logic 层,不在 handler 里写业务。
- **不手动修改生成代码**`ent/``internal/handler/``internal/types/` 为 goctl/ent 自动生成。改 schema 走 `cd schema && go generate`,改 api 走 `cd apis && go generate`
- 简单优先:用最少代码解决问题;不为单次使用创建抽象;不写不可能出现的错误处理。
- 精准改动:只改必须改的部分,不改没坏的东西,风格匹配现有代码。
## 安全与配置
- **敏感信息一律写入 YAML 配置文件**,不硬编码进代码:JWT Secret、内部 API Token、数据库口令等。
- **统一内部 API 密钥**`Hardman_2026`(内部服务间鉴权,请求头 `X-API-TOKEN`)。
## 技术栈
- **后端**Go + go-zeroREST 框架)+ Ent ORM + PostgreSQL。
- **前端(MES / WMS客户端 / 工位终端)**Vue3Semi Design / Element Plus)。
- **看板(Dashboard**React + Semi Design + ECharts。
- **实时通信**Dashboard 通过 Redis + SSE 从 MES 取数据,1 分钟过期 + 防击穿。
## 业务架构约束
- **产线仅为装配线**:设备只有「扫码枪 + 拧紧枪」,其余为人工操作。不存在 CNC、清洗机、检验设备、内窥镜、AGV/RGV、机器人、接驳台等设备(前端看板/页面不得包含这些设备)。
- **数据库隔离**:MES 与 WMS 使用各自独立数据库,跨系统通过内部 API 通信。
- **工位终端**:拧紧数据用 SQLite 本地缓存,完成后上报 MES。
- **日志**:按天存储(如 `bj_power_mes-2026-08-28.log`),保留 30 天。
- **操作日志可追溯**`event_log` 必须含 `workOrderNo``operator` 字段。
## 数据库
- MES 库名 `bj_power_mes`、WMS 库名 `` (以各项目 etc/*.yaml 配置为准)。
- 建表工具(如 migrate.go)的 DSN 从 YAML 读取,不硬编码。