lua模块之cjson模块-json解析

lua json的解析和编译

参考

• lua-cjson-manual
• lua-cjson

摘要(Synopsis)

local cjson = require "cjson"
-- Module instantiation
-- 实例化模块
local cjson2 = cjson.new()
local cjson_safe = require "cjson.safe"

-- Translate Lua value to/from JSON
text = cjson.encode(value)
value = cjson.decode(text)

-- Get and/or set Lua CJSON configuration
setting = cjson.decode_invalid_numbers([setting])
setting = cjson.encode_invalid_numbers([setting])
keep = cjson.encode_keep_buffer([keep])
depth = cjson.encode_max_depth([depth])
depth = cjson.decode_max_depth([depth])
convert, ratio, safe = cjson.encode_sparse_array([convert[, ratio[, safe]]])

模块实例化(Module Instantiation)

local cjson = require "cjson"
local cjson2 = cjson.new()
local cjson_safe = require "cjson.safe"

• cjson解码/编码的时候遇到非法数据会抛出错误
• cjson_safe和cjson一样,但是遇到非法数据时,不会抛错误,而是返回nil和error.
• cjson.new()会创建一个实例,拥有自己独立的编码缓冲区和默认设置.

解析json字符串(decode)

value = cjson.decode(json_text)

• UTF-16和UTF-32不支持

json_text = '[ true, { "foo": "bar" } ]'
value = cjson.decode(json_text)
-- Returns: { true, { foo = "bar" } }

解码不可用的数字(decode_invalid_numbers)

setting = cjson.decode_invalid_numbers([setting])
-- "setting" must be a boolean. Default: true.

• 尝试解析不被json规范支持的数字时,会报错,比如:
  
  • infinity
  • not-a-number(NaN)
  • hexadecimal
• 可用的设置:
  
  • true: 会解析不可用的数字,默认设置
  • false: 当遇到不可用的数字会抛错误

这个方法调用后会返回当前的设置值.

local in = cjson.decode_invalid_numbers(false)
--in is false

json字符串最大解析深度(decode_max_depth)

depth = cjson.decode_max_depth([depth])
-- "depth" must be a positive integer. Default: 1000.

• 设置json字符串最大内嵌深度,当超过这个深度,会抛出错误,防止栈溢出
• 默认深度为1000.

编码(encode)

json_text = cjson.encode(value)

• 支持如下类型转化为json串:
  
  • boolean
  • nil
  • number
  • string
  • table
  • lightuserdata(null value only)
• 剩下的会报错:
  
  • function
  • lightuserdata(not null value)
  • thread
  • userdata
• 默认数字保留十四位精度
• 遇到下面的字符串会被转义:
  
  • 控制字符
  • 双引号
  • 斜杠和反斜杠
  • 删除符号
• 遇到下面的情况会报错:
  
  • 不符合json规范的数字(infinity,NaN)
  • 表嵌套超过1000层
  • 过度稀疏lua数组

value = { true, { foo = "bar" } }
json_text = cjson.encode(value)
-- Returns: '[true,{"foo":"bar"}]'

编码设置

1. encode_invalid_numbers
   
   • true : 允许编码不可用的值.
   • null : 生成为空值
   • false : 报错
2. encode_keep_buffer
   
   • true : 缓存编码内容
   • false : 不缓存
3. encode_max_depth
   
   • depth: 数字,编码最大嵌套深度,默认1000
4. encode_number_precision
   
   • 数字编码精度: 1-14,默认14
5. encode_sparse_array
   
cjson.encode({ [3] = "data" })
-- Returns: '[null,null,"data"]'


cjson.encode_sparse_array(true)
cjson.encode({ [1000] = "excessively sparse" })
-- Returns: '{"1000":"excessively sparse"}'


变量

null

解析json字符串的null值,会被解析为cjson.null.判断时if value == cjson.null then ... end,

lua_cjson模块中可用方法和变量

• cjson.encode_empty_table_as_object(true|false|"on"|"off")
  默认为true,空的lua 表会被编码为空的json对象{},如果设为false,那么会被编码为json数组[]
• cjson.empty_array
  一个lightuserdata,类似cjson.null,这个值将会被编码为空的json数组[]

local cjson = require "cjson"

local json = cjson.encode({
    foo = "bar",
    some_object = {},
    some_array = cjson.empty_array
})

将会生成json串:

{
    "foo": "bar",
    "some_object": {},
    "some_array": []
}

• setmetatable({}, cjson.array_mt)
  表会被生成json的数组

local t = { "hello", "world" }
setmetatable(t, cjson.array_mt)
cjson.encode(t) -- ["hello","world"]

生成:

local t = {}
t[1] = "one"
t[2] = "two"
t[4] = "three"
t.foo = "bar"
setmetatable(t, cjson.array_mt)
cjson.encode(t) -- ["one","two",null,"three"]

• setmetatable({}, cjson.empty_array_mt)
  用于标识一个表,如果一个表是空的,会生成一个json数组(不然会被忽略),下面两种情况相同:

local function serialize(arr)
    if #arr < 1 then
        arr = cjson.empty_array
    end

    return cjson.encode({some_array = arr})
end

和上面相同:

local function serialize(arr)
    setmetatable(arr, cjson.empty_array_mt)

    return cjson.encode({some_array = arr})
end

最终结果都是:

{
    "some_array": []
}

• encode_number_precision
  修改了cjson默认1-14位,这里可以为1-16位.