Версия:

Модуль json

Модуль json

Общие сведения

Модуль json обеспечивает процедуры работы с форматом JSON. Он основан на модуле Lua-CJSON от Mark Pulford. Полное руководство по Lua-CJSON включено в официальную документацию <http://www.kyne.com.au/~mark/software/lua-cjson-manual.html>`_.

Индекс

Ниже приведен перечень всех функций и элементов модуля json.

Имя Использование
json.encode() Конвертация Lua-объекта в JSON-строку
json.decode() Конвертация JSON-строки в Lua-объект
json.NULL Аналог «nil» в языке Lua
json.cfg() Определение глобальных флагов
json.encode(lua-value[, configuration])

Конвертация Lua-объекта в JSON-строку.

Параметры:
  • lua_value – скалярное значение или значение из Lua-таблицы.
  • configuration – see json.cfg
возвращается:

оригинальное значение, преобразованное в JSON-строку.

тип возвращаемого значения:
 

string (строка)

Пример:

tarantool> json=require('json')
       ---
       ...
       tarantool> json.encode(123)
       ---
       - '123'
       ...
       tarantool> json.encode({123})
       ---
       - '[123]'
       ...
       tarantool> json.encode({123, 234, 345})
       ---
       - '[123,234,345]'
       ...
       tarantool> json.encode({abc = 234, cde = 345})
       ---
       - '{"cde":345,"abc":234}'
       ...
       tarantool> json.encode({hello = {'world'}})
       ---
       - '{"hello":["world"]}'
       ...
json.decode(string[, configuration])

Конвертация JSON-строки в Lua-объект.

Параметры:
  • string (string) – строка в формате JSON.
  • configuration – see json.cfg
возвращается:

оригинальное содержание в формате Lua-таблицы.

тип возвращаемого значения:
 

таблица

Пример:

tarantool> json = require('json')
       ---
       ...
       tarantool> json.decode('123')
       ---
       - 123
       ...
       tarantool> json.decode('[123, "hello"]')
       ---
       - [123, 'hello']
       ...
       tarantool> json.decode('{"hello": "world"}').hello
       ---
       - world
       ...

Чтобы увидеть применение json.decode() в приложении, см. практическое задание Подсчет суммы по JSON-полям во всех кортежах.

json.NULL

Значение, сопоставимое с нулевым значением «nil» в языке Lua, которое можно использовать в качестве объекта-заполнителя в кортеже.

Пример:

-- Когда полю Lua-таблицы присваивается nil, это поле -- null
 tarantool> {nil, 'a', 'b'}
 ---
 - - null
   - a
   - b
 ...
 -- Когда полю Lua-таблицы присваивается json.NULL, это поле --  json.NULL
 tarantool> {json.NULL, 'a', 'b'}
 ---
 - - null
   - a
   - b
 ...
 -- Когда JSON-полю присваивается json.NULL, это поле -- null
 tarantool> json.encode({field2 = json.NULL, field1 = 'a', field3 = 'c'})
 ---
 - '{"field2":null,"field1":"a","field3":"c"}'
 ...

Структуру JSON-вывода можно указать с помощью __serialize:

  • __serialize="seq" для массива
  • __serialize="map" для ассоциативного массива

Сериализация „A“ и“ B“ различными значениями __serialize приводит к различным результатам:

tarantool> json.encode(setmetatable({'A', 'B'}, { __serialize="seq"}))
       ---
       - '["A","B"]'
       ...
       tarantool> json.encode(setmetatable({'A', 'B'}, { __serialize="map"}))
       ---
       - '{"1":"A","2":"B"}'
       ...
       tarantool> json.encode({setmetatable({f1 = 'A', f2 = 'B'}, { __serialize="map"})})
       ---
       - '[{"f2":"B","f1":"A"}]'
       ...
       tarantool> json.encode({setmetatable({f1 = 'A', f2 = 'B'}, { __serialize="seq"})})
       ---
       - '[[]]'
       ...
json.cfg(list of parameter assignments)

Set values affecting behavior of json.encode and json.decode.

The values are all either integers or boolean true/false values.

  • cfg.encode_deep_as_nil (default is false) – see below
  • cfg.encode_invalid_as_nil (default is false) – use null for all unrecognizable types
  • cfg.encode_invalid_numbers (default is true) – allow nan and inf
  • cfg.encode_load_metatables (default is false) – load metatables
  • cfg.encode_max_depth (default is 32) – maximum nesting depth in a structure
  • cfg.encode_number_precision (default is 14) – maximum post-decimal digits
  • cfg.encode_sparse_convert (default is true) – handle excessively sparse arrays as maps
  • cfg.encode_sparse_ratio (default is 2) – how sparse an array can be
  • cfg.encode_sparse_safe (default is 10) – how much can safely be sparse
  • cfg.encode_use_tostring (default is false) – use tostring for unrecognizable types
  • cfg.decode_invalid_numbers (default is true) – allow nan and inf
  • cfg.decode_load_metatables (default is false) – load metatables
  • cfg.decode_max_depth (default is 32) – maximum nesting depth in a structure
  • cfg.decode_save_metatables (default is true) – like encode_load_metatables
  • cfg.decode_sparse_convert (default is true) – like encode_sparse_convert
  • cfg.decode_use_tostring (default is false) – use tostring for unrecognizable types

Например, следующий код интерпретирует 0/0 как nan («не является числом»), а 1/0 – как inf («бесконечность»), вместо того, чтобы вернуть nil или ошибку:

json = require('json')
 json.cfg{encode_invalid_numbers = true}
 x = 0/0
 y = 1/0
 json.encode({1, x, y, 2})

Результат запроса json.encode() будет следующим:

tarantool> json.encode({1, x, y, 2})
 ---
 - '[1,nan,inf,2]
 ...

Чтобы получить такой же эффект для одиночного вызова json.encode() без постоянного изменения конфигурации, можно вызвать json.encode({1, x, y, 2}, {encode_invalid_numbers = true}).

Такие параметры конфигурации применяются для формата JSON, для MsgPack и для YAML.

Примечание

Behavior change: Before Tarantool version 1.10.4, if a nested structure was deeper than cfg.encode_max_depth, the deeper levels were cropped (encoded as nil).

Now, the result is an error suggesting that cfg.encode_max_depth is not deep enough. To return to the old behavior, say cfg.encode_deep_as_nil = true.

This option is ignored for YAML.