模块 Marshal

序列化库将 Ruby 对象集合转换为字节流，允许它们存储在当前活动脚本之外。这些数据随后可以被读取，并重建原始对象。

序列化数据包含与对象信息一起存储的主版本号和次版本号。在正常使用中，序列化只能加载使用相同主版本号和等于或更低的次版本号写入的数据。如果 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_dump 的结果调用 marshal_load。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 中被 Marshal.loaded 用于复杂对象。