Учебное руководство по XML, XSLT и XPath в Ruby


Что такое XML?

XML расшифровывается как eXtensible Markup Language.

Extensible Markup Language, подмножество Standard Generalized Markup Language, — это язык разметки, используемый для разметки электронных документов, чтобы придать им структуру.

Его можно использовать для разметки данных и определения типов данных. Это исходный язык, позволяющий пользователям определять собственный язык разметки. Он очень хорошо подходит для передачи через World Wide Web, предоставляя унифицированный метод описания и обмена структурированными данными, независимый от приложений или поставщиков.

Для получения дополнительной информации, пожалуйста, посмотрите нашУчебник по XML


Структура XML-парсера и API

В основном существует два типа XML-парсеров: DOM и SAX.

  • SAX-парсер основан на обработке событий. Он сканирует XML-документ от начала до конца. В процессе сканирования каждый раз, когда встречается синтаксическая структура, вызывается обработчик событий для этой конкретной синтаксической структуры, чтобы отправить событие приложению.
  • DOM — это разбор Document Object Model. Он строит иерархическую синтаксическую структуру документа и создаёт DOM-дерево в памяти. Узлы DOM-дерева идентифицируются в виде объектов. После разбора документа всё DOM-дерево документа помещается в память.

Разбор и создание XML в Ruby

В Ruby для разбора XML-документов можно использовать библиотеку REXML.

Библиотека REXML — это XML-инструментарий для Ruby. Она написана на чистом Ruby и соответствует спецификации XML 1.0.

В Ruby 1.8 и более поздних версиях REXML входит в стандартную библиотеку Ruby.

Путь библиотеки REXML: rexml/document

Все методы и классы инкапсулированы в модуле REXML.

Парсер REXML имеет следующие преимущества перед другими парсерами:

  • На 100% написан на Ruby.
  • Применим к парсерам SAX и DOM.
  • Он лёгкий, содержит менее 2000 строк кода.
  • Простые для понимания методы и классы.
  • На основе SAX2 API и полной поддержки XPath.
  • Устанавливается вместе с Ruby, отдельная установка не требуется.

Ниже приведён XML-код для примера, сохранённый как movies.xml:

<collection shelf="Новые поступления"> <movie название="Враг за спиной"> <тип>Военный, триллер</тип> <формат>DVD</формат> <год>2003</год> <рейтинг>PG</рейтинг> <звёзды>10</звёзды> <описание>Разговор о войне между США и Японией</описание> </фильм> <фильм название="Трансформеры"> <тип>Аниме, научная фантастика</тип> <формат>DVD</формат> <год>1989</год> <рейтинг>R</рейтинг> <звёзды>8</звёзды> <описание>Научная фантастика</описание> </фильм> <фильм название="Триган"> <тип>Аниме, боевик</тип> <формат>DVD</формат> <эпизоды>4</эпизоды> <рейтинг>PG</рейтинг> <звёзды>10</звёзды> <описание>Вэш Ураган!</описание> </фильм> <фильм название="Иштар"> <тип>Комедия</тип> <формат>VHS</формат> <рейтинг>PG</рейтинг> <звёзды>2</звёзды> <описание>Смотрибельная скука</описание> </фильм> </коллекция>

DOM-парсер

Сначала разберём XML-данные. Сначала импортируем библиотеку rexml/document. Обычно мы можем импортировать REXML в пространство имён верхнего уровня:

Пример

#!/usr/bin/ruby -w require 'rexml/document' include REXML xmlfile = File.new("movies.xml") xmldoc = Document.new(xmlfile) #Получить корневой элемент root = xmldoc.root puts "Корневой элемент : " + root.attributes["shelf"] #Далее будут выведены названия фильмов xmldoc.elements.each("collection/movie"){ |e| puts "Название фильма : " + e.attributes["title"] } #Следующее выведет все типы фильмов xmldoc.elements.each("collection/movie/type") { |e| puts "Тип фильма: " + e.text } #Следующее выведет все описания фильмов xmldoc.elements.each("collection/movie/description") { |e| puts "Описание фильма: " + e.text }

Результат вывода приведённого выше примера:

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-парсинг не рекомендуется для небольшого файла. Ниже приведён простой пример:

Пример

