module JSON (Ruby 3.1 リファレンスマニュアル)

要約

JSON (JavaScript Object Notation) を扱うためのモジュールです。

特異メソッド

self[object, options] -> object[permalink][rdoc][edit]

文字列のように扱えるデータを受け取った場合は Ruby のオブジェクトに変換して返します。そうでない場合は JSON に変換して返します。

[PARAM] object:: 任意のオブジェクト指定可能です。
[PARAM] options:: JSON.#parse, JSON.#generate の説明を参照してください。

例

require "json"
string=<<JSON
{ "a":1, "b":2, "c":3 }
JSON
hash = { a: 1, b: 2, c: 3 }

JSON[string].class                   # => Hash
JSON[string]                         # => {"a"=>1, "b"=>2, "c"=>3}
JSON[string, symbolize_names: true]  # => {:a=>1, :b=>2, :c=>3}
JSON[hash].class                     # => String
JSON[hash]                           # => "{\"a\":1,\"b\":2,\"c\":3}"

[SEE_ALSO] JSON.#parse, JSON.#generate

create_id -> String[permalink][rdoc][edit]

json_create メソッドで使用するクラスを決定するために使用する値を返します。

デフォルトは "json_class" です。

例

require "json"

class User
  attr :id, :name
  def initialize(id, name)
    @id, @name = id, name
  end

  def self.json_create(object)
    new(object['id'], object["name"])
  end

  def as_json(*)
    {
      JSON.create_id => self.class.name,
      "id" => id,
      "name" => name,
    }
  end

  def to_json(*)
    as_json.to_json
  end
end

json = JSON.generate(User.new(1, "tanaka"))
json # => "{\"json_class\":\"User\",\"id\":1,\"name\":\"tanaka\"}"
JSON.parse(json, create_additions: true)
# => #<User:0x0000557709b269e0 @id=1, @name="tanaka">

create_id=(identifier)[permalink][rdoc][edit]

json_create メソッドで使用するクラスを決定するために使用する値をセットします。

[PARAM] identifier:: 識別子を指定します。

例

require "json"
require "json/add/core"

JSON.create_id                   # => "json_class"
puts (1..5).to_json              # => {"json_class":"Range","a":[1,5,false]}
JSON.create_id = "my_json_class" # => "my_json_class"
JSON.create_id                   # => "my_json_class"
puts (1..5).to_json              # => {"my_json_class":"Range","a":[1,5,false]}

generator -> JSON::Ext::Generator[permalink][rdoc][edit]

JSON ライブラリがジェネレータとして使用するモジュールを返します。

parser -> JSON::Ext::Parser[permalink][rdoc][edit]

JSON ライブラリがパーサとして使用するクラスを返します。

例

require "json"

JSON.parser   # => JSON::Ext::Parser

state -> JSON::Ext::Generator::State[permalink][rdoc][edit]

JSON ライブラリがジェネレータの状態を表すクラスとして使用するクラスを返します。

例

require "json"

JSON.state   # => JSON::Ext::Generator::State

モジュール関数

dump(object, io = nil, limit = nil) -> String | IO[permalink][rdoc][edit]

与えられたオブジェクトを JSON 形式の文字列に変換してダンプします。

与えられたオブジェクトを引数として JSON.#generate を呼び出します。

[PARAM] object:: ダンプするオブジェクトを指定します。
[PARAM] io:: IO のように write メソッドを実装しているオブジェクトを指定します。
[PARAM] limit:: 指定した場合、limit 段以上深くリンクしたオブジェクトをダンプできません。
[EXCEPTION] ArgumentError:: オブジェクトのネストの深さが limit を越えた場合に発生します。

例

require "json"

JSON.dump({ name: "tanaka", age: 19 }) # => "{\"name\":\"tanaka\",\"age\":19}"

例

require "json"

File.open("test.txt", "w") do |f|
  JSON.dump([[[[[[[[[[]]]]]]]]]], f, 10)   # => #<File:test.txt>
  JSON.dump([[[[[[[[[[[]]]]]]]]]]], f, 10) # => exceed depth limit (ArgumentError)
end

[SEE_ALSO] Marshal, Marshal.#dump

fast_generate(object) -> String[permalink][rdoc][edit]

fast_unparse(object) -> String

与えられたオブジェクトを一行の JSON 形式の文字列に変換して返します。

このメソッドは循環参照のチェックを無効にしています。また、 JSON::NaN, JSON::Infinity, JSON::MinusInfinity を生成することがあります。このため容易に無限ループを発生させることができるので、気をつけてください。

fast_unparse は将来削除される予定です。

[PARAM] object:: JSON 形式の文字列に変換するオブジェクトを指定します。

例

require "json"

JSON.fast_generate({ name: "tanaka", age: 19 }) # => "{\"name\":\"tanaka\",\"age\":19}"

generate(object, state = nil) -> String[permalink][rdoc][edit]

