feat: 重构项目心跳数据结构并实现项目列表API
- 新增统一项目列表Redis键和迁移工具 - 实现GET /api/projects端点获取项目列表 - 实现POST /api/projects/migrate端点支持数据迁移 - 更新前端ProjectSelector组件使用真实项目数据 - 扩展projectStore状态管理 - 更新相关文档和OpenSpec规范 - 添加测试用例验证新功能
This commit is contained in:
@@ -3,39 +3,57 @@
|
||||
本文档定义“外部项目 ↔ BLS Project Console”之间通过 Redis 交互的 **Key 命名、数据类型、写入方式、读取方式与数据格式**。
|
||||
|
||||
> 约束:每个需要关联本控制台的外部项目,必须在本项目使用的同一个 Redis 实例中:
|
||||
> - 写入 2 个 Key(状态 + 控制台信息)
|
||||
> - 读取 1 个 Key(控制指令队列)
|
||||
>
|
||||
> - 写入 2 个 Key(心跳 + 控制台信息)
|
||||
> - 命令下发为 HTTP API 调用
|
||||
|
||||
## 1. 命名约定
|
||||
|
||||
令:
|
||||
|
||||
- `projectName`:外部项目名称(建议只用字母数字下划线 `A-Za-z0-9_`;如使用中文也可,但需保证统一且 UTF-8)。
|
||||
|
||||
固定后缀:
|
||||
- 状态:`${projectName}_项目状态`
|
||||
|
||||
- 心跳:`${projectName}_项目心跳`
|
||||
- 控制台:`${projectName}_项目控制台`
|
||||
- 控制:`${projectName}_控制`
|
||||
|
||||
示例(projectName = `订单系统`):
|
||||
- `订单系统_项目状态`
|
||||
|
||||
- `订单系统_项目心跳`
|
||||
- `订单系统_项目控制台`
|
||||
- `订单系统_控制`
|
||||
|
||||
## 2. 外部项目需要写入的 2 个 Key
|
||||
|
||||
### 2.1 `${projectName}_项目状态`
|
||||
### 2.1 `${projectName}_项目心跳`
|
||||
|
||||
- Redis 数据类型:**STRING**
|
||||
- 写入方式:`SET ${projectName}_项目状态 <status>`
|
||||
- value:状态枚举(必须为以下之一)
|
||||
- `在线`
|
||||
- `离线`
|
||||
- `故障`
|
||||
- `报错`
|
||||
- 写入方式:`SET ${projectName}_项目心跳 <json>`
|
||||
- value:JSON 字符串,必须包含目标项目可被调用的 `apiBaseUrl`,以及活跃时间戳 `lastActiveAt`
|
||||
|
||||
建议(非强制):
|
||||
- 定期刷新(如 5~30 秒)
|
||||
- 可设置 TTL 防止僵尸在线(如 `SET key value EX 60`)
|
||||
推荐 JSON Schema:
|
||||
|
||||
```json
|
||||
{
|
||||
"apiBaseUrl": "http://127.0.0.1:4001",
|
||||
"lastActiveAt": 1760000000000
|
||||
}
|
||||
```
|
||||
|
||||
字段说明:
|
||||
|
||||
- `apiBaseUrl`:目标项目对外提供的 API 地址(基地址,后端将基于它拼接 `apiName`)
|
||||
- `lastActiveAt`:状态时间(活跃时间戳,毫秒)。建议每 **3 秒**刷新一次。
|
||||
|
||||
在线/离线判定(BLS Project Console 使用):
|
||||
|
||||
- 若 `now - lastActiveAt > 10_000ms`,则认为该应用 **离线**
|
||||
- 否则认为 **在线**
|
||||
|
||||
建议:
|
||||
|
||||
- `lastActiveAt` 使用 `Date.now()` 生成(毫秒)
|
||||
- 可设置 TTL(可选):例如 `SET key value EX 30`
|
||||
|
||||
### 2.2 `${projectName}_项目控制台`
|
||||
|
||||
@@ -45,6 +63,7 @@
|
||||
value(推荐格式):一条 JSON 字符串,表示“错误/调试信息”或日志记录。
|
||||
|
||||
推荐 JSON Schema(字段尽量保持稳定,便于控制台解析):
|
||||
|
||||
```json
|
||||
{
|
||||
"timestamp": "2026-01-12T12:34:56.789Z",
|
||||
@@ -58,46 +77,52 @@ value(推荐格式):一条 JSON 字符串,表示“错误/调试信息
|
||||
```
|
||||
|
||||
字段说明:
|
||||
|
||||
- `timestamp`:ISO-8601 时间字符串
|
||||
- `level`:建议取值 `info|warn|error|debug`(小写)
|
||||
- `message`:日志文本
|
||||
- `metadata`:可选对象(附加信息)
|
||||
|
||||
## 3. 外部项目需要读取的 1 个 Key(控制指令)
|
||||
## 3. 命令下发方式(HTTP API 控制)
|
||||
|
||||
### 3.1 `${projectName}_控制`
|
||||
控制台不再通过 Redis 写入控制指令队列;改为由 BLS Project Console 后端根据目标项目心跳里的 `apiBaseUrl` 直接调用目标项目 HTTP API。
|
||||
|
||||
- Redis 数据类型:**LIST**(控制台向目标项目下发的“命令队列”)
|
||||
- 队列模式(必须):**Redis List 队列**(生产 `RPUSH`,消费 `BLPOP`;必要时配合 `LTRIM`)
|
||||
- 控制台写入方式(FIFO):`RPUSH ${targetProjectName}_控制 <json>`
|
||||
- 外部项目读取方式(阻塞消费,推荐):`BLPOP ${projectName}_控制 0`
|
||||
### 3.1 控制台输入格式
|
||||
|
||||
> 说明:`BLPOP` 本身会原子性地“取出并移除”队列头元素,通常不需要额外 `LTRIM`。
|
||||
> 如果你的运行环境/客户端库无法可靠使用 `BLPOP`,或你希望采用“读取 + 修剪(LTRIM)”的显式确认方式,可使用兼容模式:
|
||||
> 1) `LRANGE ${projectName}_控制 0 0` 读取 1 条
|
||||
> 2) 处理成功后执行 `LTRIM ${projectName}_控制 1 -1` 修剪已消费元素
|
||||
一行文本按空格拆分:
|
||||
|
||||
value:**JSON 对象**(在 Redis 中以 JSON 字符串形式存储)。
|
||||
- 第一个 token:`apiName`(接口名/路径片段)
|
||||
- 剩余 token:参数列表(字符串数组)
|
||||
|
||||
示例:
|
||||
|
||||
- `reload`
|
||||
- `reload force`
|
||||
- `user/refreshCache tenantA`
|
||||
|
||||
### 3.2 目标项目需要提供的 API
|
||||
|
||||
后端默认使用 `POST` 调用:
|
||||
|
||||
- `POST {apiBaseUrl}/{apiName}`
|
||||
|
||||
请求体(JSON)示例:
|
||||
|
||||
推荐 JSON Schema:
|
||||
```json
|
||||
{
|
||||
"id": "cmd-1700000000000-abc123",
|
||||
"timestamp": "2026-01-12T12:35:00.000Z",
|
||||
"commandId": "cmd-1700000000000-abc123",
|
||||
"timestamp": "2026-01-13T00:00:00.000Z",
|
||||
"source": "BLS Project Console",
|
||||
"command": "reload",
|
||||
"args": {
|
||||
"force": true
|
||||
}
|
||||
"apiName": "reload",
|
||||
"args": ["force"],
|
||||
"argsText": "force"
|
||||
}
|
||||
```
|
||||
|
||||
字段说明:
|
||||
- `id`:命令唯一 ID(用于追踪)
|
||||
- `timestamp`:命令下发时间
|
||||
- `source`:固定可写 `BLS Project Console`
|
||||
- `command`:命令名称或命令文本
|
||||
- `args`:可选对象参数
|
||||
返回建议:
|
||||
|
||||
- 2xx 表示成功
|
||||
- 非 2xx 表示失败(控制台会展示 upstreamStatus 与部分返回内容)
|
||||
|
||||
## 4. 兼容与错误处理建议
|
||||
|
||||
@@ -107,4 +132,5 @@ value:**JSON 对象**(在 Redis 中以 JSON 字符串形式存储)。
|
||||
|
||||
## 5. 与本项目代码的对应关系(实现中)
|
||||
|
||||
后端通过 `/api/commands` 将命令写入 `${targetProjectName}_控制`;通过 `/api/logs` 读取 `${projectName}_项目控制台`(以仓库当前实现为准)。
|
||||
- 后端通过 `/api/commands`:从 `${targetProjectName}_项目心跳` 读取 `apiBaseUrl` 与 `lastActiveAt`,在线时调用目标项目 API。
|
||||
- 后端通过 `/api/logs`:读取 `${projectName}_项目控制台`;并基于 `${projectName}_项目心跳` 返回在线/离线与 API 地址信息。
|
||||
|
||||
Reference in New Issue
Block a user