Ruby Singleton模塊用法及代碼示例

Singleton 模塊實現了 Singleton 模式。

用法

要使用 Singleton ，請將模塊包含在您的類中。

class Klass
   include Singleton
   # ...
end

這確保了隻能創建一個 Klass 實例。

a,b = Klass.instance, Klass.instance

a == b
# => true

Klass.new
# => NoMethodError - new is private ...

該實例是在第一次調用 Klass.instance() 時創建的。

class OtherKlass
  include Singleton
  # ...
end

ObjectSpace.each_object(OtherKlass){}
# => 0

OtherKlass.instance
ObjectSpace.each_object(OtherKlass){}
# => 1

此行為在繼承和克隆下保留。

執行

以上是通過以下方式實現的：

• 將 Klass.new 和 Klass.allocate 設為私有。

• 覆蓋 Klass.inherited(sub_klass) 和 Klass.clone() 以確保在繼承和克隆時保留 Singleton 屬性。

• 提供每次調用時返回相同對象的 Klass.instance() 方法。

• 覆蓋 Klass._load(str) 以調用 Klass.instance()。

• 覆蓋 Klass#clone 和 Klass#dup 以引發 TypeErrors 以防止克隆或複製。

Singleton 和 Marshal

默認情況下，Singleton 的 #_dump(depth) 返回空字符串。默認情況下編組將刪除狀態信息，例如來自實例的實例變量。使用 Singleton 的類可以提供自定義 _load(str) 和 _dump(depth) 方法來保留實例的某些先前狀態。

require 'singleton'

class Example
  include Singleton
  attr_accessor :keep, :strip
  def _dump(depth)
    # this strips the @strip information from the instance
    Marshal.dump(@keep, depth)
  end

  def self._load(str)
    instance.keep = Marshal.load(str)
    instance
  end
end

a = Example.instance
a.keep = "keep this"
a.strip = "get rid of this"

stored_state = Marshal.dump(a)

a.keep = nil
a.strip = nil
b = Marshal.load(stored_state)
p a == b  #  => true
p a.keep  #  => "keep this"
p a.strip #  => nil