21、nodeMCU学习笔记--sjson模块

闲言碎语

nodemcu的固件又有更新了(5月份)。新固件新增了一个传感器模块。同时,使用sjson取代先前的cjson模块。

新模块提供老模块原有的功能,同时还增加了高级功能。

使用上,依然要注意多层嵌套的table在转换成json的过程中可能会导致内存溢出,建议使用pcall()。

模块函数

序号 函数名 参数 返回值
1 sjson.decode() str[, opts] table
2 sjson.encode() table [, opts] str
3 sjson.encoder() table [, opts] obj
4 sjson.encoder:read [size] str / null
5 sjson.decoder() [opts] obj
6 sjson.decoder:write string obj / null
7 sjson.decoder:result table / 异常

开头2个函数的用法和老模块类似,前者将json格式的字符串转换成table数据类型,后者则是把table数据类型转换成json格式字符串。区别在于增加了一个可选参数,具体参数看文档。

.encoder()同样是将table类型转换成json,只不过不是直接返回字符串,而是一个对象。要得到字符串需要用.encoder:read(),函数参数可以指定读取字符串长度,默认是1024字节。

.encoder()对应的是.decoder(),用来将json字符串转换成table类型,函数返回的也是个对象。需要使用.encoder:write()来往对象写入字符串。最后,还需要使用.encoder:result()来判断是否将json转换成table。如果转换为完成则返回对象;否则,直接抛错误,确保json字符串write成功在调用该函数

实践一下

先来看关于sjson.encode & sjson.decode的简单使用例子,这里先将table转成json;然后在把json转成table。

ledtable = {}
ledtable.ledR=100
ledtable.ledB=50
ledtable.ledG=150

-- table --> json
ok, json = pcall(sjson.encode, ledtable)
if ok then
  print(json)
else
  print("failed to encode!")
end
-- json --> table
if ok then
  t = sjson.decode(json)
  for k, v in pairs(t) do 
    print(k, v)
  end
end

再来看看后面几个函数怎么用。先看一个简单的例子,还是先前那个table,然后使用不同的函数来做转码。例子中创建一个encoder的obj和一个decoder的obj2,将table换成json。然后obj多次read,并write进obj2。最后通过result得到新的table。

ledtable = {}
ledtable.ledR=100
ledtable.ledB=50
ledtable.ledG=160

obj = sjson.encoder(ledtable)
--print(obj:read())
--print(obj:read())
obj2 = sjson.decoder()

while true do
    data = obj:read(10)
    if not data then
        print(type(obj2:result()))
        for k, v in pairs(obj2:result()) do
            print(k, v)
        end
        break
    end
    obj2:write(data)
--    obj2:result()
end

这里有几个地方需要注意的,read函数会移除obj里面的json字符串。你可以试着去掉开头的两行注释。你会发现第二行print的内容为空。

在json转换成table还没完成时,调用result函数,程序会直接抛异常。可以试着去掉第三行的注释。

当转换完成后,result函数可以多次调用,返回的都是同一个table。

decoder()函数是可以传入参数的,其中一个是metatable(元表)。这玩意理解起来比较困难,特别是像我这种不熟悉lua的,特别费劲。

那这东西有什么神奇之处吗?结合一个简单的例子来看一下。

mt = {}
mt.__newindex = function(table, key, value)
    print('table--' .. tostring(table))
    print('key--' .. key)
    print('value--'.. tostring(value))
    rawset(table, key, value)
end

t = {metatable = mt}

decoder = sjson.decoder(t)
decoder:write('{"led1": true, "led2": false, "led3": false}')

for k, v in pairs(decoder:result()) do
    print(k, v)
end

这个例子中,mt是t的元表。而__newindex则是一个元方法,如果此元方法是个函数,那么当往t里面写入一个不存在的值的时候,会调用这个方法。这个方法接受三个参数,包括tablekeyvalue。其中的table是result()返回的那个table。

rawset(table, key, value)用来往table里面做赋值操作。利用这个特性,我们可以在这个方法中实现一个效果。比如我们在转换来自网络上的一个json数据时,我们这感兴趣里面的某几个K-V,那我们就可以借助这个来提取想要的K-V了。

关于这个模块怎么用的就先说到这个,后面如果有新玩法再更新。

  • 更多应用看这里
    1.做个迷你气象站·一

如果文章对你有帮助,点个赞哩!

评论不能贴图, 如有需要可以到我的GitHub上提issues

你可能感兴趣的:(21、nodeMCU学习笔记--sjson模块)