unparse(object, state = nil) -> String

与えられたオブジェクトを一行の JSON 形式の文字列に変換して返します。

デフォルトでは、サイズが最小となる JSON 形式の文字列を生成します。また、循環参照のチェックを行います。JSON::NaN, JSON::Infinity, JSON::MinusInfinity を生成することもありません。

unparse は将来削除される予定です。

[PARAM] object:: JSON 形式の文字列に変換するオブジェクトを指定します。
[PARAM] state:: JSON::State または、to_hash や to_h メソッドでハッシュに変換可能なオブジェクトを指定できます。ハッシュを使用する場合指定可能なオプションは以下の通りです。

:indent: インデントに使用する文字列を指定します。デフォルトは空文字列です。
:space: a string that is put after, a : or , delimiter (default: '')
:space_before: a string that is put before a : pair delimiter (default: '')
:object_nl: a string that is put at the end of a JSON object (default: '')
:array_nl: a string that is put at the end of a JSON array (default: '')
:check_circular: 真を指定した場合、生成するオブジェクトの循環をチェックします。この動作がデフォルトです。
:allow_nan: 真を指定した場合、JSON::NaN, JSON::Infinity, JSON::MinusInfinity を生成することを許すようになります。偽を指定した場合、これらの値を生成しようとすると例外が発生します。デフォルトは偽です。
:max_nesting: 入れ子になっているデータの最大の深さを指定します。偽を指定すると深さのチェックを行いません。デフォルトは 19 です。

[EXCEPTION] JSON::GeneratorError:: JSON::NaN, JSON::Infinity,JSON::MinusInfinity を生成しようとした場合に発生します。
[EXCEPTION] JSON::CircularDatastructure:: 与えられたオブジェクトが循環参照を持つ場合に発生します。

例

require "json"

JSON.generate([1, 2, { name: "tanaka", age: 19 }])
# => "[1,2,{\"name\":\"tanaka\",\"age\":19}]"
json_state = JSON::State.new(space: " ")
JSON.generate([1, 2, { name: "tanaka", age: 19 }], json_state)
# => "[1,2,{\"name\": \"tanaka\",\"age\": 19}]"

[SEE_ALSO] JSON::State, JSON.#pretty_generate

load(source, proc = nil, options = {}) -> object[permalink][rdoc][edit]

restore(source, proc = nil, options = {}) -> object

与えられた JSON 形式の文字列を Ruby オブジェクトとしてロードして返します。

proc として手続きオブジェクトが与えられた場合は、読み込んだオブジェクトを引数にその手続きを呼び出します。

require 'json'

str=<<JSON
[1,2,3]
JSON

JSON.load(str) # => [1,2,3]
JSON.load(str, proc{|v| p v }) # => [1,2,3]
# 以下が表示される
# 1
# 2
# 3
# [1,2,3]

str=<<JSON
{ "a":1, "b":2, "c":3 }
JSON

JSON.load(str) # => {"a"=>1, "b"=>2, "c"=>3}
JSON.load(str, proc{|v| p v }) # => {"a"=>1, "b"=>2, "c"=>3}
# 以下が表示される
# "a"
# 1
# "b"
# 2
# "c"
# 3
# {"a"=>1, "b"=>2, "c"=>3}

[PARAM] source:: JSON 形式の文字列を指定します。他には、to_str, to_io, read メソッドを持つオブジェクトも指定可能です。
[PARAM] proc:: Proc オブジェクトを指定します。
[PARAM] options:: オプションをハッシュで指定します。指定可能なオプションは以下の通りです。

:max_nesting: 入れ子になっているデータの最大の深さを指定します。偽を指定すると深さのチェックを行いません。デフォルトは偽です。
:allow_nan: 真を指定した場合、JSON::NaN, JSON::Infinity, JSON::MinusInfinity を生成することを許すようになります。偽を指定した場合、これらの値を生成しようとすると例外が発生します。デフォルトは真です。
:allow_blank: 真を指定すると、sourceがnilの場合にnilを返します。デフォルトは真です。
:create_additions: 偽を指定するとマッチするクラスや JSON.create_id が見つかっても付加情報を生成しません。デフォルトは真です。
:symbolize_names: 真を指定するとハッシュのキーを文字列ではなくシンボルにします。デフォルトは偽です。

load_file(filespec, opts = {}) -> object[permalink][rdoc][edit]

filespec で指定した JSON 形式のファイルを Ruby オブジェクトとしてロードして返します。

[PARAM] filespec:: ファイル名を指定します。
[PARAM] options:: オプションをハッシュで指定します。指定可能なオプションは JSON.#parse と同様です。

[SEE_ALSO] JSON.#parse

load_file!(filespec, opts = {}) -> object[permalink][rdoc][edit]

filespec で指定した JSON 形式のファイルを Ruby オブジェクトとしてロードして返します。

