Kong插件开发:Post-function无法引入cjson处理复杂JSON响应
问题描述
我正在尝试编写自定义逻辑转换API响应体,原本打算用Response Transformer插件,但响应体JSON结构复杂,需要移除部分字段,所以改用Post-function插件编写自定义Lua代码。但代码无法引入cjson库,导致无法解码响应体并操作指定键。
我的body_filter阶段Lua代码如下:
local cjson = require(“cjson”) local body = cjson.decode(kong.response.get_raw_body()) -- 设置自定义键的值为1 body.subKeyFoo.subSubKey = 1;
执行后报错:
require cjson not allowed within sandbox “kong”
解决方法
Kong的Post-function插件运行在沙箱环境中,默认限制了对cjson这类第三方库的直接引入,可通过以下两种方式解决:
方式一:使用Kong内置JSON工具
Kong自带了JSON处理方法,无需手动引入cjson,直接用kong.json.decode()解析响应体即可:
local body = kong.json.decode(kong.response.get_raw_body()) -- 修改指定字段值 body.subKeyFoo.subSubKey = 1 -- 将修改后的响应体重新设置回去 kong.response.set_raw_body(kong.json.encode(body))
方式二:修改Kong沙箱配置(不推荐生产环境)
如果必须使用cjson库,可修改kong.conf配置文件,在lua_allowed_libs参数中添加cjson:
lua_allowed_libs = resty.core, resty.core.base64, resty.core.hash, resty.core.regex, resty.core.string, resty.core.table, cjson
修改后重启Kong服务,就能在Post-function的Lua代码中正常引入cjson。但此方式会扩大沙箱权限,存在安全风险,生产环境谨慎使用。
额外注意事项
- 修改响应体后,必须调用
kong.response.set_raw_body()将修改后的内容重新设置,否则修改不会生效; - 若响应体采用分块传输,
body_filter会被多次触发,需要编写逻辑拼接完整响应体,避免仅处理部分内容。
内容的提问来源于stack exchange,提问作者Aditya Sahu
相关产品推荐
相关产品推荐

