首页
/ AnotherRedisDesktopManager 用户手册:从安装到精通的完整教程

AnotherRedisDesktopManager 用户手册:从安装到精通的完整教程

2026-02-04 04:39:37作者:幸俭卉

1. 引言

1.1 什么是 AnotherRedisDesktopManager?

AnotherRedisDesktopManager(简称 ARDM)是一款跨平台的 Redis 桌面管理工具,提供直观的图形用户界面(GUI),支持连接到 Redis 服务器进行数据查看、修改、监控等操作。它兼容 Linux、Windows 和 macOS 系统,以其高效的性能和稳定的运行而受到开发者青睐,尤其在处理大量键值对时不会出现崩溃问题。

1.2 本文档结构

本文档将从安装开始,逐步引导您掌握 ARDM 的全部功能,包括:

  • 环境准备与安装
  • 基本界面介绍
  • 连接 Redis 服务器(包括单机、集群、哨兵模式)
  • 数据管理操作(增删改查)
  • 高级功能(自定义视图、命令行操作、性能监控)
  • 常见问题解答

2. 安装与环境配置

2.1 系统要求

ARDM 对系统资源要求较低,但为获得最佳体验,建议满足以下条件:

  • 操作系统:Windows 7+、macOS 10.12+、Linux (Ubuntu 16.04+, CentOS 7+)
  • CPU:1 GHz 或更高
  • 内存:至少 1GB RAM
  • 存储空间:至少 100MB 可用空间

2.2 安装方法

根据您的操作系统,选择以下安装方式:

2.2.1 Windows 系统

方法一:直接下载安装包

  1. 访问 ARDM 的 GitCode 仓库:https://gitcode.com/gh_mirrors/an/AnotherRedisDesktopManager
  2. 在 "Releases" 页面下载最新的 .exe 安装包
  3. 双击下载的文件,按照安装向导完成安装

方法二:使用包管理器

  • Chocolatey
    choco install another-redis-desktop-manager
    
  • Winget
    winget install qishibo.AnotherRedisDesktopManager
    

2.2.2 macOS 系统

方法一:下载 DMG 镜像

  1. 访问上述 GitCode 仓库,下载最新的 .dmg 文件
  2. 打开 DMG 文件,将 ARDM 拖入 Applications 文件夹

方法二:使用 Homebrew

brew install --cask another-redis-desktop-manager

注意:如果安装后无法打开,提示"不受信任的开发者",请在终端执行以下命令:

sudo xattr -rd com.apple.quarantine /Applications/Another\ Redis\ Desktop\ Manager.app

2.2.3 Linux 系统

方法一:AppImage 包

  1. 下载最新的 .AppImage 文件
  2. 添加可执行权限并运行:
    chmod +x Another_Redis_Desktop_Manager-*.AppImage
    ./Another_Redis_Desktop_Manager-*.AppImage
    

方法二:Snap 包

sudo snap install another-redis-desktop-manager

注意:如果选择私钥时提示权限不足,执行以下命令:

sudo snap connect another-redis-desktop-manager:ssh-keys

2.3 源码编译(开发人员)

如果您需要从源码构建 ARDM(例如开发自定义功能),请按照以下步骤操作:

2.3.1 准备环境

  • Node.js v14.x 或更高版本
  • npm v6.x 或更高版本
  • Git

2.3.2 编译步骤

克隆代码库

git clone https://gitcode.com/gh_mirrors/an/AnotherRedisDesktopManager.git --depth=1
cd AnotherRedisDesktopManager

安装依赖

npm install
# 如果 electron 下载缓慢,可设置国内镜像
ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/" npm install

启动开发服务器

npm start
# 等待编译完成(显示 100%)后,打开新终端执行:
npm run electron

构建安装包

# 准备打包
npm run pack:prepare

# 构建对应平台的安装包
npm run pack:win   # Windows 64位
npm run pack:win32 # Windows 32位
npm run pack:mac   # macOS
npm run pack:linux # Linux

3. 界面介绍

成功安装并启动 ARDM 后,您将看到以下界面布局:

3.1 主界面布局

ARDM 的界面主要分为四个区域:

flowchart TD
    A[菜单栏] --> B[工具栏]
    C[连接面板] --> D[主操作区]
    D --> E[键值列表]
    D --> F[数据详情]
    G[状态栏]
  • 菜单栏:包含文件、编辑、视图、帮助等菜单选项。
  • 工具栏:提供常用操作的快捷按钮,如新建连接、刷新、搜索等。
  • 连接面板:左侧面板,显示已保存的 Redis 连接,可展开查看各个数据库。
  • 主操作区:中央区域,根据选择的功能显示不同内容,如键值列表、数据详情、命令行界面等。
  • 状态栏:底部显示当前连接状态、服务器信息、操作提示等。

3.2 界面元素说明

元素名称 位置 功能描述
连接列表 左侧面板 显示所有已保存的 Redis 连接,可右键进行管理
数据库切换器 连接面板下方 选择当前连接中的不同数据库(DB0, DB1...)
键值搜索框 工具栏 搜索当前数据库中的键,支持模糊匹配
键类型过滤器 主操作区顶部 按类型(String, Hash, List 等)筛选键
命令行终端 主操作区标签页 可直接输入 Redis 命令并执行
数据可视化器 主操作区 根据键类型显示不同的数据编辑界面

4. 连接 Redis 服务器

4.1 新建连接

