読み込み中...

RubyでJSONを扱う10の鉄則

RubyとJSONの基本的な使い方と応用例を紹介 Ruby
2023.06.27
この記事は約10分で読めます。

【サイト内のコードはご自由に個人利用・商用利用いただけます】

この記事では、プログラムの基礎知識を前提に話を進めています。

説明のためのコードや、サンプルコードもありますので、もちろん初心者でも理解できるように表現してあります。

本記事のサンプルコードを活用して機能追加、目的を達成できるように作ってありますので、是非ご活用ください。

※この記事は、一般的にプロフェッショナルの指標とされる『実務経験10,000時間以上』を満たす現役のプログラマチームによって監修されています。

※Japanシーモアは、常に解説内容のわかりやすさや記事の品質に注力しております。不具合、分かりにくい説明や不適切な表現、動かないコードなど気になることがございましたら、記事の品質向上の為にお問い合わせフォームにてご共有いただけますと幸いです。
(送信された情報は、プライバシーポリシーのもと、厳正に取扱い、処分させていただきます。)

はじめに

この記事では、プログラミング言語Rubyを用いてJSONを扱う方法について、具体的な10の手法を通じて解説します。

Ruby初心者でも理解しやすいよう、基本的な説明から始め、さまざまな応用例まで詳しく見ていきます。

この記事を読めば、RubyでJSONデータを扱えるようになります。

●RubyとJSONの基礎知識

Rubyは、その柔軟性と表現力に富んだ文法から、多くの開発者に愛されています。

その一方で、JSON（JavaScript Object Notation）は、データ交換のための軽量なデータ形式で、人間にとって読み書きが容易で、マシンにとっても簡単にパースや生成を行うことができます。

RubyとJSONを組み合わせることで、データの受け渡しや管理を効率的に行うことが可能となります。

●JSONデータの読み込みと解析

RubyでJSONデータを扱うための基本的な手順は、まずデータの読み込みと解析です。

JSONデータは、文字列またはファイルとして提供されることが多いです。

○RubyでのJSONデータの読み込み方法

Rubyには、標準ライブラリに含まれるjsonというモジュールがあり、これを使うことでJSONデータの読み込みと解析を行うことができます。

具体的には、JSON.parseメソッドを用います。

○サンプルコード1：ファイルからJSONデータを読み込む

下記のコードは、data.jsonという名前のファイルからJSONデータを読み込む例です。

この例では、File.readメソッドを使ってファイルの内容を文字列として読み込み、その後でJSON.parseメソッドを使ってJSONデータを解析しています。

require 'json'

file_content = File.read('data.json')
data = JSON.parse(file_content)

puts data

上記のコードを実行すると、data.jsonの内容がRubyのハッシュとして出力されます。

たとえば、data.jsonの内容が{"name": "Alice", "age": 30}だった場合、出力結果は{"name"=>"Alice", "age"=>30}となります。

○サンプルコード2：文字列からJSONデータを解析する

次に、文字列からJSONデータを解析する例を見てみましょう。

ここでもJSON.parseメソッドを使用します。

ruby
require 'json'

json_str = '{"name": "Bob", "age": 25}'
data = JSON.parse(json_str)

puts data

上記のコードを実行すると、json_strに設定されたJSON形式の文字列がRubyのハッシュとして出力されます。

この場合の出力結果は{"name"=>"Bob", "age"=>25}となります。

●JSONデータの生成と書き出し

次に、RubyでJSONデータを生成し、それを書き出す方法を見ていきましょう。

ここでもjsonモジュールが活躍します。

Rubyのデータ構造をJSON形式の文字列に変換するには、JSON.generateまたはJSON.dumpメソッドを使います。

さらに、生成したJSONデータをファイルに書き出す方法も説明します。

○RubyでのJSONデータの生成方法

Rubyのデータ構造、例えばハッシュをJSON形式の文字列に変換するには、JSON.generateメソッドを使用します。

このメソッドはハッシュを引数に取り、それをJSON形式の文字列に変換します。

○サンプルコード3：ハッシュからJSONデータを生成する

下記のコードでは、RubyのハッシュをJSON形式の文字列に変換しています。

この例では、ハッシュdataをJSON.generateメソッドに渡して、JSON形式の文字列を生成しています。

require 'json'

data = {
  'name' => 'Charlie',
  'age' => 35
}

json_str = JSON.generate(data)

puts json_str

このコードを実行すると、ハッシュdataがJSON形式の文字列{"name":"Charlie","age":35}に変換されて出力されます。

○サンプルコード4：JSONデータをファイルに書き出す

生成したJSONデータをファイルに書き出すには、File.writeメソッドを使用します。

このメソッドは第一引数にファイル名、第二引数に書き出す内容を取ります。

下記のコードでは、data.jsonという名前のファイルにJSONデータを書き出しています。

require 'json'

data = {
  'name' => 'Dave',
  'age' => 40
}

json_str = JSON.generate(data)

File.write('data.json', json_str)

このコードを実行すると、data.jsonという名前のファイルが作成され、その中に{"name":"Dave","age":40}というJSONデータが書き出されます。

●JSONの応用例

JSONデータは多くのプログラミング言語で扱うことができるため、異なるプログラミング言語間でデータを交換する手段としてよく使用されます。

また、設定ファイルのように、プログラムで読み込んで使用するデータを保存するためにも利用されます。

