модуль Marshal

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

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

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