модуль Marshal

Библиотека маршалинга преобразует коллекции объектов Ruby в поток байтов, позволяя сохранять их вне текущего активного скрипта. Впоследствии эти данные можно прочитать и восстановить исходные объекты.

Данные Marshal содержат номера основной и дополнительной версий, сохранённые вместе с информацией об объекте. При обычном использовании Marshal может загружать только данные, записанные с тем же номером основной версии и равным или меньшим номером дополнительной версии. Если установлен флаг Ruby «verbose» (обычно с помощью -d, -v, -w или –verbose), номера основной и дополнительной версий должны точно совпадать. Версионирование Marshal не зависит от номеров версий Ruby. Версию можно получить, прочитав первые два байта данных Marshal.

str = Marshal.dump("thing")
RUBY_VERSION   #=> "1.9.0"
str[0].ord     #=> 4
str[1].ord     #=> 8

Некоторые объекты нельзя сохранить: если среди сохраняемых объектов есть привязки, объекты процедур или методов, экземпляры класса IO или одиночные объекты, будет вызвано исключение TypeError.

Если для вашего класса требуются особые правила сериализации (например, вы хотите сериализовать его в определённом формате) или он содержит объекты, которые иначе невозможно сериализовать, можно реализовать собственную стратегию сериализации.

Это можно сделать двумя способами: объект может определить либо marshal_dump и marshal_load, либо _dump и _load. Если определены оба варианта, marshal_dump имеет приоритет над _dump. marshal_dump может создавать более короткие строки Marshal.

Соображения безопасности

По замыслу, Marshal.load может десериализовать почти любой класс, загруженный в процесс Ruby. Во многих случаях это может привести к удалённому выполнению кода, если данные Marshal загружаются из ненадёжного источника.

Поэтому Marshal.load не подходит в качестве формата сериализации общего назначения, и никогда не следует выполнять демаршалинг пользовательского ввода или других недоверенных данных.

Если требуется десериализовать недоверенные данные, используйте JSON или другой формат сериализации, который может загружать только простые «примитивные» типы, такие как String, Array, Hash и т. д. Никогда не позволяйте пользовательскому вводу задавать произвольные типы для десериализации.

marshal_dump и marshal_load

При сохранении объекта будет вызван метод marshal_dump. Метод marshal_dump должен возвращать результат, содержащий сведения, необходимые методу marshal_load для восстановления объекта. Результатом может быть любой объект.

При загрузке объекта, сохранённого с помощью marshal_dump, сначала выделяется память для объекта, затем marshal_load вызывается с результатом marshal_dump. Метод marshal_load должен восстановить объект по сведениям из результата.

Пример:

class MyObj
  def initialize name, version, data
    @name    = name
    @version = version
    @data    = data
  end

  def marshal_dump
    [@name, @version]
  end

  def marshal_load array
    @name, @version = array
  end
end

_dump и _load

Используйте _dump и _load, если необходимо самостоятельно выделить память для восстанавливаемого объекта.

При сохранении объекта вызывается метод экземпляра _dump с Integer, указывающим максимальную глубину сохраняемых объектов (значение -1 означает, что проверку глубины следует отключить). Метод _dump должен возвращать String, содержащую сведения, необходимые для восстановления объекта.

Метод класса _load должен принимать String и использовать её для возврата объекта того же класса.

Пример:

class MyObj
  def initialize name, version, data
    @name    = name
    @version = version
    @data    = data
  end

  def _dump level
    [@name, @version].join ':'
  end

  def self._load args
    new(*args.split(':'))
  end
end

Поскольку Marshal.dump возвращает строку, метод _dump может возвращать строку Marshal, которую Marshal.loaded обработает в _load для сложных объектов.