在Ruby中处理XML和XSLT以及XPath的简单教程

什么是 XML ?

XML 指可扩展标记语言（eXtensible Markup Language）。

可扩展标记语言，标准通用标记语言的子集，一种用于标记电子文件使其具有结构性的标记语言。

它可以用来标记数据、定义数据类型，是一种允许用户对自己的标记语言进行定义的源语言。 它非常适合万维网传输，提供统一的方法来描述和交换独立于应用程序或供应商的结构化数据。

XML解析器结构和API

XML的解析器主要有DOM和SAX两种。

1.     SAX解析器是基于事件处理的，需要从头到尾把XML文档扫描一遍，在扫描的过程中，每次遇到一个语法结构时，就会调用这个特定语法结构的事件处理程序，向应用程序发送一个事件。
2.     DOM是文档对象模型解析，构建文档的分层语法结构，在内存中建立DOM树，DOM树的节点以对象的形式来标识，文档解析文成以后，文档的整个DOM树都会放在内存中。

Ruby 中解析及创建 XML

RUBY中对XML的文档的解析可以使用这个库REXML库。

REXML库是ruby的一个XML工具包，是使用纯Ruby语言编写的，遵守XML1.0规范。

在Ruby1.8版本及其以后，RUBY标准库中将包含REXML。

REXML库的路径是： rexml/document

所有的方法和类都被封装到一个REXML模块内。

REXML解析器比其他的解析器有以下优点：

1.     100% 由 Ruby 编写。
2.     可适用于 SAX 和 DOM 解析器。
3.     它是轻量级的,不到2000行代码。
4.     很容易理解的方法和类。
5.     基于 SAX2 API 和完整的 XPath 支持。
6.     使用 Ruby 安装，而无需单独安装。

以下为实例的 XML 代码，保存为movies.xml:

1. <collection shelf="New Arrivals"> 
2. <movie title="Enemy Behind"> 
3.   <type>War, Thriller</type> 
4.   <format>DVD</format> 
5.   <year>2003</year> 
6.   <rating>PG</rating> 
7.   <stars>10</stars> 
8.   <description>Talk about a US-Japan war</description> 
9. </movie> 
10. <movie title="Transformers"> 
11.   <type>Anime, Science Fiction</type> 
12.   <format>DVD</format> 
13.   <year>1989</year> 
14.   <rating>R</rating> 
15.   <stars>8</stars> 
16.   <description>A schientific fiction</description> 
17. </movie> 
18.   <movie title="Trigun"> 
19.   <type>Anime, Action</type> 
20.   <format>DVD</format> 
21.   <episodes>4</episodes> 
22.   <rating>PG</rating> 
23.   <stars>10</stars> 
24.   <description>Vash the Stampede!</description> 
25. </movie> 
26. <movie title="Ishtar"> 
27.   <type>Comedy</type> 
28.   <format>VHS</format> 
29.   <rating>PG</rating> 
30.   <stars>2</stars> 
31.   <description>Viewable boredom</description> 
32. </movie> 
33. </collection> 

DOM 解析器

让我们先来解析 XML 数据，首先我们先引入 rexml/document 库，通常我们可以将 REXML 在*的命名空间中引入：

1. #!/usr/bin/ruby -w 
2.   
3. require 'rexml/document' 
4. include REXML 
5.   
6. xmlfile = File.new("movies.xml") 
7. xmldoc = Document.new(xmlfile) 
8.   
9. # 获取 root 元素 
10. root = xmldoc.root 
11. puts "Root element : " + root.attributes["shelf"] 
12.   
13. # 以下将输出电影标题 
14. xmldoc.elements.each("collection/movie"){ 
15.   |e| puts "Movie Title : " + e.attributes["title"] 
16. } 
17.   
18. # 以下将输出所有电影类型 
19. xmldoc.elements.each("collection/movie/type") { 
20.   |e| puts "Movie Type : " + e.text 
21. } 
22.   
23. # 以下将输出所有电影描述 
24. xmldoc.elements.each("collection/movie/description") { 
25.   |e| puts "Movie Description : " + e.text 
26. } 

以上实例输出结果为：

Root element : New Arrivals
Movie Title : Enemy Behind
Movie Title : Transformers
Movie Title : Trigun
Movie Title : Ishtar
Movie Type : War, Thriller
Movie Type : Anime, Science Fiction
Movie Type : Anime, Action
Movie Type : Comedy
Movie Description : Talk about a US-Japan war
Movie Description : A schientific fiction
Movie Description : Vash the Stampede!
Movie Description : Viewable boredom
SAX-like Parsing:

SAX 解析器

处理相同的数据文件：movies.xml，不建议SAX的解析为一个小文件，以下是个简单的实例：

