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

Redis Lua cjson.decode 解析 JSON 字符串的字段读取与错误处理

来源:17golang原创

时间:2026-11-17 21:46:25 267浏览 收藏

Redis Lua 脚本收到的 ARGV 本质上是字符串。要从中读取 JSON 字段,不能直接写 ARGV[1].user_id,而应先调用 cjson.decode。更稳妥的做法是把解码放进 pcall,再检查字段是否存在和类型是否符合约定,最后用 cjson.encode 返回一个结构稳定的 JSON 字符串。

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

要点速览
  • ARGV[1] 是原始 JSON 文本,cjson.decode 才会把它转换成 Lua 值。
  • 非法 JSON 要单独捕获;合法 JSON 但缺字段,则属于业务输入错误。
  • 返回单个 JSON 字符串时,客户端更容易统一判断 ok、code 和 message。

先固定 ARGV 里的 JSON 输入契约

下面的例子约定第一个参数是对象,必须包含数字类型的 user_id,可选布尔字段 enabled。这个边界很重要:Redis Lua 可以解码 JSON,但不会替业务自动补齐字段,也不会替你判断数字字符串是否符合接口契约。

redis-cli EVAL "local input = cjson.decode(ARGV[1]); return input.user_id" 0 '{"user_id":42,"enabled":true}'

实际项目中建议把成功结果也编码成 JSON,而不是依赖客户端猜测整数、字符串或数组的含义。

Redis Lua cjson.decode 将 ARGV JSON 对象映射为 user_id 和 enabled 字段的结构说明图
图1:Redis Lua 输入契约说明图,展示 ARGV 原始字符串、cjson.decode 和字段对象之间的关系。

用 cjson.decode 解码,再读取字段

cjson.decode 的返回值可能是对象、数组、字符串、数字或布尔值。只有解码结果确实是对象时,才适合按字段名读取。下面的脚本先判断解码是否成功,再检查 user_id 和 enabled 的类型,最后返回一段 JSON。

local ok, payload = pcall(cjson.decode, ARGV[1])
if not ok then
  -- 非法 JSON 不让脚本直接中断,统一返回输入错误
  return cjson.encode({ok = false, code = "invalid_json"})
end

if type(payload) ~= "table" then
  -- 顶层必须是对象或数组;本例只接受对象语义
  return cjson.encode({ok = false, code = "object_required"})
end

if payload.user_id == nil or type(payload.user_id) ~= "number" then
  -- 缺字段和类型不符都归到业务输入错误
  return cjson.encode({ok = false, code = "user_id_required"})
end

local enabled = payload.enabled
if enabled == nil then
  -- 可选字段使用明确默认值,避免客户端处理缺省状态
  enabled = false
end

if type(enabled) ~= "boolean" then
  -- 不把字符串 "true" 静默当作布尔值
  return cjson.encode({ok = false, code = "enabled_must_be_boolean"})
end

-- 成功时返回一个 JSON 字符串,字段名由脚本固定
return cjson.encode({ok = true, user_id = payload.user_id, enabled = enabled})

把三类错误分开,排查会更快

这里至少要区分三种情况:JSON 语法错误、顶层结构不符合约定、字段缺失或类型错误。它们的修复位置不同,混成一个 bad_request 会让调用方只能反复试参数。

现象判断位置处理建议
pcall 返回 falsecjson.decode 失败检查引号、逗号和 JSON 是否被重复编码
解码成功但不是对象type(payload)拒绝数字、字符串等不符合接口的顶层值
对象缺少目标字段payload.user_id == nil补齐字段或返回明确业务错误码

尤其要注意:合法 JSON 不等于合法业务输入。{"user_id":"42"} 可以被成功解析,但它的字段类型仍然是字符串;是否允许转换,应由接口契约决定,不要在脚本里悄悄改变语义。

Redis Lua cjson.decode 的非法 JSON、顶层类型和字段类型错误边界结构说明图
图2:错误边界说明图,区分语法错误、顶层类型错误和字段契约错误。

返回格式和边界检查清单

  • 输入来自 ARGV 时,先确认它是不是 JSON 文本,不要直接按对象访问。
  • 需要容错时用 pcall(cjson.decode, value),并保留可读错误码。
  • 字段读取前检查 nil 和 type,不要把缺省值与空字符串混为一谈。
  • 脚本返回一个由 cjson.encode 生成的 JSON 字符串,客户端只依赖固定字段。
  • 只读输入校验不应顺手修改 Redis 键;写入操作需要另行设计幂等性和回滚边界。

相关问题

Redis Lua 能直接读取 ARGV 里的 JSON 字段吗?

不能直接按字段读取。ARGV 是字符串,必须先用 cjson.decode 转成 Lua 值。

合法 JSON 为什么仍然会被脚本拒绝?

因为语法合法只代表能解码,字段缺失、顶层类型不对或字段类型不符仍然可能违反业务契约。

为什么不直接返回多个 Lua 值?

统一编码成一个 JSON 字符串可以固定字段名和错误码,客户端不必根据 RESP 返回形态猜测结果含义。

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