Rubyでbindataを使う方法を現役エンジニアが解説【初心者向け】

初心者向けにRubyでbindataを使う方法について現役エンジニアが解説しています。bindataとはRubyのgemの1つで、バイナリデータを扱うことができます。Rubyのgemのbindataのインストール方法や書き方、使い方について説明します。バイナリデータをテキストデータに変換してみましょう。

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

Rubyでbindataを使う方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

そもそもRubyについてよく分からないという方は、Rubyとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプRuby講座の内容をもとに紹介しています。

 

田島悠介

今回は、Rubyに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Rubyでbindataを使う方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

目次

 

bindataとは

プログラミングする際に、バイナリデータは扱いが難しいことがあります。

一般的にデータには大きく2種類あります。
1つは人が目視して内容を読み取ることができるテキストデータ、もう1つは人が目視してもすぐには内容がわからないデータを羅列しただけのバイナリデータです。

bindataとは、Rubyのgemの1つです。このgemを使うと、Rubyのプログラム上でバイナリデータを簡単に扱うことができます。
 

[PR] Rubyのプログラミングで挫折しない学習方法を動画で公開中

bindataを使う方法

binataを使うには、まずgemをinstallする必要があります。以下を実行します。

$ gem install bindata

実行が成功すると、以下のように表示されます。

Fetching bindata-2.4.8.gem
Successfully installed bindata-2.4.8
Parsing documentation for bindata-2.4.8
Installing ri documentation for bindata-2.4.8
Done installing documentation for bindata after 0 seconds
1 gem installed

※バージョン番号(執筆時は2.4.8)は異なることがあります。

BinDataというgemがインストールされます。BinDataについては、GitHub – dmendel/bindata: BinData – Parsing Binary Data in Ruby も合わせてご覧ください。

BinDataは、以下のように使います。

require 'bindata'

class クラス名 < BinData::Record
  データ構造を定義
end

io = File.open(ファイル名)
data = クラス名.read(io)

最初に

require 'bindata'

でBinDataのライブラリを読み込みます。次に、読み込みたいデータ構造を定義します。

バイナリの先頭から、どういうデータがどのような長さで続いているかを順に定義します。例えば、先頭にデータの長さが16bit(2byte)あって、実際のデータが長さ分あるとすると

endian :big
uint16 :len
string :data, :read_length => :len

のような定義になります。

そしてuint16のように、長さのような多バイトのデータを取得する場合には、バイトオーダーをendian要素で指定します。

ビッグエンディアン(big)かリトルエンディアン(little)かを指定します。ビッグエンディアンとは、最上位ビット(Most significant Bit)の属するバイト(Most Significant Byte)を低位のアドレスへ格納していく方式です。

0008というデータがあれば、0008という順に格納されます。リトルエンディアンとは、最下位ビット(Least Significant Bit)の属するバイト(Least Significant Byte)を低位のアドレスへ格納していく方式です。0008というデータは、0800とバイトが逆に格納されます。

この定義に合ったバイナリデータの例は

00087465737464617461

のようなデータを用意します。この例では、バイナリエディタなどで作成して保存したファイルを読み込みます。

0008が長さ(len)で、そのあとが長さlen分のdataという構造です。取得できるデータは、

{:len=>8, :data=>"testdata"}

となります。

readメソッドの戻り値は、読み込んだデータのハッシュです。

この例では、ファイルからの読み込みですが、バイナリデータであればファイル以外からでも読み込んでデータを取得できます。
 

実際に書いてみよう

require 'bindata'

class Car < BinData::Record
  endian :big
  uint16 :len
  string :name, :read_length => :len
  uint16 :clength
  uint16 :width
  uint16 :height
  uint16 :weight
end

io = File.open("car.bin")
r = Car.read(io)
puts "車名:#{r.name} 全長:#{r.clength}mm 全幅:#{r.width}mm 全高:#{r.height}mm 車重 #{r.weight}kg"

と書きます。この例では、車情報を以下のようなバイナリーデータcar.binというファイルで用意して読み込みます。

ちなみに、全長の変数名がclengthなのは、lengthを使いたいのですが予約語で使えないので名前を変更しています。

00023836109006ef052804ba

このプログラムを実行すると、

車名:86 全長:4240mm 全幅:1775mm 全高:1320mm 車重 1210kg

と表示されます。
 

まとめ

bindataは、バイナリデータを簡単に読み込むことができます。

バイナリデータを扱う機会があれば使ってみてください。
 

筆者プロフィール

伊藤広明(いとうひろあき)

1990年代からソフトウェア開発を仕事としてはじめ、2000年ごろからWEBエンジニアの仕事にも従事。
世の中で末長く使ってもらえるシステム開発が信条。後進の育成にも力を入れている。

作れるもの:Webシステム、スマホアプリ
書ける言語: Ruby・PHP・Python・Java・Swift・C#・C/C++・JavaScriptなど
経験があるフレームワーク: Laravel・Ruby on Rails・Apache Strutsなど

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でもRuby on Railsを使ったプログラミングを習得できるオンラインブートキャンプRuby講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。