○サンプルコード5：JSONデータを使ったデータ交換

下記のコードでは、Rubyで生成したJSONデータをPythonプログラムに送り、Pythonでそのデータを読み込むという例を示しています。

この例では、jsonモジュールを使ってRubyのハッシュをJSON形式に変換し、それをPythonに渡しています。

# Ruby側
require 'json'
data = {
  'name' => 'Alice',
  'age' => 25
}
json_str = JSON.generate(data)
# json_strをPythonプログラムに渡す処理...
# Python側
import json
# Rubyから受け取ったjson_strを変数に格納
json_str = ...
data = json.loads(json_str)
print(data['name'])  # Alice

このコードを実行すると、Rubyから生成したJSONデータがPythonに渡され、Python側でそのデータが読み込まれて利用されます。

○サンプルコード6：JSONデータを使った設定ファイルの管理

次に、設定ファイルとしてJSONデータを使う例を見てみましょう。

設定ファイルは、プログラムが動作するための設定情報を記述したファイルで、JSON形式で書かれた設定ファイルは様々な言語のプログラムから簡単に読み込むことができます。

下記のコードでは、config.jsonという設定ファイルを読み込んで、その内容をRubyのプログラムで利用しています。

require 'json'

config = JSON.parse(File.read('config.json'))

puts config['database']['user']

このコードを実行すると、config.jsonから設定情報を読み込んで、その情報をプログラムで利用しています。

例えば、config.jsonが以下の内容だった場合、

{
  "database": {
    "user": "admin",
    "password": "password"
  }
}

config['database']['user']の結果は"admin"となります。

●JSONライブラリのカスタマイズ

JSONを効果的に扱うためには、基本的な操作だけでなく、ライブラリのカスタマイズも重要なテクニックとなります。

オブジェクト変換のカスタマイズとpretty_generateメソッドの使用例について見ていきましょう。

○サンプルコード9：オブジェクト変換のカスタマイズ

JSONライブラリを使ってRubyのオブジェクトをJSON形式に変換するとき、オブジェクト内の特定のプロパティだけをJSONデータに含めたい場合があります。

このようなカスタマイズは、to_jsonメソッドをオーバーライドすることで実現できます。

下記のコードでは、ユーザークラスのオブジェクトをJSON形式に変換する際に、パスワードは含めず、名前と年齢だけをJSONデータに含めるようにカスタマイズしています。

require 'json'

class User
  attr_accessor :name, :age, :password

  def initialize(name, age, password)
    @name = name
    @age = age
    @password = password
  end

  def to_json(*)
    { 'name' => @name, 'age' => @age }.to_json
  end
end

user = User.new('Alice', 20, 'secret')
json_str = user.to_json  # => {"name":"Alice","age":20}

このコードを実行すると、パスワードは含まれず、{"name":"Alice","age":20}というJSONデータが生成されます。

○サンプルコード10：pretty_generateメソッドの使用例

JSONライブラリには、人間が読みやすい形式のJSONデータを生成するpretty_generateメソッドがあります。

このメソッドを使うと、インデントや改行が自動的に挿入され、見やすいJSONデータを出力できます。

下記のコードでは、ハッシュをpretty_generateメソッドを使ってJSON形式に変換しています。

require 'json'

data = {
  'name' => 'Alice',
  'age' => 20,
  'friends' => ['Bob', 'Charlie']
}

json_str = JSON.pretty_generate(data)
puts json_str

このコードを実行すると、次のような整形されたJSONデータが出力されます。

{
  "name": "Alice",
  "age": 20,
  "friends": [
    "Bob",
    "Charlie"
  ]
}

これにより、大量のデータを扱う際でも、データの構造を把握しやすくなります。

●注意点と対処法

RubyでJSONを扱う上での注意点とそれに対する対処法についていくつかご紹介します。

①文字コード問題

JSONデータは基本的にUTF-8でエンコードされています。

しかし、それ以外の文字コードで書かれたJSONを読み込もうとした場合、エラーが発生する可能性があります。

この問題に対処するには、ファイルを読み込む前に適切な文字コードに変換するか、あらかじめUTF-8でJSONを保存しておくことが重要です。

②配列やハッシュの扱い

JSONオブジェクトはRubyではハッシュとして、JSON配列はRubyの配列として扱われます。

これらのデータ構造を理解し、適切に操作することが重要です。

具体的には、ハッシュのキーは文字列として扱われること、また配列は順序を保持するなどの特性を理解しましょう。

③nilの扱い

JSONのnullはRubyでのnilに変換されます。

しかし、Rubyのnilはfalseと等価なため、条件分岐で混乱を招くことがあります。

nullを含むJSONデータを扱う際は、この点に注意が必要です。

④数値の精度

JSONで扱える数値の範囲や精度はJavaScriptのNumber型に依存しますが、Rubyでの数値型はそれよりも広範囲の値を扱えます。

大きな整数や高精度の浮動小数点数をJSONで扱う場合は、数値が正確に保持されるか確認することが重要です。

まとめ

これらの手法を用いて、RubyでJSONデータを扱う際の自信を深めていきましょう。

また、エラーに出会った際には、今回学んだ対処法を参考にしてみてください。

この記事がRubyとJSONの基本的な使い方と応用例を紹介し、皆様の学びの一助となることを願っています。