コンテンツにスキップ

JSONエンコーディング

LuaテーブルをJSONにエンコードし、JSON文字列をLua値にデコード。データ検証とAPIコントラクト強制のためのJSON Schema検証を含む。

local json = require("json")

Lua値をJSON文字列にエンコード。

-- シンプルな値
json.encode("hello") -- '"hello"'
json.encode(42) -- '42'
json.encode(true) -- 'true'
json.encode(nil) -- 'null'
-- 配列(連続した数値キー)
json.encode({1, 2, 3}) -- '[1,2,3]'
json.encode({"a", "b"}) -- '["a","b"]'
-- オブジェクト(文字列キー)
local user = {name = "Alice", age = 30}
json.encode(user) -- '{"name":"Alice","age":30}'
-- ネストした構造
local order = {
id = "ord-123",
items = {
{sku = "ABC", qty = 2},
{sku = "XYZ", qty = 1}
},
total = 99.50
}
json.encode(order)
-- '{"id":"ord-123","items":[{"sku":"ABC","qty":2},{"sku":"XYZ","qty":1}],"total":99.5}'
パラメータ説明
valueanyエンコードするLua値

戻り値: string, error

エンコーディング規則:

  • nilnullになる
  • 空のテーブルは[]になる(文字列キーで作成された場合は{}
  • 1から始まる連続キーを持つテーブルは配列になる
  • 文字列キーを持つテーブルはオブジェクトになる
  • 数値と文字列キーの混在はエラー
  • 疎な配列(インデックスにギャップ)はエラー
  • Inf/NaN数値はnullになる
  • 再帰的なテーブル参照はエラー
  • 最大ネスト深度は128レベル

JSON文字列をLua値にデコード。

-- オブジェクトをパース
local user, err = json.decode('{"name":"Bob","active":true}')
if err then
return nil, err
end
print(user.name) -- "Bob"
print(user.active) -- true
-- 配列をパース
local items = json.decode('[10, 20, 30]')
print(items[1]) -- 10
print(#items) -- 3
-- ネストしたデータをパース
local response = json.decode([[
{
"status": "ok",
"data": {
"users": [
{"id": 1, "name": "Alice"},
{"id": 2, "name": "Bob"}
]
}
}
]])
print(response.data.users[1].name) -- "Alice"
-- エラーを処理
local data, err = json.decode("not valid json")
if err then
print(err:kind()) -- "INTERNAL"
print(err:message()) -- パースエラーの詳細
end
パラメータ説明
strstringデコードするJSON文字列

戻り値: any, error

Lua値をJSON Schemaに対して検証。APIコントラクトの強制やユーザー入力の検証に使用。

-- スキーマを定義
local user_schema = {
type = "object",
properties = {
name = {type = "string", minLength = 1},
email = {type = "string", format = "email"},
age = {type = "integer", minimum = 0, maximum = 150}
},
required = {"name", "email"}
}
-- 有効なデータはパスする
local valid, err = json.validate(user_schema, {
name = "Alice",
email = "alice@example.com",
age = 30
})
print(valid) -- true
-- 無効なデータは詳細とともに失敗
local valid, err = json.validate(user_schema, {
name = "",
email = "not-an-email"
})
if not valid then
print(err:message()) -- 検証エラーの詳細
end
-- スキーマはJSON文字列でも可
local schema_json = '{"type":"number","minimum":0}'
local valid = json.validate(schema_json, 42)
パラメータ説明
schematable or stringJSON Schema定義
dataany検証する値

戻り値: boolean, error

スキーマはパフォーマンスのためにコンテンツハッシュでキャッシュされる。

パース前にスキーマに対してJSON文字列を検証。パース前に検証が必要な場合に便利。

local schema = {
type = "object",
properties = {
action = {type = "string", enum = {"create", "update", "delete"}}
},
required = {"action"}
}
-- リクエストボディからの生のJSONを検証
local body = '{"action":"create","data":{}}'
local valid, err = json.validate_string(schema, body)
if not valid then
return nil, errors.new("INVALID", "Invalid request: " .. err:message())
end
-- これで安全にデコードできる
local request = json.decode(body)
パラメータ説明
schematable or stringJSON Schema定義
json_strstring検証するJSON文字列

戻り値: boolean, error

条件種別再試行可能
再帰的なテーブル参照errors.INTERNALno
疎な配列(インデックスにギャップ)errors.INTERNALno
テーブル内のキー型混在errors.INTERNALno
ネストが128レベルを超過errors.INTERNALno
無効なJSON構文errors.INTERNALno
スキーマコンパイル失敗errors.INVALIDno
検証失敗errors.INVALIDno

エラーの処理についてはエラー処理を参照。