web-dev-qa-db-ja.com

Rubyで「コールバック」を実装する方法は？

Ruby-またはさらに良いものがある場合（およびCのようなものではない）Cスタイルのコールバックの最良のイディオムがわからない。Cでは、次のようなことをする：

void DoStuff( int parameter, CallbackPtr callback )
{
  // Do stuff
  ...
  // Notify we're done
  callback( status_code )
}

良いRuby同等？基本的に、 "DoStuff"内で特定の条件が満たされたときに、クラスメソッドに渡されたメソッドを呼び出したい

rubycallback
70
Justicle

Ruby同等、これは慣用的ではありませんが、次のようになります：

def my_callback(a, b, c, status_code)
  puts "did stuff with #{a}, #{b}, #{c} and got #{status_code}"
end

def do_stuff(a, b, c, callback)
  sum = a + b + c
  callback.call(a, b, c, sum)
end

def main
  a = 1
  b = 2
  c = 3
  do_stuff(a, b, c, method(:my_callback))
end

慣用的なアプローチは、メソッドへの参照の代わりにブロックを渡すことです。ブロックが独立したメソッドよりも優れている1つの利点はコンテキストです。ブロックは closure であるため、宣言されたスコープから変数を参照できます。これにより、do_stuffがコールバックに渡す必要のあるパラメーターの数が削減されます。例えば：

def do_stuff(a, b, c, &block)
  sum = a + b + c
  yield sum
end

def main
  a = 1
  b = 2
  c = 3
  do_stuff(a, b, c) { |status_code|
    puts "did stuff with #{a}, #{b}, #{c} and got #{status_code}"
  }
end
84
dstnbrkr

この「イディオマティックブロック」は、日常的なRubyの中核部分であり、書籍やチュートリアルで頻繁に取り上げられています。Ruby情報セクション は、便利な[オンライン]学習リソースへのリンクを提供します。

慣用的な方法はブロックを使用することです：

def x(z)
  yield z   # perhaps used in conjunction with #block_given?
end
x(3) {|y| y*y}  # => 9

または、おそらく Proc ;に変換されますここでは、&blockで暗黙的にProcに変換された「ブロック」が、単なる「呼び出し可能な」値であることを示しています。

def x(z, &block)
  callback = block
  callback.call(z)
end

# look familiar?
x(4) {|y| y * y} # => 16

（上記のフォームは、後で使用するために、またはオーバーヘッドと構文ノイズを追加する他の特別な場合に、block-now-Procを保存するためにのみ使用してください。）

ただし、ラムダは同じくらい簡単に使用できます（ただし、これは慣用的ではありません）。

def x(z,fn)
  fn.call(z)
end

# just use a lambda (closure)
x(5, lambda {|y| y * y}) # => 25

上記のアプローチはすべてwrapクロージャを作成するときに「メソッドを呼び出す」ことができますが、バウンド Methods を最初として扱うこともできますクラスの呼び出し可能オブジェクト：

class A
  def b(z)
    z*z
  end
end

callable = A.new.method(:b)
callable.call(6) # => 36

# and since it's just a value...
def x(z,fn)
  fn.call(z)
end
x(7, callable) # => 49

さらに、#sendメソッドを使用すると便利な場合があります（特に、メソッドが名前で知られている場合）。ここでは、最後の例で作成された中間のMethodオブジェクトを保存します。 Rubyはメッセージパッシングシステムです：

# Using A from previous
def x(z, a):
  a.__send__(:b, z)
end
x(8, A.new) # => 64

ハッピーコーディング！

77
user166390

トピックをもう少し詳しく調べ、コードを更新しました。

次のバージョンは、非常に単純化された不完全なままですが、テクニックを一般化する試みです。

私は主に、DataMapperのコールバックの実装を盗みました。

コード@ http://github.com/datamapper/dm-core/blob/master/lib/dm-core/support/hook.rb をご覧になることを強くお勧めします。

とにかく、Observableモジュールを使用して機能を再現しようとすることは、非常に魅力的で有益でした。いくつかのメモ：

  • 追加されたメソッドは、元のインスタンスメソッドがコールバックを登録する時点で利用できないため、必要と思われます
  • インクルードクラスは、観察と自己観察の両方が行われます
  • この例はインスタンスメソッドに限定されており、ブロックや引数などをサポートしていません

コード：

require 'observer'

module SuperSimpleCallbacks
  include Observable

  def self.included(klass)
    klass.extend ClassMethods
    klass.initialize_included_features
  end

  # the observed is made also observer
  def initialize
    add_observer(self)
  end

  # TODO: dry
  def update(method_name, callback_type) # hook for the observer
    case callback_type
    when :before then self.class.callbacks[:before][method_name.to_sym].each{|callback| send callback}
    when :after then self.class.callbacks[:after][method_name.to_sym].each{|callback| send callback}
    end
  end

  module ClassMethods
    def initialize_included_features
      @callbacks = Hash.new
      @callbacks[:before] = Hash.new{|h,k| h[k] = []}
      @callbacks[:after] = @callbacks[:before].clone
      class << self
        attr_accessor :callbacks
      end
    end

    def method_added(method)
      redefine_method(method) if is_a_callback?(method)
    end

    def is_a_callback?(method)
      registered_methods.include?(method)
    end

    def registered_methods
      callbacks.values.map(&:keys).flatten.uniq
    end

    def store_callbacks(type, method_name, *callback_methods)
      callbacks[type.to_sym][method_name.to_sym] += callback_methods.flatten.map(&:to_sym)
    end

    def before(original_method, *callbacks)
      store_callbacks(:before, original_method, *callbacks)
    end

    def after(original_method, *callbacks)
      store_callbacks(:after, original_method, *callbacks)
    end

    def objectify_and_remove_method(method)
      if method_defined?(method.to_sym)
        original = instance_method(method.to_sym)
        remove_method(method.to_sym)
        original
      else
        nil
      end
    end

    def redefine_method(original_method)
      original = objectify_and_remove_method(original_method)
      mod = Module.new
      mod.class_eval do
        define_method(original_method.to_sym) do
          changed; notify_observers(original_method, :before)
          original.bind(self).call if original
          changed; notify_observers(original_method, :after)
        end
      end
      include mod
    end
  end
