跳至内容 跳至搜索

当前属性

提供线程隔离属性单例的抽象超类，它会在每次请求之前和之后自动重置。这使您可以轻松地将所有每个请求属性提供给整个系统。

以下完整的应用程序示例演示了如何使用 Current 类来方便地访问全局的每个请求属性，而无需将它们深度地传递到任何地方

# app/models/current.rb
class Current < ActiveSupport::CurrentAttributes
  attribute :account, :user
  attribute :request_id, :user_agent, :ip_address

  resets { Time.zone = nil }

  def user=(user)
    super
    self.account = user.account
    Time.zone    = user.time_zone
  end
end

# app/controllers/concerns/authentication.rb
module Authentication
  extend ActiveSupport::Concern

  included do
    before_action :authenticate
  end

  private
    def authenticate
      if authenticated_user = User.find_by(id: cookies.encrypted[:user_id])
        Current.user = authenticated_user
      else
        redirect_to new_session_url
      end
    end
end

# app/controllers/concerns/set_current_request_details.rb
module SetCurrentRequestDetails
  extend ActiveSupport::Concern

  included do
    before_action do
      Current.request_id = request.uuid
      Current.user_agent = request.user_agent
      Current.ip_address = request.ip
    end
  end
end

class ApplicationController < ActionController::Base
  include Authentication
  include SetCurrentRequestDetails
end

class MessagesController < ApplicationController
  def create
    Current.account.messages.create(message_params)
  end
end

class Message < ApplicationRecord
  belongs_to :creator, default: -> { Current.user }
  after_create { |message| Event.create(record: message) }
end

class Event < ApplicationRecord
  before_create do
    self.request_id = Current.request_id
    self.user_agent = Current.user_agent
    self.ip_address = Current.ip_address
  end
end

注意：过度使用像 Current 这样的全局单例很容易导致模型变得混乱。Current 应该只用于几个顶级的全局变量，例如帐户、用户和请求详细信息。Current 中的属性应该被几乎所有请求中的所有操作使用。如果你开始把控制器特定的属性放在里面，你将会制造混乱。

方法
A
B
I
N
R
S
包含的模块

属性

[RW] attributes

类公共方法

after_reset(*methods, &block)

别名：resets

attribute(*names, default: NOT_SET)

声明一个或多个属性，这些属性将被赋予类和实例访问器方法。

选项

  • :default - 属性的默认值。如果值

是 proc 或 lambda，则在构建实例时将调用它。否则，将使用 #dup 复制该值。默认值在属性重置时重新分配。

来源：显示 | 在 GitHub 上

# File activesupport/lib/active_support/current_attributes.rb, line 114
def attribute(*names, default: NOT_SET)
  invalid_attribute_names = names.map(&:to_sym) & INVALID_ATTRIBUTE_NAMES
  if invalid_attribute_names.any?
    raise ArgumentError, "Restricted attribute names: #{invalid_attribute_names.join(", ")}"
  end

  ActiveSupport::CodeGenerator.batch(generated_attribute_methods, __FILE__, __LINE__) do |owner|
    names.each do |name|
      owner.define_cached_method(name, namespace: :current_attributes) do |batch|
        batch <<
          "def #{name}" <<
          "attributes[:#{name}]" <<
          "end"
      end
      owner.define_cached_method("#{name}=", namespace: :current_attributes) do |batch|
        batch <<
          "def #{name}=(value)" <<
          "attributes[:#{name}] = value" <<
          "end"
      end
    end
  end

  Delegation.generate(singleton_class, names, to: :instance, nilable: false, signature: "")
  Delegation.generate(singleton_class, names.map { |n| "#{n}=" }, to: :instance, nilable: false, signature: "value")

  self.defaults = defaults.merge(names.index_with { default })
end

before_reset(*methods, &block)

在 reset 被调用到实例上之前调用此回调。用于重置依赖于当前值的外部协作者。

来源：显示 | 在 GitHub 上

# File activesupport/lib/active_support/current_attributes.rb, line 144
def before_reset(*methods, &block)
  set_callback :reset, :before, *methods, &block
end

instance()

返回此类在此线程中的单例实例。如果不存在，则创建一个。

来源：显示 | 在 GitHub 上

# File activesupport/lib/active_support/current_attributes.rb, line 102
def instance
  current_instances[current_instances_key] ||= new
end

new()

来源：显示 | 在 GitHub 上

# File activesupport/lib/active_support/current_attributes.rb, line 199
def initialize
  @attributes = resolve_defaults
end

resets(*methods, &block)

在 reset 被调用到实例上之后调用此回调。用于重置外部协作者，例如 Time.zone.

也称为别名：after_reset

来源：显示 | 在 GitHub 上

# File activesupport/lib/active_support/current_attributes.rb, line 149
def resets(*methods, &block)
  set_callback :reset, :after, *methods, &block
end

实例公共方法

reset()

重置所有属性。当用作每个请求单例时，应该在操作之前和之后调用它。

来源：显示 | 在 GitHub 上

# File activesupport/lib/active_support/current_attributes.rb, line 218
def reset
  run_callbacks :reset do
    self.attributes = resolve_defaults
  end
end

set(attributes, &block)

在一个块内公开一个或多个属性。块结束后会返回旧值。示例演示了在请求周期之外设置 Current 属性的常见用法

class Chat::PublicationJob < ApplicationJob
  def perform(attributes, room_number, creator)
    Current.set(person: creator) do
      Chat::Publisher.publish(attributes: attributes, room_number: room_number)
    end
  end
end

来源：显示 | 在 GitHub 上

# File activesupport/lib/active_support/current_attributes.rb, line 213
def set(attributes, &block)
  with(**attributes, &block)
end