RubyでXML操作 (REXML)

(2007.1.14 全体的に更新。)

Rubyの標準添付XMLライブラリ、REXMLの使い方。

Warning.

(2019.1)

REXML は, 標準添付ですが, 品質・速度の両面であまりよくありません。Nokogiri (鋸) がメジャーで、長らく標準の地位で使われています。REXML の3倍速い。

最近は, 大鋸 (おが) の人気が高い。スレッドセーフ、高速、機能性もある。Yorick Peterse / oga · GitLab

REXMLの特徴

REXMLは、

  • XML 1.0に準拠した、高速なXMLパーサで、DOMツリーを生成したり、XML文書を読みながらコールバックさせる (SAX2ストリームパーサ) ことができる。
  • XPathの実装を含み、検索式によってDOMツリーの好きな要素を取り出すことができる。

Ruby 1.8.5にはREXML 3.1.4が添付されている。チュートリアル、APIリファレンスは下記で見られる。が、APIリファレンスのほうは不十分かつ誤りもある。使いかたをまとめてみた。

DOMツリーの生成と要素の取り出し

何はともあれ、XML文書を読み込み、パースしないと始まらない。

まずはDOMツリーを生成してみる。REXMLのパーサは、整形式 (well-formed) なXML文書を（妥当性検査せずに）パースし、DOMツリーを生成する。

Ruby
[RAW]
  1. require "rexml/document"
  3. source = <<EOF
  4. <?xml version="1.0"?>
  5. <foo><bar />
  6. <baz>ho&lt;ge</baz>
  7. </foo>
  8. EOF
  10. doc = REXML::Document.new source
  11. p doc.root, doc.root.class
  12. #=> <foo> ... </>
  13. #=> REXML::Element
  15. p doc.elements
  16. #=> #<REXML::Elements:0x4844cbc @element=<UNDEFINED> ... </>>
  18. p doc.elements['/foo/baz'].text
  19. #=> "ho<ge":String # 実体参照が変換される。&lt;と < は区別されない。
  21. # 区別したいときはこうすればいい。
  22. p doc.elements['/foo/baz'].get_text #=> "ho&lt;ge"
  23. p doc.elements['/foo/baz'].get_text.class #=> REXML::Text

REXML::Document.newは、文字列またはIOオブジェクトを引数に取り、パースしてDOMツリーを生成する。読み込んだデータが整形式でないときは、REXML::ParseException 例外が投げられる。

Documentオブジェクトは、eachメソッドでXML宣言、要素などを順に取得できる。each メソッドでは直接の子要素がブロックに渡される。

Ruby
[RAW]
  1. require "rexml/document"
  3. doc = nil
  4. File.open("xmlsample.xml") {|fp|
  5. doc = REXML::Document.new fp
  6. }
  8. i = 0
  9. doc.each {|e|
  10. s = e.to_s.strip.split("\n")[0]
  11. print "#{i}: #{s} #<#{e.class}>\n"
  12. i += 1
  13. }

XML文書を作る

(2007.11.30 この節追加。)

今度は、何もないところからXML文書を作ってみます。次のスクリプトはATOMフィードのひな形を作ります。

単にDocument.new を呼び出すと、空のXML文書になります。

<<オペレータ、add_element(), add_text() で、外側の要素から順に作っていきます。

Ruby
[RAW]
  1. require 'rexml/document'
  3. doc = REXML::Document.new
  4. doc << REXML::XMLDecl.new('1.0', 'UTF-8')
  6. # add_element は追加した子要素を返す
  7. feed = doc.add_element("feed", {"xmlns" => "http://www.w3.org/2005/Atom"})
  8. feed.add_element("title", {'type' => 'text'}).add_text "Netsphere Feed"
  10. doc.write STDOUT

次のXML文書が出力されます。(手で整形しています。実際の出力では要素の間に空白、改行はありません。)

HTML/XML
[RAW]
  1. <?xml version='1.0' encoding='UTF-8'?>
  2. <feed xmlns='http://www.w3.org/2005/Atom'>
  3. <title type='text'>Netsphere Feed</title>
  4. </feed>

XPathで要素を取り出す

REXMLは、[]メソッドにXPath式を指定して、XML文書から柔軟に要素を取り出せます。

TODO:

主なクラス

(2007.12.4 更新)

