登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  数据库 >  Redis

Redis FUNCTION LIST 怎样查看已加载库的源码

来源:17golang原创

时间:2026-11-16 19:41:50 332浏览 收藏

我在排查 Redis Functions 时,最容易混淆的不是命令拼法,而是“已经加载的函数库信息”和“函数库源码”其实是两种不同的返回内容。FUNCTION LIST 默认可以列出库名、引擎和函数元数据;要把库源码带回来,必须追加 WITHCODE。如果只想看某个库,再用 LIBRARYNAME 提供名称模式。

官方地址:https://redis.io/docs/latest/commands/function-list/

最小可用写法是 FUNCTION LIST LIBRARYNAME 库名模式 WITHCODE。其中 LIBRARYNAME 负责缩小目标库,WITHCODE 负责让返回对象包含 library_code;两者分别解决筛选和取源码,不能互相替代。

先把 FUNCTION LIST 的返回对象分成三层

Redis 官方命令参考把返回信息拆成库级字段和函数级字段:库级有 library_name、engine,函数级有 functions,其中每个函数继续包含 name、description 和 flags。这部分属于“已加载内容的目录”,并不等于源码文本。

Redis FUNCTION LIST 返回对象中查询入口、库级字段和函数级字段的静态关系图
图1:FUNCTION LIST 的库级与函数级字段关系示意图,帮助区分元数据与源码。

因此,第一次排查通常先不取源码,只看有哪些库、库使用什么引擎、库里注册了哪些函数。这样返回内容更小,也更适合做目录盘点。

用 LIBRARYNAME 只定位需要的函数库

LIBRARYNAME 后面跟的是 library name pattern,不是函数名,也不是函数调用名。默认模式相当于匹配所有已加载库;当环境中存在多个业务库时,把命名规则放进模式里,可以避免把无关库一并拉回。

# 先列出所有已加载函数库的元数据,不请求源码
redis-cli --raw FUNCTION LIST

# 只查看名称符合 billing-* 的函数库
redis-cli --raw FUNCTION LIST LIBRARYNAME "billing-*"

# 精确查看一个已知库的元数据
redis-cli --raw FUNCTION LIST LIBRARYNAME "billing-core"

这里的重点是先确认库名边界。若命名模式过宽,结果会包含更多库;若模式写成函数名,通常得不到你想要的库对象。这个命令的复杂度是 O(N),官方文档中的 N 指函数数量,所以批量盘点时也应避免在不需要时带回源码。

追加 WITHCODE 才能看到 library_code

WITHCODE 是一个独立的修饰参数。它不会执行库内函数,也不会加载或更新函数库,只要求 Redis 在每个返回的库对象里附带 library_code。想查看特定库的源码,可以把两个参数放在同一条命令中:

# 只取 billing-* 库,并把每个库的源码字段一起返回
redis-cli --raw FUNCTION LIST LIBRARYNAME "billing-*" WITHCODE

# 已知库名时,精确取一个库的源码字段
redis-cli --raw FUNCTION LIST LIBRARYNAME "billing-core" WITHCODE
Redis LIBRARYNAME 和 WITHCODE 与 library_code、源码审阅之间的静态关系图
图2:LIBRARYNAME 与 WITHCODE 对返回对象的影响示意图,展示源码字段的边界。

返回结构可以按下面的层次理解。实际客户端会根据 RESP2 或 RESP3 映射成数组、列表或 Map;不要把示意结构里的排版当成固定的字符串输出。

返回结构示意:
[
  {
    "library_name": "billing-core",
    "engine": "LUA",
    "functions": [
      {"name": "invoice_total", "description": "...", "flags": []}
    ],
    "library_code": "#!lua name=billing-core ..."
  }
]

其中 library_code 是库级源码字段,不是某一个函数的单独源码。要审阅一个函数的实现,通常先通过 functions 找到函数名,再在对应库的 library_code 中定位实现。

高压排查时,我会把查询拆成目录和源码两次

在库数量较多的环境里,我更倾向于把“确认部署了什么”和“读取源码做审阅”分开。第一轮只执行不带 WITHCODE 的查询,适合生成轻量目录;确认目标库之后,第二轮才使用精确的 LIBRARYNAME 加 WITHCODE。这种拆分的好处是边界清楚:目录查询关注名字和函数列表,源码查询关注当前库的完整代码。

# 目录阶段:把响应保存给人工或脚本做库名筛选
redis-cli --raw FUNCTION LIST > function-libraries.txt

# 审阅阶段:只读取已确认的库,避免无关源码进入响应
redis-cli --raw FUNCTION LIST LIBRARYNAME "billing-core" WITHCODE > billing-core-with-code.txt

这里的文件只是客户端输出示意,是否落盘、如何脱敏和由谁审阅,要按团队的源码管理规则处理。FUNCTION LIST 本身不负责版本比较、源码持久化、函数调用,也不替代权限和变更审计。

几个容易误判的边界

现象正确理解
只执行 FUNCTION LIST,看不到源码默认返回的是库和函数元数据;需要追加 WITHCODE。
把 WITHCODE 当成加载选项它只影响返回内容,不执行加载、重载或调用。
LIBRARYNAME 后写函数名该参数匹配的是库名模式,不是 functions 数组里的 name。
把 library_code 当成单个函数代码它代表整个 library 的源码,函数列表只是其中的元数据索引。
用过宽模式直接读取所有源码先收窄目标库,减少响应体和后续审阅范围。

结论:记住“筛选”和“取源码”是两个开关

Redis FUNCTION LIST 的使用可以压缩成一句话:先用 LIBRARYNAME 选择库,再按需要加 WITHCODE 取得 library_code。默认结果用于盘点库和函数元数据;带 WITHCODE 的结果才适合做源码审阅。把这两个职责分开,既能让日常目录查询保持轻量,也能避免把函数调用、库加载和源码读取混成一件事。

相关问题

FUNCTION LIST 能查看单个函数的源码吗?

命令返回的是库对象,源码字段是整个 library_code。可以先在 functions 中确认函数名,再到对应库源码中定位。

不写 LIBRARYNAME 会怎样?

会按默认的全量库名模式列出已加载库。需要做源码审阅时,建议先确认目标库,再加上具体模式。

WITHCODE 会不会调用函数?

不会。它只改变 FUNCTION LIST 的返回信息,和函数执行、库加载是不同的操作。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>