модуль Marshal

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

Данные 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 для сложных объектов.