модуль Marshal

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

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

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

По умолчанию, ::load может десериализовать практически любой класс, загруженный в процесс Ruby. Во многих случаях это может привести к выполнению удаленного кода, если данные 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 с целым числом, которое указывает максимальную глубину объектов для сохранения (значение -1 подразумевает отключение проверки глубины). _dump должен вернуть строку, содержащую информацию, необходимую для восстановления объекта.

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

Пример:

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

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