> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# System Messages 集合

`systemmessages` 保存管理员向所有已登录用户发布的全站横幅。一个文档是一条消息。由 `web` 负责；schema 为 `services/web/app/src/models/SystemMessage.mjs`，代码为 `services/web/app/src/Features/SystemMessages/SystemMessageManager.mjs`。

#### 字段

| 字段 | 类型 | 含义 | 来源 |
| - | - | - | - |
| `_id` | ObjectId | 消息 id。浏览器通过此 id 记住用户关闭了哪些消息（`services/web/frontend/js/shared/components/system-message.tsx:10`）。 | `SystemMessage.mjs:5` |
| `content` | String | 消息文本，默认 `''`。 | `SystemMessage.mjs:7` |
| `__v` | Number | Mongoose 版本键，由 `message.save()` 添加。 | `SystemMessageManager.mjs:29-30` |

#### 谁写入

| 代码 | 作用 |
| - | - |
| `SystemMessageManager.mjs:28-33` (`createMessage`) | `POST /admin/messages` (`services/web/app/src/router.mjs:1150-1152`, `services/web/app/src/Features/ServerAdmin/AdminController.mjs:151-159`): 添加一条消息。 |
| `SystemMessageManager.mjs:22-26` (`clearMessages`) | `POST /admin/messages/clear` (`router.mjs:1155-1157`, `AdminController.mjs:161-168`): 删除所有消息。无法只删除其中一条。 |

#### 谁读取

| 代码 | 作用 |
| - | - |
| `SystemMessageManager.mjs:50-65` | 每个 `web` 进程都在内存中保存所有消息，每 20 到 30 秒重新加载一次，并在自身创建或清空后立即重新加载。 |
| `services/web/app/src/Features/SystemMessages/SystemMessageController.mjs:6-24` | `GET /system/messages` (`router.mjs:331`): 向已登录用户返回缓存的消息。网站关闭期间（`siteIsOpen` 为 false），它改为返回一条固定通知，该通知不存储在 Mongo 中。 |
| `AdminController.mjs:83-84` | `/admin` 页面直接从 Mongo 列出消息。 |

#### 索引

没有迁移在 `systemmessages` 上创建索引；只有默认的 `_id` 索引。

#### 说明

* 设置 `notifyOnSystemMessageChanges` 后，创建或清空操作还会发布到 Redis 频道 `refresh-system-messages`，使其他 `web` 进程立即重新加载（`SystemMessageManager.mjs:9`、`:35-48`、`:75-87`）。未设置时，它们会在下一次定时重新加载时获取变更。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.