end


class MyObservedHouse
  include SuperSimpleCallbacks

  before :party, [:walk_dinosaure, :prepare, :just_idle]
  after :party, [:just_idle, :keep_house, :walk_dinosaure]

  before :home_office, [:just_idle, :prepare, :just_idle]
  after :home_office, [:just_idle, :walk_dinosaure, :just_idle]

  before :second_level, [:party]

  def home_office
    puts "learning and working with Ruby...".upcase
  end

  def party
    puts "having party...".upcase
  end

  def just_idle
    puts "...."
  end

  def prepare
    puts "preparing snacks..."
  end

  def keep_house
    puts "house keeping..."
  end

  def walk_dinosaure
    puts "walking the dinosaure..."
  end

  def second_level
    puts "second level..."
  end
end

MyObservedHouse.new.tap do |house|
  puts "-------------------------"
  puts "-- about calling party --"
  puts "-------------------------"

  house.party

  puts "-------------------------------"
  puts "-- about calling home_office --"
  puts "-------------------------------"

  house.home_office

  puts "--------------------------------"
  puts "-- about calling second_level --"
  puts "--------------------------------"

  house.second_level
end
# => ...
# -------------------------
# -- about calling party --
# -------------------------
# walking the dinosaure...
# preparing snacks...
# ....
# HAVING PARTY...
# ....
# house keeping...
# walking the dinosaure...
# -------------------------------
# -- about calling home_office --
# -------------------------------
# ....
# preparing snacks...
# ....
# LEARNING AND WORKING WITH Ruby...
# ....
# walking the dinosaure...
# ....
# --------------------------------
# -- about calling second_level --
# --------------------------------
# walking the dinosaure...
# preparing snacks...
# ....
# HAVING PARTY...
# ....
# house keeping...
# walking the dinosaure...
# second level...

Observableの使用に関するこの簡単なプレゼンテーションは便利です： http://www.oreillynet.com/Ruby/blog/2006/01/Ruby_design_patterns_observer.html

6
LucaB

だから、これはとても「un-Ruby」かもしれませんし、私は「プロ」ではありませんRuby開発者、だからあなたがやるつもりなら、優しくしてください:)

RubyにはObserverと呼ばれる組み込みのモジュールがあります。使いやすいとは思いませんが、公平を期すために、あまりチャンスを与えませんでした。私のプロジェクトでは、独自のEventHandlerタイプを作成することに頼っています（はい、C＃をよく使用しています）。基本的な構造は次のとおりです。

class EventHandler

  def initialize
    @client_map = {}
  end

  def add_listener(id, func)
    (@client_map[id.hash] ||= []) << func
  end

  def remove_listener(id)
    return @client_map.delete(id.hash)
  end

  def alert_listeners(*args)
    @client_map.each_value { |v| v.each { |func| func.call(*args) } }
  end

end

したがって、これを使用するには、クラスの読み取り専用メンバーとして公開します。

class Foo

  attr_reader :some_value_changed

  def initialize
    @some_value_changed = EventHandler.new
  end

end

「Foo」クラスのクライアントは、次のようなイベントにサブスクライブできます。

foo.some_value_changed.add_listener(self, lambda { some_func })

これはイディオムではないはずですRubyそして、私はC＃の経験を新しい言語に靴磨きしているだけですが、うまくいきました。

3
Ed S.

ActiveSupport （Railsから）を使用する場合は、簡単な実装ができます。

class ObjectWithCallbackHooks
  include ActiveSupport::Callbacks
  define_callbacks :initialize # Your object supprots an :initialize callback chain

  include ObjectWithCallbackHooks::Plugin 

  def initialize(*)
    run_callbacks(:initialize) do # run `before` callbacks for :initialize
      puts "- initializing" # then run the content of the block
    end # then after_callbacks are ran
  end
end

module ObjectWithCallbackHooks::Plugin
  include ActiveSupport::Concern

  included do 
    # This plugin injects an "after_initialize" callback 
    set_callback :initialize, :after, :initialize_some_plugin
  end
end
1
Cyril Duchon-Doris

私はこれが古い投稿であることを知っていますが、これに出くわした他の人は私の解決策が役立つと思うかもしれません。

http://chrisshepherddev.blogspot.com/2015/02/callbacks-in-pure-Ruby-prepend-over.html

0
Chris Shepherd

次の例のように、コールバックを頻繁にRubyで実装します。非常に使いやすいです。

class Foo
   # Declare a callback.
   def initialize
     callback( :on_die_cast )
   end

   # Do some stuff.
   # The callback event :on_die_cast is triggered.
   # The variable "die" is passed to the callback block.
   def run
      while( true )
         die = 1 + Rand( 6 )
         on_die_cast( die )
         sleep( die )
      end
   end

   # A method to define callback methods.
   # When the latter is called with a block, it's saved into a instance variable.
   # Else a saved code block is executed.
   def callback( *names )
      names.each do |name|
         eval <<-EOF
            @#{name} = false
            def #{name}( *args, &block )
               if( block )
                  @#{name} = block
               elsif( @#{name} )
                  @#{name}.call( *args )
               end
            end
         EOF
      end
   end
end

foo = Foo.new

# What should be done when the callback event is triggered?
foo.on_die_cast do |number|
   puts( number )
end

foo.run
0
henning