[PARAM] filespec:: ファイル名を指定します。
[PARAM] options:: オプションをハッシュで指定します。指定可能なオプションは JSON.#parse! と同様です。

[SEE_ALSO] JSON.#parse!

parse(source, options = {}) -> object[permalink][rdoc][edit]

与えられた JSON 形式の文字列を Ruby オブジェクトに変換して返します。

[PARAM] source:: JSON 形式の文字列を指定します。
[PARAM] options:: オプションをハッシュで指定します。指定可能なオプションは以下の通りです。

:max_nesting

入れ子になっているデータの最大の深さを指定します。偽を指定すると深さのチェックを行いません。デフォルトは 19 です。

:allow_nan

真を指定すると [RFC4627] を無視してパース時に JSON::NaN, JSON::Infinity, JSON::MinusInfinity を許可するようになります。デフォルトは偽です。

:create_additions

偽を指定するとマッチするクラスや JSON.create_id が見つかっても付加情報を生成しません。デフォルトは偽です。

:symbolize_names

真を指定するとハッシュのキーを文字列ではなくシンボルにします。デフォルトは偽です。

例

require "json"

JSON.parse('[1,2,{"name":"tanaka","age":19}]')
# => [1, 2, {"name"=>"tanaka", "age"=>19}]

JSON.parse('[1,2,{"name":"tanaka","age":19}]', symbolize_names: true)
# => [1, 2, {:name=>"tanaka", :age=>19}]

[SEE_ALSO] JSON::Parser#parse

parse!(source, options = {}) -> object[permalink][rdoc][edit]

与えられた JSON 形式の文字列を Ruby オブジェクトに変換して返します。

JSON.#parse よりも危険なデフォルト値が指定されているので信頼できる文字列のみを入力として使用するようにしてください。

[PARAM] source:: JSON 形式の文字列を指定します。
[PARAM] options:: オプションをハッシュで指定します。指定可能なオプションは以下の通りです。

:max_nesting

入れ子になっているデータの最大の深さを指定します。数値を指定すると深さのチェックを行います。偽を指定すると深さのチェックを行いません。デフォルトは偽です。

:allow_nan

真を指定すると [RFC4627] を無視してパース時に JSON::NaN, JSON::Infinity, JSON::MinusInfinity を許可するようになります。デフォルトは真です。

:create_additions

偽を指定するとマッチするクラスや JSON.create_id が見つかっても付加情報を生成しません。デフォルトは偽です。

例

require "json"

json_text = "[1,2,{\"name\":\"tanaka\",\"age\":19}, NaN]"
JSON.parse!(json_text)
# => [1, 2, {"name"=>"tanaka", "age"=>19}, NaN]

JSON.parse!(json_text, symbolize_names: true)
# => [1, 2, {:name=>"tanaka", :age=>19}, NaN]

JSON.parse(json_text) # => unexpected token at 'NaN]' (JSON::ParserError)

[SEE_ALSO] JSON::Parser#parse

pretty_generate(object, options = nil) -> String[permalink][rdoc][edit]

pretty_unparse(object, options = nil) -> String

Ruby のオブジェクトを JSON 形式の文字列に変換して返します。

このメソッドは JSON.#generate よりも人間に読みやすい文字列を返します。

pretty_unparse は将来削除される予定です。

[PARAM] object:: JSON 形式の文字列に変換するオブジェクトを指定します。
[PARAM] options:: JSON::State または、to_hash や to_h メソッドでハッシュに変換可能なオブジェクトを指定できます。ハッシュを使用する場合指定可能なオプションは JSON.#generate を参照してください。

例

require "json"

hash = { "name": "tanaka", "age": 19 }
puts JSON.generate(hash)
# => {"name":"tanaka","age":19}

puts JSON.pretty_generate(hash)
# => {
#      "name": "tanaka",
#      "age": 19
#    }

puts JSON.pretty_generate(hash, space: "\t")
# => {
#      "name":  "tanaka",
#      "age": 19
#    }

[SEE_ALSO] JSON.#generate

定数

Infinity -> Float[permalink][rdoc][edit]

正の無限大を表します。

[SEE_ALSO] Float

JSON_LOADED -> bool[permalink][rdoc][edit]

JSON ライブラリがロード済みである場合に真を返します。そうでない場合は偽を返します。

MinusInfinity -> Float[permalink][rdoc][edit]

負の無限大を表します。

[SEE_ALSO] Float

NaN -> Float[permalink][rdoc][edit]

NaN (Not a Number) を表します。

[SEE_ALSO] Float

VARIANT_BINARY -> bool[permalink][rdoc][edit]

拡張ライブラリ版を使用している場合に真を返します。そうでない場合は偽を返します。

VERSION -> String[permalink][rdoc][edit]

このライブラリのバージョンを表す文字列です。

要約

目次

特異メソッド

モジュール関数

定数