модуль 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 строку, которая будет загружена в _load для сложных объектов.