REXMLでは，次の表にある左の項目は，右のクラスのオブジェクトとなります。

項目クラス
XML宣言REXML::XMLDecl
文書型宣言REXML::DocType
処理命令REXML::Instruction
要素REXML::Element
コメントREXML::Comment
CDATAセクションREXML::CData
文字データ，参照REXML::Text

Elementクラス (以下、本文ではREXML::は省略します。) はParentから、また、ParentとTextはChildクラスから派生しています。各クラスの関係は次のクラス図のとおりです。

DocumentクラスはElementクラスから派生しています。XML文書はただ一つのroot要素を持ちますが、だからと言ってElementから派生させるのはどうかと思わなくもありません (aDocument is_a Element, Parent or Child ではない)。

Note.

W3C Document Object Model (DOM) Coreでは、Documentインターフェイス、Elementインターフェイスは両方ともNodeから派生している。

いろいろなパーサ

REXMLには、ストリームパーサ、pull-parserも付いている。これらのパーサは、XML文書の使い方によって使い分ける。あるいは別のプログラミング言語からの移植の場合でも適宜使い分けることになるだろう。

ストリームパーサ

ストリームパーサは、特定の要素や属性にしか用事がないときなどに使う。ストリームパーサを使うときは、パーサにリスナオブジェクトを渡して、適宜コールバックさせる。

Parsers::StreamParserクラスには、StreamListenerモジュールが対応する。StreamListenerモジュールをincludeし、コールバックさせたい項目のメソッドを定義すればいい。

Ruby
[RAW]
  1. require 'rexml/parsers/streamparser'
  2. require 'rexml/parsers/baseparser'
  3. require 'rexml/streamlistener'
  5. # 全部のメソッドを実装しなくても、
  6. # StreamListenerモジュールをincludeすればいい。
  7. class MyListener
  8. include REXML::StreamListener
  10. # attrs ハッシュ
  11. # 属性がないときは、{}
  12. def tag_start(name, attrs)
  13. p name, attrs
  14. end
  16. def tag_end x
  17. p "tag_end: #{x}"
  18. end
  20. # encoding, standaloneは、指定がなければnil
  21. def xmldecl(version, encoding, standalone)
  22. p version, encoding, standalone
  23. end
  24. end
  26. source = File.read "01rep.xml"
  27. listener = MyListener.new
  28. REXML::Parsers::StreamParser.new(source, listener).parse

Pullパーサ

今度は、ノードを一つずつ取り出すパーサ。APIドキュメントの例は誤っている。

Parsers::PullParserオブジェクトは、has_next?メソッドとpullメソッドを持つ。pull() の戻り値はParsers::PullEventインスタンス。

Ruby
[RAW]
  1. require "rexml/parsers/pullparser"
  3. source = File.read "01rep.xml"
  4. parser = REXML::Parsers::PullParser.new(source)
  6. while parser.has_next?
  7. res = parser.pull
  8. if res.event_type == :start_element
  9. res[0..-1].each_with_index {|e, i|
  10. puts "#{i}: #{e} / #{e.class}" #=> "addressBook", {}
  11. }
  12. end
  13. end

SAX2リスナ

Parsers::StreamParserと似たパーサとして、SAX2パーサがある。

Ruby
[RAW]
  1. require "rexml/parsers/sax2parser"
  2. require "rexml/sax2listener"
  4. class MyEventListener
  5. def receive event
  6. p event
  7. end
  8. end
  10. # すべてのメソッドを実装しないときは、SAX2Listenerモジュールをincludeすればいい。
  11. class MySAXListener
  12. include REXML::SAX2Listener
  14. def start_document
  15. puts "start."
  16. end
  18. def xmldecl version, encoding, standalone
  19. p version
  20. end
  21. end
  23. source = File.read "01rep.xml"
  24. parser = REXML::Parsers::SAX2Parser.new(source)
  26. # イベントリスナをattachする。
  27. parser.add_listener(MyEventListener.new)
  29. # SAX2リスナをattachする。
  30. parser.listen(MySAXListener.new)
  31. parser.parse

XML文書の妥当性検査

XML文書の妥当性検査のための仕様 DTD, W3C XML Schema, RELAX NG のうち、REXMLでサポートされている。

サイト内リンク

(2007.12.6 ページを分けました)