Як реалізувати “зворотний виклик” у Ruby?

76

Я не впевнений, що найкраща ідіома для зворотних дзвінків у стилі C в Ruby - чи є щось ще краще (і менш схоже на C). У C я б зробив щось на зразок:

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

Що таке хороший еквівалент Ruby? По суті, я хочу викликати метод переданого в класі, коли певна умова виконується в "DoStuff"

ruby  callback 
— Юстикул
джерело
Це може бути корисно: github.com/krisleech/wisper
— Kris

Відповіді:

97

Рубіновим еквівалентом, який не є ідіоматичним, буде:

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

Ідіоматичним підходом буде передача блоку замість посилання на метод. Однією з переваг блоку перед окремо стоячим методом є контекст - блок є закриттям , тому він може посилатися на змінні з тієї області, в якій він був оголошений. Це зменшує кількість параметрів, які 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
— dstnbrkr
джерело
17
Якщо ви використовуєте yield, вам не потрібно & блокувати в списку аргументів.
— Дуглас
41
Мені все ще подобається використовувати &blockпозначення, оскільки тоді стає зрозумілим, що метод приймає блок, просто переглядаючи перший рядок визначення.
— Patrick Oscity
погодитись із коментарем @Douglas; блок & отримав мене всього дивного :(
— gabriel-kaam
80

Цей "ідіоматичний блок" є основною частиною повсякденного Ruby і часто висвітлюється в книгах та навчальних посібниках. Інформаційний розділ рубіна містить посилання на корисні [онлайн] навчальних ресурси.

Ідіоматичним способом є використання блоку:

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

Або, можливо, перетворений на Proc ; тут я показую, що "блок", перетворений у Proc неявно за допомогою &block, - це просто ще одне "викликається" значення:

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

Хоча вищезазначені підходи можуть обертати "виклик методу", оскільки вони створюють закриття, зв'язані методи також можна розглядати як першокласні об'єкти, що викликаються:

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

Щасливого кодування!

— Громада
джерело
6

Ще трохи вивчив тему та оновив код.

Наступна версія - це спроба узагальнити техніку, хоча вона залишається надзвичайно спрощеною та неповною.

Я в основному вкрав - хем, знайшов натхнення - в реалізації зворотних викликів 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

— LucaB
джерело
Сподіваюсь, ви не проти, але я скорував ваш код і трохи переробив його для свого поточного проекту. На даний момент це спрощено, але ось - сміливо критикуйте / шлакуйте
— Дейв Сімс,
Одне питання, з яким я працював із цим - чому ви скористалися Observable? У мене було зіткнення імені методу з класом, з яким мені потрібно було інтегрувати, і просто виклик методу екземпляра (trigger_callbacks) працював нормально.
— Дейв Сімс,
3

Отже, це може бути дуже "не-рубіновим", і я не "професійний" розробник Ruby, тому, якщо ви, хлопці, будете цмокати, будьте ласкаві, будь ласка :)

Ruby має вбудований модуль int під назвою 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 # на нову мову, але це спрацювало для мене.

— Ед С.
джерело
1

Якщо ви бажаєте використовувати 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
— Кирило Дюшон-Доріс
джерело
0

Я часто реалізую зворотні виклики в 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
— курки
джерело
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.