#!/usr/bin/ruby -w require 'rexml/document' require 'rexml/streamlistener' include REXML class MyListener include REXML::StreamListener def tag_start(*args) puts "tag_start: #{args.map {|x| x.inspect}.join(', ')}" end def text(data) return if data =~ /^\w*$/ # только пробельные символы abbrev = data[0..40] + (data.length > 40 ? "..." : "") puts " text : #{abbrev.inspect}" end end list = MyListener.new xmlfile = File.new("movies.xml") Document.parse_stream(xmlfile, list)

Результат вывода выше:

tag_start: "collection", {"shelf"=>"New Arrivals"}
tag_start: "movie", {"title"=>"Enemy Behind"}
tag_start: "type", {}
  text   :   "War, Thriller"
tag_start: "format", {}
tag_start: "year", {}
tag_start: "rating", {}
tag_start: "stars", {}
tag_start: "description", {}
  text   :   "Talk about a US-Japan war"
tag_start: "movie", {"title"=>"Transformers"}
tag_start: "type", {}
  text   :   "Anime, Science Fiction"
tag_start: "format", {}
tag_start: "year", {}
tag_start: "rating", {}
tag_start: "stars", {}
tag_start: "description", {}
  text   :   "A schientific fiction"
tag_start: "movie", {"title"=>"Trigun"}
tag_start: "type", {}
  text   :   "Anime, Action"
tag_start: "format", {}
tag_start: "episodes", {}
tag_start: "rating", {}
tag_start: "stars", {}
tag_start: "description", {}
  text   :   "Vash the Stampede!"
tag_start: "movie", {"title"=>"Ishtar"}
tag_start: "type", {}
tag_start: "format", {}
tag_start: "rating", {}
tag_start: "stars", {}
tag_start: "description", {}
  text   :   "Viewable boredom"

XPath и Ruby

Мы можем использовать XPath для просмотра XML. XPath — это язык для поиска информации в XML-документах (см.:Учебник по XPath)。

XPath — это язык путей XML. Это язык, используемый для определения позиции части в XML-документе (подмножестве Standard Generalized Markup Language). XPath основан на древовидной структуре XML и предоставляет возможность находить узлы в дереве структуры данных.

Ruby поддерживает XPath через класс XPath в REXML, который основан на анализе дерева (объектная модель документа).

Пример

#!/usr/bin/ruby -w require 'rexml/document' include REXML xmlfile = File.new("movies.xml") xmldoc = Document.new(xmlfile) #Информация о первом фильме movie = XPath.first(xmldoc, "//movie") p movie #Вывести все типы фильмов XPath.each(xmldoc, "//type") { |e| puts e.text } #Получить все типы форматов фильмов и вернуть массив names = XPath.match(xmldoc, "//format").map {|x| x.text } p names

Результат вывода приведённого выше примера:

<movie title='Enemy Behind'> ... </>
War, Thriller
Anime, Science Fiction
Anime, Action
Comedy
["DVD", "DVD", "DVD", "VHS"]

XSLT и Ruby

В Ruby есть два парсера XSLT. Краткое описание приведено ниже:

Ruby-Sablotron

Этот парсер был написан и поддерживается Masayoshi Takahash. В основном он написан для операционной системы Linux и требует следующих библиотек:

  • Sablot
  • Iconv
  • Expat

Вы можетеRuby-Sablotronнайти эти библиотеки.

XSLT4R

XSLT4R был написан Майклом Нойманом. XSLT4R используется для простого взаимодействия из командной строки и может использоваться сторонними приложениями для преобразования XML-документов.

XSLT4R требует XMLScan для работы; XMLScan включён в архив XSLT4R. Это 100% Ruby-модуль. Эти модули можно установить с помощью стандартного метода установки Ruby (т.е. ruby install.rb).

Формат синтаксиса XSLT4R следующий:

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

Если вы хотите использовать XSLT4R в своём приложении, вы можете подключить XSLT и ввести нужные параметры. Пример выглядит следующим образом:

Пример

require "xslt" stylesheet = File.readlines("stylesheet.xsl").to_s xml_doc = File.readlines("document.xml").to_s arguments = { 'image_dir' => '/....' } sheet = XSLT::Stylesheet.new( stylesheet, arguments ) # вывод в StdOut sheet.apply( xml_doc ) # вывод в 'str' str = "" sheet.output = [ str ] sheet.apply( xml_doc )

Дополнительные ресурсы

Другие расширения