跳至内容 跳至搜索

Active Support Subscriber ↑

ActiveSupport::Subscriber 是一个用于消费 ActiveSupport::Notifications 的对象。订阅者根据给定的命名空间将通知分派给已注册的对象。

例如，一个 Active Record 订阅者负责收集有关查询的统计信息。

module ActiveRecord
  class StatsSubscriber < ActiveSupport::Subscriber
    attach_to :active_record

    def sql(event)
      Statsd.timing("sql.#{event.payload[:name]}", event.duration)
    end
  end
end

配置完成后，每当发布 "sql.active_record" 通知时，它都会将事件（ActiveSupport::Notifications::Event）正确地分派到 sql 方法。

我们也可以取消订阅者

ActiveRecord::StatsSubscriber.detach_from(:active_record)
方法
A
C
D
M
N
R
S

类公共方法

attach_to(namespace, subscriber = new, notifier = ActiveSupport::Notifications, inherit_all: false)

将订阅者附加到命名空间。

来源: 显示 | 在 GitHub 上

# File activesupport/lib/active_support/subscriber.rb, line 35
def attach_to(namespace, subscriber = new, notifier = ActiveSupport::Notifications, inherit_all: false)
  @namespace  = namespace
  @subscriber = subscriber
  @notifier   = notifier
  @inherit_all = inherit_all

  subscribers << subscriber

  # Add event subscribers for all existing methods on the class.
  fetch_public_methods(subscriber, inherit_all).each do |event|
    add_event_subscriber(event)
  end
end

detach_from(namespace, notifier = ActiveSupport::Notifications)

将订阅者从命名空间分离。

来源: 显示 | 在 GitHub 上

# File activesupport/lib/active_support/subscriber.rb, line 50
def detach_from(namespace, notifier = ActiveSupport::Notifications)
  @namespace  = namespace
  @subscriber = find_attached_subscriber
  @notifier   = notifier

  return unless subscriber

  subscribers.delete(subscriber)

  # Remove event subscribers of all existing methods on the class.
  fetch_public_methods(subscriber, true).each do |event|
    remove_event_subscriber(event)
  end

  # Reset notifier so that event subscribers will not add for new methods added to the class.
  @notifier = nil
end

method_added(event)

为类中添加的所有新方法添加事件订阅者。

来源: 显示 | 在 GitHub 上

# File activesupport/lib/active_support/subscriber.rb, line 69
def method_added(event)
  super
  # Only public methods are added as subscribers, and only if a notifier
  # has been set up. This means that subscribers will only be set up for
  # classes that call #attach_to.
  if public_method_defined?(event) && notifier
    add_event_subscriber(event)
  end
end

new()

来源: 显示 | 在 GitHub 上

# File activesupport/lib/active_support/subscriber.rb, line 131
def initialize
  @patterns  = {}
  super
end

subscribers()

来源: 显示 | 在 GitHub 上

# File activesupport/lib/active_support/subscriber.rb, line 79
def subscribers
  @@subscribers ||= []
end

类私有方法

add_event_subscriber(event)

来源: 显示 | 在 GitHub 上

# File activesupport/lib/active_support/subscriber.rb, line 86
def add_event_subscriber(event) # :doc:
  return if invalid_event?(event)

  pattern = prepare_pattern(event)

  # Don't add multiple subscribers (e.g. if methods are redefined).
  return if pattern_subscribed?(pattern)

  subscriber.patterns[pattern] = notifier.subscribe(pattern, subscriber)
end

remove_event_subscriber(event)

来源: 显示 | 在 GitHub 上

# File activesupport/lib/active_support/subscriber.rb, line 97
def remove_event_subscriber(event) # :doc:
  return if invalid_event?(event)

  pattern = prepare_pattern(event)

  return unless pattern_subscribed?(pattern)

  notifier.unsubscribe(subscriber.patterns[pattern])
  subscriber.patterns.delete(pattern)
end

实例公共方法

call(event)

来源: 显示 | 在 GitHub 上

# File activesupport/lib/active_support/subscriber.rb, line 136
def call(event)
  method = event.name[0, event.name.index(".")]
  send(method, event)
end