1. #!/usr/bin/ruby -w 
2.   
3. require 'rexml/document' 
4. require 'rexml/streamlistener' 
5. include REXML 
6.   
7.   
8. class MyListener 
9.  include REXML::StreamListener 
10.  def tag_start(*args) 
11.   puts "tag_start: #{args.map {|x| x.inspect}.join(', ')}" 
12.  end 
13.   
14.  def text(data) 
15.   return if data =~ /^w*$/   # whitespace only 
16.   abbrev = data[0..40] + (data.length > 40 ? "..." : "") 
17.   puts " text  :  #{abbrev.inspect}" 
18.  end 
19. end 
20.   
21. list = MyListener.new 
22. xmlfile = File.new("movies.xml") 
23. Document.parse_stream(xmlfile, list) 

以上输出结果为：

1. tag_start: "collection", {"shelf"=>"New Arrivals"} 
2. tag_start: "movie", {"title"=>"Enemy Behind"} 
3. tag_start: "type", {} 
4.  text  :  "War, Thriller" 
5. tag_start: "format", {} 
6. tag_start: "year", {} 
7. tag_start: "rating", {} 
8. tag_start: "stars", {} 
9. tag_start: "description", {} 
10.  text  :  "Talk about a US-Japan war" 
11. tag_start: "movie", {"title"=>"Transformers"} 
12. tag_start: "type", {} 
13.  text  :  "Anime, Science Fiction" 
14. tag_start: "format", {} 
15. tag_start: "year", {} 
16. tag_start: "rating", {} 
17. tag_start: "stars", {} 
18. tag_start: "description", {} 
19.  text  :  "A schientific fiction" 
20. tag_start: "movie", {"title"=>"Trigun"} 
21. tag_start: "type", {} 
22.  text  :  "Anime, Action" 
23. tag_start: "format", {} 
24. tag_start: "episodes", {} 
25. tag_start: "rating", {} 
26. tag_start: "stars", {} 
27. tag_start: "description", {} 
28.  text  :  "Vash the Stampede!" 
29. tag_start: "movie", {"title"=>"Ishtar"} 
30. tag_start: "type", {} 
31. tag_start: "format", {} 
32. tag_start: "rating", {} 
33. tag_start: "stars", {} 
34. tag_start: "description", {} 
35.  text  :  "Viewable boredom" 

XPath 和 Ruby

我们可以使用XPath来查看XML ,XPath 是一门在 XML 文档中查找信息的语言(查看：XPath 教程)。

XPath即为XML路径语言，它是一种用来确定XML（标准通用标记语言的子集）文档中某部分位置的语言。XPath基于XML的树状结构，提供在数据结构树中找寻节点的能力。

Ruby 通过 REXML 的 XPath 类支持 XPath，它是基于树的分析（文档对象模型）。

1. #!/usr/bin/ruby -w 
2.   
3. require 'rexml/document' 
4. include REXML 
5.   
6. xmlfile = File.new("movies.xml") 
7. xmldoc = Document.new(xmlfile) 
8.   
9. # 第一个电影的信息 
10. movie = XPath.first(xmldoc, "//movie") 
11. p movie 
12.   
13. # 打印所有电影类型 
14. XPath.each(xmldoc, "//type") { |e| puts e.text } 
15.   
16. # 获取所有电影格式的类型，返回数组 
17. names = XPath.match(xmldoc, "//format").map {|x| x.text } 
18. p names 

以上实例输出结果为：

1. <movie title='Enemy Behind'> ... </> 
2. War, Thriller 
3. Anime, Science Fiction 
4. Anime, Action 
5. Comedy 
6. ["DVD", "DVD", "DVD", "VHS"] 

XSLT 和 Ruby

Ruby 中有两个 XSLT 解析器，以下给出简要描述：
Ruby-Sablotron

这个解析器是由正义Masayoshi Takahash编写和维护。这主要是为Linux操作系统编写的，需要以下库：

1.     Sablot
2.     Iconv
3.     Expat

你可以在 Ruby-Sablotron 找到这些库。
XSLT4R
XSLT4R 由 Michael Neumann 编写。 XSLT4R 用于简单的命令行交互，可以被第三方应用程序用来转换XML文档。

XSLT4R需要XMLScan操作，包含了 XSLT4R 归档，它是一个100%的Ruby的模块。这些模块可以使用标准的Ruby安装方法（即Ruby install.rb）进行安装。

XSLT4R 语法格式如下：

ruby xslt.rb stylesheet.xsl document.xml [arguments]

如果您想在应用程序中使用XSLT4R，您可以引入XSLT及输入你所需要的参数。实例如下：

1. require "xslt" 
2.   
3. stylesheet = File.readlines("stylesheet.xsl").to_s 
4. xml_doc = File.readlines("document.xml").to_s 
5. arguments = { 'image_dir' => '/....' } 
6.   
7. sheet = XSLT::Stylesheet.new( stylesheet, arguments ) 
8.   
9. # output to StdOut 
10. sheet.apply( xml_doc ) 
11.   
12. # output to 'str' 
13. str = "" 
14. sheet.output = [ str ] 
15. sheet.apply( xml_doc )