要连接到 Redis 服务器,请按照以下步骤操作:

  1. 点击工具栏中的 "新建连接" 按钮(或使用快捷键 Ctrl+N/Cmd+N
  2. 在弹出的 "新建连接" 对话框中填写连接信息

4.1.1 基本连接信息

参数 说明 示例
连接名称 自定义连接的名称,便于识别 "生产环境-Redis集群"
主机 Redis 服务器 IP 或域名 "127.0.0.1" 或 "redis.example.com"
端口 Redis 服务端口 默认 6379
密码 Redis 认证密码(如无则留空) "your_redis_password"
用户名 Redis 6.0+ ACL 用户名(如无则留空) "default"
数据库 默认连接的数据库编号 0(默认)

4.1.2 高级选项

点击 "高级选项" 展开更多设置:

  • 连接超时:设置连接超时时间(秒),默认 10 秒
  • 键分隔符:用于树形视图的键分隔符,默认 ":"
  • 只读模式:勾选后只能查看数据,无法修改
  • 颜色标记:为连接设置颜色标签,便于区分

4.2 特殊连接方式

4.2.1 SSH 隧道连接

如果 Redis 服务器仅允许内网访问,可通过 SSH 隧道连接:

  1. 在 "新建连接" 对话框中,勾选 "SSH 隧道"
  2. 填写 SSH 信息:
    • SSH 主机:SSH 服务器地址
    • SSH 端口:默认 22
    • SSH 用户名:登录 SSH 的用户名
    • 认证方式:密码或私钥(选择对应选项并填写)

4.2.2 Redis 集群连接

要连接 Redis 集群(Cluster):

  1. 在 "新建连接" 对话框中,勾选 "集群模式"
  2. 填写集群中任意节点的主机和端口
  3. 其他信息(密码、SSH 等)按需填写

注意:集群连接需要确保 ARDM 能访问到集群中的所有节点。如果通过 SSH 连接内网集群,Redis 主机应填写内网 IP(如 192.168.1.100)。可通过以下方法获取内网 IP:

  1. 先以非集群模式通过 SSH 连接
  2. 打开命令行终端,执行 CLUSTER NODES
  3. 从输出结果中选择任意节点的 IP

4.2.3 哨兵(Sentinel)模式连接

连接到 Redis 哨兵集群:

  1. 在 "新建连接" 对话框中,勾选 "哨兵模式"
  2. 填写哨兵信息:
    • 哨兵主机:哨兵节点 IP 或域名
    • 哨兵端口:哨兵服务端口(默认 26379)
    • 主节点名称:哨兵监控的主节点组名称(如 "mymaster")
    • 节点密码:Redis 主从节点的密码(如设置)

4.3 管理连接

4.3.1 编辑/删除连接

  • 编辑:右键点击连接列表中的连接名称,选择 "编辑连接"
  • 删除:右键点击连接名称,选择 "删除连接",或选中后按 Delete

4.3.2 克隆连接

对于需要创建相似配置的连接,可使用克隆功能:

  1. 右键点击现有连接,选择 "克隆连接"
  2. 在弹出的对话框中修改必要信息,点击 "确定"

4.3.3 连接颜色标记

为不同环境的连接设置不同颜色,便于快速识别:

  1. 右键点击连接,选择 "设置颜色"
  2. 从调色板中选择一种颜色,或自定义颜色

5. 数据管理

5.1 键值浏览

成功连接到 Redis 服务器后,主操作区将显示当前数据库中的键值列表。

5.1.1 键值列表视图

ARDM 提供两种键值浏览模式:

  1. 列表视图:默认模式,以表格形式展示键名、类型、TTL、大小等信息。
  2. 树形视图:按键分隔符(默认 ":")将键组织成树形结构,适合有层级命名的键(如 "user:100:info")。

切换视图方式:点击工具栏中的 "视图" 按钮,选择 "列表视图" 或 "树形视图"。

5.1.2 键搜索与筛选

  • 快速搜索:在工具栏搜索框输入关键词,实时筛选包含关键词的键。
  • 高级筛选:点击 "筛选" 按钮,可按键类型(String, Hash, List, Set, ZSet, Stream)、TTL 范围等条件筛选。

5.2 键值操作

5.2.1 创建新键

  1. 点击工具栏中的 "+" 按钮或右键点击空白处选择 "新建键"
  2. 在弹出的对话框中设置:
    • 键名:输入键的名称
    • 键类型:从下拉菜单选择(String, Hash, List 等)
    • TTL:设置过期时间(秒),永不过期留空
  3. 点击 "确定" 后,在数据编辑区输入键值内容,点击 "保存"

5.2.2 查看和编辑键值

  1. 双击列表中的键名,或右键点击选择 "查看/编辑"
  2. 根据键类型,ARDM 会显示相应的编辑界面:

String 类型

  • 文本模式:直接编辑文本内容
  • 二进制模式:以十六进制查看和编辑二进制数据
  • JSON 模式:如果值是 JSON 格式,可切换到 JSON 视图进行结构化编辑

Hash 类型

  • 表格形式展示 field-value 对
  • 可直接添加、编辑、删除字段
  • 支持批量导入/导出(CSV 格式)

List 类型

  • 按索引顺序展示列表元素
  • 支持在头部/尾部添加元素,或插入指定位置
  • 可直接编辑元素值,或删除选中元素

Set/ZSet 类型

  • Set:无序集合,支持添加、删除元素
  • ZSet(Sorted Set):有序集合,可编辑元素分数(score)和值,支持按分数排序

Stream 类型

  • 展示 Stream 中的消息条目
  • 支持添加新消息、删除消息
  • 可查看消费者组和消费者信息

5.2.3 删除键

  • 单个删除:右键点击键名,选择 "删除",或选中后按 Delete
  • 批量删除:按住 Ctrl/Cmd 键选择多个键,右键选择 "批量删除"
  • 按条件删除:使用搜索或筛选功能选中多个键,点击工具栏 "删除所选"

5.2.4 导入/导出数据

导出数据

  1. 选中一个或多个键
  2. 右键点击选择 "导出"
  3. 选择导出格式(JSON、CSV 或 Redis 命令)
  4. 指定保存路径,点击 "确定"

导入数据

  1. 右键点击键列表空白处,选择 "导入"
  2. 选择导入文件(支持 JSON、CSV 或 .rdb 文件)
  3. 选择导入选项(如是否覆盖现有键)
  4. 点击 "确定" 开始导入

5.3 命令行操作

ARDM 内置命令行终端,支持直接执行 Redis 命令:

5.3.1 打开命令行终端

  • 点击主操作区顶部的 "终端" 标签页
  • 或使用快捷键 Ctrl+T/Cmd+T 新建终端标签

5.3.2 执行命令

在终端输入框中输入 Redis 命令,按回车执行。支持命令自动补全(按 Tab 键)。

示例:

SET user:100:name "John Doe"
GET user:100:name
HSET user:100:info age 30 email "john@example.com"
HGETALL user:100:info
KEYS user:*

5.3.3 命令执行日志

所有通过终端执行的命令都会被记录,点击 "命令日志" 标签可查看历史执行记录,包括命令、执行时间和结果。

6. 高级功能

6.1 自定义数据视图

当默认的数据展示方式不满足需求时(如需要解码特殊格式的数据),ARDM 支持自定义数据视图:

6.1.1 创建自定义视图

  1. 在键值编辑界面,点击 "视图" 下拉菜单,选择 "自定义" -> "新增"
  2. 在配置对话框中设置:
    • 名称:自定义视图的名称
    • 命令:可执行脚本路径(如 Python、Node.js 脚本)
    • 参数:传递给脚本的参数,支持占位符 {KEY}(键名)、{VALUE}(值)、{HEX}(值的十六进制表示)

6.1.2 自定义视图示例

Python 脚本示例(解码 Pickle 数据)

  1. 创建脚本文件 pickle_decoder.py

    import sys
    import pickle
    
    def main():
        hex_data = sys.argv[1]
        binary_data = bytes.fromhex(hex_data)
        try:
            data = pickle.loads(binary_data)
            print(data)
        except Exception as e:
            print(f"解码失败: {str(e)}")
    
    if __name__ == "__main__":
        main()
    
  2. 在 ARDM 自定义视图配置中:

    • 名称:Pickle 解码器
    • 命令:/usr/bin/python3
    • 参数:/path/to/pickle_decoder.py {HEX}
  3. 应用后,选择该视图即可自动解码 Pickle 格式的数据。

6.2 性能监控

ARDM 提供基本的 Redis 性能监控功能:

6.2.1 内存分析

  1. 连接到 Redis 服务器后,点击工具栏的 "内存分析" 按钮
  2. 系统将扫描当前数据库的键,生成内存占用统计:
    • 按键类型统计内存占比
    • 按键名前缀统计内存占比
    • 大键列表(占用内存前 N 的键)

6.2.2 慢查询日志

  1. 在左侧连接面板右键点击连接,选择 "慢查询日志"
  2. 查看 Redis 记录的慢查询命令,包括执行时间、耗时、参数等
  3. 可按时间范围、耗时等条件筛选

6.3 命令行启动连接

对于需要频繁连接特定 Redis 服务器的场景,可通过命令行参数直接启动 ARDM 并连接:

6.3.1 基本命令格式

# Windows
"路径\Another Redis Desktop Manager.exe" [参数]

# macOS
open /Applications/Another\ Redis\ Desktop\ Manager.app --args [参数]

# Linux
./Another\ Redis\ Desktop\ Manager.AppImage [参数]

6.3.2 常用参数示例

连接单机 Redis

--host 127.0.0.1 --port 6379 --auth password --name "本地Redis" --save

连接 Redis 集群

--host 192.168.1.100 --port 6379 --auth password --cluster --name "生产集群"

通过 SSH 隧道连接

--host 127.0.0.1 --port 6379 --ssh-host 203.0.113.1 --ssh-username root --ssh-private-key ~/.ssh/id_rsa

完整参数列表

参数类别 参数名 说明
通用 --host Redis 主机地址(必填)
--port Redis 端口(默认 6379)
--auth Redis 密码
--name 连接名称
--username Redis 6.0+ ACL 用户名
--readonly 只读模式
--save 保存连接信息
SSH --ssh-host SSH 主机地址
--ssh-port SSH 端口(默认 22)
--ssh-username SSH 用户名
--ssh-password SSH 密码
--ssh-private-key SSH 私钥路径
集群 --cluster 启用集群模式
哨兵 --sentinel-master-name 哨兵主节点组名称
--sentinel-node-password Redis 节点密码

7. 配置与个性化

7.1 全局设置

点击菜单栏 "设置" -> "偏好设置",可配置全局选项:

7.1.1 外观设置

  • 主题:选择 "浅色" 或 "深色" 主题
  • 字体:自定义界面字体和字号
  • 语言:切换界面语言(支持中文、英文、日文等多种语言)

7.1.2 性能设置

  • 最大键数量:设置单次加载的最大键数量,默认 10000
  • 扫描计数:Redis SCAN 命令的 COUNT 参数,影响大数据库加载速度
  • 连接池大小:设置同时保持的最大连接数

7.2 快捷键

ARDM 支持丰富的快捷键,提高操作效率:

操作 Windows/Linux macOS
新建连接 Ctrl+N Cmd+N
关闭连接 Ctrl+W Cmd+W
新建键 Ctrl+K Cmd+K
删除选中键 Delete Delete
搜索键 Ctrl+F Cmd+F
打开终端 Ctrl+T Cmd+T
刷新键列表 F5 F5
保存当前编辑 Ctrl+S Cmd+S
帮助文档 F1 F1

可在 "设置" -> "快捷键" 中查看完整列表并自定义。

8. 常见问题解答(FAQ)

8.1 连接问题

Q1: 无法连接到 Redis 服务器,提示 "连接超时"?

A1: 请检查:

  • Redis 服务器是否启动并监听正确的端口
  • 防火墙是否允许访问 Redis 端口
  • 主机地址和端口是否填写正确
  • 如果是远程服务器,网络是否通畅(可使用 pingtelnet 测试)

Q2: 连接 Redis 集群时提示 "无法获取集群信息"?

A2: 这通常是因为 ARDM 无法访问集群中的其他节点。解决方法:

  • 确保所有集群节点的 IP 和端口都能从 ARDM 所在机器访问
  • 如果通过 SSH 隧道连接,Redis 主机应填写内网 IP(参见 4.2.2 节)
  • 检查集群是否正常运行(可通过 CLUSTER INFO 命令验证)

8.2 数据操作问题

Q3: 编辑键值后保存失败,提示 "权限不足"?

A3: 可能原因:

  • Redis 服务器启用了只读模式(如从节点)
  • 连接时勾选了 "只读模式"
  • Redis 6.0+ ACL 权限限制,当前用户没有写权限

Q4: 键列表显示不完整,部分键未加载?

A4: ARDM 默认采用 SCAN 命令分页加载键,以避免阻塞服务器。如需加载所有键:

  • 点击键列表底部的 "加载更多" 直到所有键显示
  • 或在 "设置" -> "性能" 中增大 "单次扫描数量"

8.3 性能问题

Q5: 加载包含大量键(10万+)的数据库时界面卡顿?

A5: 建议:

  • 使用树形视图并合理设置键分隔符,减少同时显示的键数量
  • 在 "设置" 中降低 "最大键数量",只加载常用键
  • 避免在高峰期执行全库扫描操作

8.4 其他问题

Q6: 如何迁移已保存的连接配置到新电脑?

A6: ARDM 的连接配置保存在用户目录下的 .another-redis-desktop-manager 文件夹中。复制该文件夹到新电脑的对应位置即可迁移配置。

Q7: 能否自定义主题颜色?

A7: 目前 ARDM 仅支持内置的浅色和深色主题,不支持自定义颜色。但可通过修改源码中的 CSS 文件实现自定义主题(适合开发人员)。

9. 总结与展望

9.1 功能回顾

AnotherRedisDesktopManager 作为一款优秀的 Redis 桌面管理工具,提供了从基本连接到高级监控的全方位功能,包括:

  • 跨平台支持,安装简单
  • 多种连接方式(单机、集群、哨兵、SSH 隧道)
  • 直观的键值管理界面,支持所有 Redis 数据类型
  • 命令行终端和命令日志功能
  • 自定义数据视图和性能监控
  • 丰富的快捷键和个性化设置

9.2 未来展望

ARDM 仍在持续开发中,未来可能会增加更多功能,如:

  • 更详细的性能监控图表
  • 数据备份和恢复工具
  • 支持 Redis 模块(如 RedisJSON、RedisSearch)的高级功能
  • 多语言界面优化

9.3 获取帮助

如果在使用过程中遇到问题,可通过以下途径获取帮助:

  • 查看官方文档:访问项目 GitCode 仓库的 README 文件
  • 提交 Issue:在 GitCode 仓库的 "Issues" 页面反馈问题
  • 社区讨论:加入相关 Redis 或 ARDM 用户交流群

10. 附录

10.1 支持的 Redis 命令

ARDM 支持绝大多数 Redis 核心命令,包括但不限于:

命令类别 常用命令
键管理 DEL, EXISTS, KEYS, RENAME, TYPE, TTL, PERSIST
String SET, GET, MSET, MGET, INCR, DECR, APPEND
Hash HSET, HGET, HGETALL, HDEL, HKEYS, HVALS
List LPUSH, RPUSH, LPOP, RPOP, LRANGE, LSET
Set SADD, SREM, SMEMBERS, SISMEMBER, SUNION
ZSet ZADD, ZRANGE, ZREM, ZSCORE, ZRANK
Stream XADD, XREAD, XDEL, XRANGE, XGROUP
集群 CLUSTER INFO, CLUSTER NODES, CLUSTER KEYSLOT

10.2 支持的数据视图类型

ARDM 为不同数据格式提供了专用视图:

视图类型 适用场景
文本视图 普通文本数据
二进制视图 二进制数据(如图片、序列化对象)
JSON 视图 JSON 格式数据,支持格式化和编辑
Msgpack 视图 Msgpack 序列化数据
Java 序列化视图 Java 对象序列化数据
Protobuf 视图 Protobuf 格式数据(需提供 .proto 文件)
Gzip/Brotli 视图 压缩数据自动解压展示
登录后查看全文
热门项目推荐
相关项目推荐