Redis 可视化预览插件

Maven 模块：mms-plugin-redis-inspect。在管理端提供 Redis 键空间只读浏览（SCAN 分页、类型、TTL、值截断预览），连接通过 Lettuce 直达目标实例，不依赖宿主 RedisTemplate。

白话理解

装好并配置 redis.inspect 后，在 「系统管理 → Redis 预览」 分页扫键、点行看详情；接口为 HOST_MVC：前缀 /plugin/mms.plugin.redis-inspect/ri/，需 plugin:redis:inspect:*。生产建议 只读账号或读副本。

• 标识与运行模式
• 配置（sys_config）
• 权限与菜单
• Demo：引入插件
• Demo：调用能力（HTTP）
• 健康与运维
• 延伸阅读

标识与运行模式

项	值
插件 ID	mms.plugin.redis-inspect
runtimeMode	HOST_MVC
hostServicesContractVersion	3
入口类	com.sxpcwlkj.plugin.redis.inspect.RedisInspectPlugin

配置（sys_config）

• 键后缀：redis.inspect（完整键形如 mms.plugin.mms.plugin.redis-inspect.redis.inspect，与 PluginSysConfigKeys 规则一致）。
• 示例 JSON：主仓 mms-plugins/mms-plugin-redis-inspect/script/redis.inspect.example.json。
• 热更新：保存后下次请求会按新 JSON 重建连接。

安全

密码写在 库配置 中，须控制 sys_config 权限；日志仅记 loginId、前缀长度、键长度 等，不打印键全文与密码。

权限与菜单

执行 script/install.sql，并为角色分配：

权限码	用途
plugin:redis:inspect:scan	meta / ping / scan
plugin:redis:inspect:key_read	key 键详情

菜单组件路径：system/redisInspect/index（见 SQL）。

Demo：引入插件

cd mms-plus/mms-plugins/mms-plugin-redis-inspect
mvn -DskipTests package

将 target/mms-plugin-redis-inspect-*.jar 放入插件目录 lib/，在市场安装并激活；写入 redis.inspect JSON；为用户角色勾选上述两项权限。

Demo：调用能力（HTTP）

为管理端接口根。统一前缀：/plugin/mms.plugin.redis-inspect/ri。

连接元数据（脱敏）

GET {{apiBase}}/plugin/mms.plugin.redis-inspect/ri/meta
Authorization: <token>

SCAN 分页

GET {{apiBase}}/plugin/mms.plugin.redis-inspect/ri/scan?prefix=user:&cursor=&count=100
Authorization: <token>

键详情

GET {{apiBase}}/plugin/mms.plugin.redis-inspect/ri/key?k=mykey
Authorization: <token>

• cursor：首次可省略或 0；后续用上一响应的 cursor，直至 done: true。
• prefix：会变为 MATCH 模式；留空表示 *；若已含 */? 则原样使用。

健康与运维

• 实现 PluginHealthContributor：对 Redis 执行 PING，失败则 health() 抛异常，市场显示异常。
• 访问审计：控制器对 meta / ping / scan / key 打 INFO 日志（含 loginId，键仅存长度）。

延伸阅读

• 需求与验收口径：mms-plus 仓库 version/v2.0.10-插件Redis可视化预览开发计划.md
• JAR 插件分册总览

文档修订

本节随插件实现更新；结构化修订见 日志。