功能模块
本文档基于当前代码实现(前端页面、后端路由、菜单种子)整理,覆盖已落地的功能能力。
模块全景
权限与组织(IAM)
专题文档:权限与组织
| 模块 | 当前能力 |
|---|---|
| 用户管理 | 用户 CRUD、状态管理、角色/部门/岗位分配、批量删除/启用/停用/重置密码、Excel 批量导入(模板下载 + 导入结果反馈)、账号解锁、管理员重置密码、在线状态实时标记、强制下线 |
| 角色管理 | 角色 CRUD、数据权限范围(dataScope)、菜单权限分配 |
| 菜单管理 | 目录/菜单/按钮三级模型、树形维护、可见性与排序控制 |
| 部门管理 | 树形组织维护、负责人与联系信息管理 |
| 岗位管理 | 岗位 CRUD、启停与批量操作 |
| 用户组 | 用户组 CRUD、状态筛选、负责人/所属部门维护、成员全量设置、批量添加/移除成员、批量删除 |
系统配置与基础能力
| 模块 | 当前能力 |
|---|---|
| 系统配置 | 系统行为配置中心(验证码、注册开关、密码策略、锁定策略、水印等),详见系统内置配置 |
| 数据字典 | 字典主表 + 字典项维护(支持树形结构),字典项可配置颜色标签与 JSON 元数据扩展字段,状态与排序管理 |
| 地区管理 | 省/市/区三级区划数据维护与选择组件支持 |
| 标签管理 | 标签 CRUD、颜色配置、分组筛选、批量操作 |
| 邮件配置 | SMTP 配置与测试发送 |
| OAuth 登录配置 | 第三方登录开关与凭据配置(GitHub / 钉钉 / 企业微信等),详见OAuth 第三方登录 |
| OAuth2 应用管理 | 将 Zenith Admin 作为 OAuth2 服务端,管理第三方应用(客户端 ID/密钥)、回调地址、授权范围、授权类型、应用令牌与撤销 |
| 消息模板 | 模板 CRUD,支持预览/测试发送,服务于系统通知能力 |
| 数据脱敏 | 对指定实体字段配置脱敏规则(手机号 / 邮箱 / 身份证 / 银行卡 / 自定义掩码),支持角色豁免、敏感字段扫描与批量创建规则,防止敏感数据明文泄漏 |
| Webhook 机器人 | 聊天 Webhook 机器人 CRUD、令牌重置,用于外部系统向消息中心推送卡片消息 |
文件与存储
专题文档:文件与存储
| 模块 | 当前能力 |
|---|---|
| 文件管理 | 文件上传(Magic Bytes 类型安全校验)、列表、预览/下载、删除、批量下载、网格/列表双视图 |
| 存储配置 | 支持 9 种存储后端:local / oss / s3 / cos / obs / kodo / bos / azure / sftp,支持默认存储切换与配置管理 |
短信与邮件
专题文档:通知中心
| 模块 | 当前能力 |
|---|---|
| 短信配置 | 多服务商短信通道配置与管理 |
| 短信模板 | 模板 CRUD、变量占位符支持 |
| 短信发送日志 | 发送记录查询、状态追踪 |
| 邮件配置 | SMTP 主机、端口、加密方式、授权密码配置与测试发送 |
| 邮件模板 | 模板 CRUD、预览/测试发送 |
| 邮件发送日志 | 发送记录查询、状态追踪 |
站内信
| 模块 | 当前能力 |
|---|---|
| 站内信管理 | 个人/管理员视角站内信列表、发送、详情查看、未读计数、标记已读/删除 |
| 站内信模板 | 模板创建与维护 |
运维与可观测性
| 模块 | 当前能力 |
|---|---|
| 仪表盘 | 用户、会话、登录/操作统计与通知摘要、统计图表 |
| 服务监控 | 系统资源指标与运行状态展示(含 SSE 监控流式接口)、慢查询/慢日志、磁盘 IO、CPU 温度(Linux)、Top 进程(CPU/内存排名)、持久化历史趋势(每分钟采样落库,支持 1h/6h/24h/7d/30d 分桶聚合查询) |
| 监控告警 | 基于阈值的告警规则引擎(CPU/内存/磁盘/Swap/负载/网络/磁盘IO 等 14 维指标)、持续 N 分钟超阈触发、自动恢复解除、静默期防轰炸,支持邮件/Webhook/站内三通道;告警记录可按指标/级别/状态筛选 |
| 在线会话 | 在线会话查询、强制下线(单会话/全会话) |
| 缓存管理 | 缓存键列表、按分类清理、单键删除、全量清理、缓存值查看 |
| 定时任务 | 任务 CRUD、Cron 配置(支持 5/6 段表达式)、启停与手动执行、执行记录、概览统计;基于 pg-boss 调度引擎,原生多进程安全,支持指数退避重试,详见定时任务 |
| 数据库备份 | 手动创建/下载/删除备份,详见数据库与迁移 |
| 数据库管理 | SQL 控制台(Monaco Editor、只读事务)、表数据浏览与编辑、ER 图、批量操作、运维面板、SQL 查询收藏(命名保存常用 SQL) |
| 维护模式 | 全局开关切换上线 / 维护状态;可配置维护公告文案与预计恢复时间;开启后前端展示全页维护提示页 |
| 限流防护 | 接口限流规则可视化配置、实时统计、拦截记录、解封/重置 |
| 日志文件 | 服务端日志文件列表、查看、下载、删除、关键词搜索 |
| 指标与链路 | Prometheus 指标(/metrics)+ OpenTelemetry(可选) |
系统运维
专题文档:系统运维
提供一站式服务器运维能力,无需额外运维工具即可在页面内管理工作机。
| 模块 | 当前能力 |
|---|---|
| Web 终端 | 基于 WebSocket 的全功能 Web SSH 终端(多分屏、大小调整、实时输入输出) |
| SSH 配置与 SFTP | SSH 连接配置管理(密码 / 密钥 / Agent)、按用户隔离;远程 SFTP 文件浏览、上传/下载、新建、重命名/移动、删除、文本编辑与 chmod 权限修改 |
| 终端录屏 | 终端操作录屏列表与实时回放、按时间/大小筛选、删除(支持按系统配置自动清理) |
| 终端会话 | 活动终端会话列表、按类型筛选(local / ssh / docker)、会话快照与强制终止 |
| 文件管理器 | 服务器文件系统浏览、上传/下载、新建、重命名/移动、复制、删除、文本编辑、权限查看与 chmod 修改、压缩(ZIP) / 解压(zip/tar/gz/tgz/bz2/xz)、递归深度搜索、文件校验和(MD5/SHA1/SHA256) |
| 进程管理 | 进程列表与实时资源占用、结束进程、调整优先级(nice)、进程详情(命令行 / 工作目录 / 环境变量(Linux) / 网络连接) |
| 端口监听 | 当前监听端口列表、常见端口服务名识别、进程关联、协议筛选 / 自动刷新(5/10/30s)/ 一键结束占用进程 |
| Docker 管理 | 容器/镜像/网络/卷列表、启停/重启/删除、实时日志查看、容器/镜像/网络/卷 prune 与一键系统清理 |
| 网络诊断 | ping、traceroute、DNS 记录查询(A/AAAA/MX/TXT/NS/CNAME/SOA)、反向 DNS(PTR)、HTTP(S) 探测、端口连通性检测、本机网卡信息 |
| 服务管理 | systemd 服务列表、状态查看、启停/重启、开机自启 enable/disable、mask/unmask 屏蔽、失败服务筛选、服务详情、实时日志追踪 |
| 日志查看器 | 服务器日志流式查看(tail -f)、ANSI 色彩渲染、关键词高亮/过滤、日志级别自动高亮(ERROR/WARN/INFO/DEBUG) + 级别筛选、日志文件下载 |
日志与通知
| 模块 | 当前能力 |
|---|---|
| 登录日志 | 登录行为记录、状态/IP/设备信息追踪(浏览器、GPU、CPU 核心、内存等)、登录趋势统计分析 Tab |
| 操作日志 | 操作轨迹记录,支持变更前后 Diff、统计分析 Tab |
| 通知公告 | 公告 CRUD、发布/草稿管理、已读记录、实时推送 |
| 通知中心 | 个人通知收件箱、标记已读 |
工作流引擎
| 模块 | 当前能力 |
|---|---|
| 流程定义 | 流程定义 CRUD、复制、导入/导出、发布/启用/禁用、状态管理、历史版本查看/恢复与版本差异对比 |
| 流程分类 | 分类增删改查、颜色标记、设计器侧栏集成 |
| 表单库 | 表单 CRUD、可视化表单设计、字段配置与内联渲染 |
| 业务表单接入 | 三种表单类型:表单库设计器 / 自定义业务表单(自写 React 页面,数据存流程)/ 业务系统主导(businessKey 关联外部业务实体,事件回调回写状态,附「请假」最小 Demo) |
| 流程模板 | 模板列表、新增/编辑/删除、流程另存为模板、从模板创建流程 |
| 发起工作台 | 按分类浏览已发布流程,快速发起申请 |
| 流程设计器 | 可视化节点编排(发起人/审批/办理/抄送/条件分支/路由分支/延迟器/触发器/子流程)、表单字段设计、表单权限与操作权限配置、节点高级设置、撤销/重做 |
| 我的申请 | 发起流程、草稿保存/提交、查看进度、撤回申请、审批记录追踪 |
| 待我审批 | 审批通过/驳回、转办、委派、加签/减签、退回、催办、跳转、重派、撤回审批、审批意见与手写签名 |
| 抄送我的 / 我已办 | 抄送任务与已处理任务列表,支持查看流程详情与轨迹 |
| 流程监控 | 全局实例监控、状态筛选、实例明细、流程轨迹、取消/删除实例、统计分析、逾期任务与导出 |
| 流程自动化 | 基于触发条件的自动化规则配置(updateData / deleteData 触发器),无需人工介入自动执行数据操作 |
| 审批代理 | 审批委托规则配置与启停,用于指定时间范围内代办任务 |
| 事件总线 | 基于 EventEmitter 的生命周期事件,支持 WebSocket、Webhook、触发器、外部审批、节点监听、通知和聊天订阅 |
| 事件订阅管理 | 可视化配置 Webhook 订阅端点、查看订阅状态与投递记录 |
| 触发器执行记录 | 触发器历史执行日志、执行结果与失败详情查看 |
| 外部审批 | 外部审批配置与回调地址查看 |
| 快捷短语 | 审批意见快捷短语管理与调用 |
即时消息中心(Chat)
专题文档:即时通讯
| 模块 | 当前能力 |
|---|---|
| 会话管理 | 单聊/群聊会话创建与列表管理、会话置顶/星标、免打扰、删除、在线状态与已读状态 |
| 群管理 | 成员增删、群主转移、群信息维护、群公告 |
| 消息能力 | 文本 / 图片 / 文件 / 链接预览 / 投票 / 语音 / 通话记录消息、回复、撤回、编辑、转发(逐条/合并)、@提及、表情回应、收藏与置顶 |
| 草稿与状态 | 切换会话自动保存草稿、输入状态实时提示、发送失败重试 |
| 媒体库 | 按会话浏览历史图片与文件、图片预览(灯箱) |
| 搜索与定位 | 会话消息搜索、上下文定位、收藏消息回看、全局消息搜索 |
| 快捷聊天 | 浮动快捷聊天按钮,任意页面快速唤起 |
| 实时通信 | WebSocket 消息收发与状态同步、断线重连、消息补拉 |
数据分析
| 模块 | 当前能力 |
|---|---|
| 行为分析 | 页面 PV/UV 、停留时长、点击事件等埋点指标,支持时间范围、设备、操作系统多维筛选 |
| 数据管理 | 分析数据请求历史列表、按条件清除 |
| 前端错误监控 | JS 异常/Promise 拒绝采集与上报、错误列表与程序堆栈查看、按错误类型/页面/异常信息筛选 |
报表中心
专题文档:报表中心
自助式数据可视化与报表平台,对标 JEECG「积木报表」,覆盖数据接入 → 加工 → 仪表盘/大屏/打印报表全链路。
| 模块 | 当前能力 |
|---|---|
| 数据源 | API / 内置只读主库 / MySQL / PostgreSQL / SQL Server / 静态数据 / Excel·CSV 上传;凭据 AES 加密、读取脱敏、连接测试 |
| 数据集 | 只读取数、${param} 参数化(防注入)、计算字段(安全表达式)、结果缓存、物化快照、字段格式化/字典翻译、${__userId} 数据权限 |
| 仪表盘 | 拖拽设计器、23 种组件、全局筛选器、点击联动、钻取、条件格式、版本历史、收藏分类、PNG 导出 |
| 数据大屏 | 自由画布 + 等比自适应缩放、深色科技皮肤、翻牌器/滚动榜单/地图/水波球、全屏与自动刷新 |
| 打印报表 | Univer 单元格设计器、${field} 纵向扩展/${SUM} 聚合、套打、浏览器打印与 Excel 导出 |
| AI 问数 | 自然语言生成只读 SQL(NL2SQL),敏感表/列已屏蔽 |
| 数据预警 | 数据集聚合值阈值监控、定时评估、邮件/站内信通知 |
| 分享与协作 | 公开分享链接(密码/过期/iframe)、定时订阅推送、<ReportEmbed> 跨模块嵌入、评论批注 |
支付中心
| 模块 | 当前能力 |
|---|---|
| 支付渠道 | 支付渠道(微信支付/支付宝等)的创建、编辑、启用/禁用与默认切换,详见 Payment |
| 支付订单 | 订单列表与详情查询、手动关闭订单、发起退款,内置订单创建 API(下单/支付/查询) |
| 退款记录 | 退款申请状态查询与详情查看 |
| 回调日志 | 支付平台回调通知完整记录,支持按平台/状态筛选、手动重放 |
会员中心
专题文档:会员中心
采用前台 / 后台双用户体系,后台管理员与前台 C 端会员完全隔离。
| 模块 | 当前能力 |
|---|---|
| 会员管理 | 会员 CRUD、状态管理、重置密码、登录方式与来源展示、会员详情抽屉 |
| 会员等级 | 等级体系维护(成长值阈值 / 折扣 / 权益配置)、与会员账号动态关联 |
| 积分管理 | 积分账户与流水记录、管理员手动调整(事务 + 乐观锁防并发) |
| 钱包管理 | 钱包余额与永久流水、调整余额、充值入账、退款处理(金额单位为分、事务 + 乐观锁) |
| 优惠券 | 优惠券模板(满减券/折扣券)CRUD、发券记录与使用状态查询 |
| 会员签到 | 签到规则配置、签到记录查询,前台会员可签到并获得积分/成长值 |
| 前台 C 端 | 独立 SPA(member.html),支持手机号验证码、手机号 / 邮箱 / 用户名密码登录、会员资料编辑、积分/钱包/卡券/签到浏览 |
微信公众号
专题文档:微信公众号
一级菜单目录,整合微信公众平台开发者能力,支持多公众号统一管理。
| 模块 | 当前能力 |
|---|---|
| 公众号账号 | 多账号管理、凭证与加密模式、回调配置、连接测试、内容安全/关注建会员开关 |
| 粉丝与标签 | 粉丝同步、标签管理、黑名单(拉黑/移出/同步)、与会员体系打通(绑定/扫码送积分/VIP 优先接入) |
| 消息与自动回复 | 消息记录、客服消息(富媒体)、自动回复(富媒体 + 正则匹配 + 命中转人工 + 未命中热词收集) |
| 多客服 | 客服账号管理 + 实时会话状态机(接入/转接/超时自动路由/会话分配)、满意度评价、会话报表、WebSocket 实时 |
| 菜单管理 | 自定义菜单(按钮类型扩展)、个性化菜单(按规则下发 + 匹配测试) |
| 素材与草稿 | 永久素材二进制上传、图文草稿推送草稿箱 |
| 运营触达 | 群发(预览/定时/发送结果)、模板消息(行业/同步/批量/送达回执)、带参二维码(扫码送积分) |
| 网页开发 | 网页授权 OAuth2(含公开回调)、JS-SDK wx.config 签名 |
| 数据统计 | 基础统计、数据立方(用户/消息/图文/分享/接口分析)、内容安全校验 |
安全与账号体系
| 模块 | 当前能力 |
|---|---|
| 认证登录 | JWT 双 Token(Access + Refresh)、登录限流、验证码(可配置) |
| 账号安全 | 登录失败锁定、密码复杂度与过期策略、重置密码流程、找回密码 |
| IP 访问控制 | 白名单/黑名单双模式、支持 CIDR、黑名单优先、拦截日志记录,详见安全体系 |
| 数据脱敏 | 字段级动态脱敏(手机/邮箱/身份证/银行卡/自定义),支持角色豁免 |
| 文件上传安全 | Magic Bytes 检测真实文件类型,防止伪装上传;允许类型白名单可在系统配置中调整 |
| 幂等防重复提交 | 基于 Redis SET NX EX 实现接口幂等拦截,支持客户端 X-Idempotency-Key Token 模式与服务端自动指纹模式,适用于支付创单、工单提交等关键场景 |
| API Token | 个人 API Token 创建/查看/删除、过期时间配置 |
| 个人中心 | 资料维护、头像上传、密码修改、第三方账号绑定信息、个人日志查看 |
多租户(可选)
| 模块 | 当前能力 |
|---|---|
| 租户管理 | 租户 CRUD、状态、有效期、用户上限、绑定租户套餐 |
| 租户套餐 | 套餐 CRUD、状态启停、菜单白名单分配、批量删除;租户绑定套餐即圈定其可用功能范围(SaaS 标配) |
| 视角切换 | 平台超管可切换租户视角进行运营管理 |
开启方式:前后端同时设置 MULTI_TENANT_MODE=true,详见多租户指南。
主题与个性化
| 模块 | 当前能力 |
|---|---|
| 主题切换 | 亮色 / 暗色 / 跟随系统三种模式,刷新后自动恢复 |
| 主题色 | 19 种内置预设色(飞书蓝、微信绿、橙珀、品红等)+ 自定义颜色,全局实时生效 |
| 颜色辅助 | 灰色模式(国家公祭日等场景)、色弱模式(提升对比度),偏好面板一键切换 |
| 页面水印 | 防截图泄漏水印,内容支持动态回退为当前用户名 |
| 路由切换动画 | 4 种可选:无动画 / 淡入 / 上滑 / 左滑 |
| 偏好设置 | 支持拼音搜索快速定位设置项;导航布局、面包屑、侧边栏、表格、标签页等 30+ 项精细配置 |
| 标签页管理 | 多标签右键菜单(刷新/收藏/关闭等)、拖拽排序、超限驱逐策略(FIFO/LRU)、新标签插入位置、双击行为、最大数量限制 |
| 菜单收藏 | 面包屑末尾收藏按钮 + 标签右键收藏,顶部 Popover 快速访问收藏菜单,数据与账号绑定跨设备同步 |
| 最近访问 | 自动记录最近 20 条路由,顶部图标悬浮弹出,支持清空 |
| 侧边栏增强 | 悬浮自动展开、手风琴排他展开、粘性滚动定位 |
| PWA 支持 | 可选启用,支持添加到主屏幕(display: standalone),静态资源预缓存,API 请求走网络保证实时性 |
AI 功能区
专题文档:AI 能力
| 模块 | 当前能力 |
|---|---|
| 智能对话 | 独立 AI Chat 页面,支持对话历史管理、PDF 文档预览 |
| AI 服务商管理 | 多服务商接入配置(模型选择、API Key、端点)、默认服务商切换、连接测试,用户可配置个人 AI 偏好 |
| 提示词模板 | 系统级 / 用户私有提示词模板 CRUD、分类、排序、启停,对话中可一键套用为角色提示词 |
| AI 用量统计 | 按时间范围统计 Token、请求数、模型分布与用户用量 |
| AI 反馈管理 | 查看用户对 AI 回复的点赞/点踩反馈列表,支持按反馈类型与处理状态筛选,辅助持续优化对话质量 |
说明:AI 功能需配置对应服务商的 API Key 方可使用,具体可用模型取决于服务商与部署环境。
跨模块共性能力
权限与访问控制
- 基于菜单 + 按钮权限的细粒度授权
- 动态菜单路由按当前用户权限加载
- 会话管理与强制下线联动
请求安全防护
- 接口限流:
hono-rate-limiter+ Redis,规则可视化配置 - 幂等控制:Redis
SET NX EX原子操作,防止双击/网络重试导致重复提交 - IP 黑白名单:支持 CIDR,黑名单优先,拦截请求自动记录日志
- CSRF 防护:校验
Origin头,生产环境可通过ALLOWED_ORIGINS配置白名单 - 请求体限制 + 超时:通过环境变量全局控制,适配不同部署场景
API 与数据规范
- 统一响应结构:
{ code, message, data } - 列表统一分页结构:
{ list, total, page, pageSize } - OpenAPI + Zod 自动校验,请求参数通过
c.req.valid()获取
实时与可观测
- WebSocket:通知/消息等实时事件推送
- 健康检查:
GET /api/health - 指标采集:
GET /metrics - OpenTelemetry:可选接入 OTLP 生态
文档与调试
- Swagger UI:
/api/docs - OpenAPI JSON:
/api/openapi.json - 详见Swagger / OpenAPI