Redis Lua cjson.encode 怎样把表转换成 JSON 字符串

在 Redis Lua 脚本里，想把一张 Lua 表交给客户端或继续作为字符串处理，直接调用 cjson.encode(table) 即可。它返回的是 JSON 编码后的字符串：具名字段通常表达为 JSON 对象，连续的整数下标表达为 JSON 数组。先记住这一点，很多“结果不像 JSON”的问题其实来自 Lua 表本身的键结构，而不是 cjson.encode 没有生效。

官方地址：https://redis.io/docs/latest/develop/programmability/lua-api/

先用最小对象验证 cjson.encode 的返回值

Redis 官方 Lua API 把 cjson 作为运行时库提供，cjson.encode(x) 的职责很单一：把传入的 Lua 值编码为 JSON 字符串。先从一个没有嵌套、没有空值的对象开始，便于把问题范围锁定在编码这一步。

-- 用具名字段构造 Lua 表，观察对象编码结果
local payload = {
  name = "redis",
  count = 2
}

-- 返回 JSON 字符串，而不是把 Lua 表原样返回
return cjson.encode(payload)

这个脚本的逻辑是“Lua table → cjson.encode → JSON string”。返回内容应表达为 {"name":"redis","count":2}。使用 redis-cli EVAL 时，终端可能把字符串中的双引号显示成转义形式；这不代表 JSON 里多了一层反斜杠。若后续客户端拿到的是字符串，再由客户端按 JSON 规则解析即可。

数组和对象要从表结构上分开

同一个花括号在 Lua 里既能构造数组式表，也能构造键值对象。区分它们的关键不是变量名，而是键：数组使用从 1 开始的连续整数下标；对象使用描述字段的字符串键。

-- 连续整数键会表达为 JSON 数组
local tags = { "redis", "lua", "json" }
local tagsJSON = cjson.encode(tags)

-- 字符串键会表达为 JSON 对象
local profile = {
  name = "redis",
  enabled = true
}
local profileJSON = cjson.encode(profile)

-- 交给调用方的两个值都是 JSON 字符串
return { tagsJSON, profileJSON }

可以把结果先按下面的结构核对：

看到异常结果时，先排查键和空值

如果输出不是预期的数组或对象，不要先给 cjson.encode 加额外字符串拼接。先回到输入表检查三件事：是否从 1 开始、整数键是否连续、是否同时放入了字段键和下标键。

• 要表达列表，按顺序写入 table[1]、table[2] 等连续位置。
• 要表达对象，统一使用稳定的字符串字段名，不要依赖数字下标猜字段含义。
• 表中有 nil 空洞或混合键时，先整理成明确的数组或对象，再调用编码。

尤其不要把“Lua 表返回到 Redis 协议”和“Lua 表编码成 JSON”混为一谈。本文讨论的是显式调用 cjson.encode 得到字符串；脚本最后直接 return payload 时，Redis 还会按照脚本返回值的协议转换规则处理它，结果路径不同。

把 JSON 字符串交给后续逻辑

编码完成后，变量已经是字符串，可以作为脚本返回值，也可以传给后续只接受字符串的逻辑。更稳妥的写法是让“构造表”和“编码表”分成两个局部变量，出问题时很容易打印或单独替换输入。

-- 先构造完整对象，再一次性编码，避免边拼 JSON 边转义
local result = {
  ok = true,
  items = { "a", "b" }
}

local encoded = cjson.encode(result)
-- encoded 是 JSON 字符串；不要再次手写外层引号
return encoded

如果客户端收到的内容看起来像 {"ok":true,"items":["a","b"]}，说明对象、数组和布尔值已经由编码器分别落到了 JSON 对应类型。不要为了“看起来像 JSON”再手动删除反斜杠或重复包一层引号，那往往会把有效字符串变成双重编码。

常见问题

cjson.encode 返回的是 Lua 表还是 JSON 字符串？

返回 JSON 编码后的字符串。它不是可继续用点号访问的 Lua 表；需要回到 Lua 结构时，应使用对应的解码流程。

数组为什么没有字段名？

因为数组的语义来自连续整数下标。若每个元素都需要名字，应改用字符串键构造对象，而不是给数组元素额外拼接字段文本。

为什么终端里多出反斜杠？

常见原因是命令行对字符串中的双引号做了展示转义。先看客户端拿到的原始字符串，再判断是否真的发生了二次编码。

实际使用时，先把 Lua 表设计成明确的数组或对象，再让 cjson.encode 做一次编码，排查范围会比手写 JSON 字符串小得多。