跳至内容 跳至搜索

Active Model 属性方法

提供了一种方法来为您的方法添加前缀和后缀，以及处理 ActiveRecord::Base 等类方法的创建，如 table_name。

实现 ActiveModel::AttributeMethods 的要求是

  • 在您的类中 include ActiveModel::AttributeMethods。

  • 调用您要添加的每个方法，例如 attribute_method_suffix 或 attribute_method_prefix。

  • 在调用其他方法后调用 define_attribute_methods。

  • 定义您已声明的各种通用 _attribute 方法。

  • 定义一个 attributes 方法，该方法返回一个哈希，其中您的模型中的每个属性名称作为哈希键，属性值作为哈希值。Hash 键必须是字符串。

一个最小实现可能是

class Person
  include ActiveModel::AttributeMethods

  attribute_method_affix  prefix: 'reset_', suffix: '_to_default!'
  attribute_method_suffix '_contrived?'
  attribute_method_prefix 'clear_'
  define_attribute_methods :name

  attr_accessor :name

  def attributes
    { 'name' => @name }
  end

  private
    def attribute_contrived?(attr)
      true
    end

    def clear_attribute(attr)
      send("#{attr}=", nil)
    end

    def reset_attribute_to_default!(attr)
      send("#{attr}=", 'Default Name')
    end
end
命名空间
方法
A
M
R

常量

CALL_COMPILABLE_REGEXP = /\A[a-zA-Z_]\w*[!?]?\z/
 
NAME_COMPILABLE_REGEXP = /\A[a-zA-Z_]\w*[!?=]?\z/
 

实例公共方法

attribute_missing(match, ...)

attribute_missing 类似于 method_missing，但用于属性。当调用 method_missing 时，我们会检查是否存在匹配的属性方法。如果是，我们会告诉 attribute_missing 派遣属性。此方法可以被重载以自定义行为。

来源：显示 | 在 GitHub 上

# File activemodel/lib/active_model/attribute_methods.rb, line 520
def attribute_missing(match, ...)
  __send__(match.proxy_target, match.attr_name, ...)
end

method_missing(method, ...)

允许访问对象属性，这些属性保存在 attributes 返回的哈希中，就像它们是一流方法一样。因此，具有 name 属性的 Person 类可以例如使用 Person#name 和 Person#name= 并且从不直接使用属性哈希 - 除了使用 ActiveRecord::Base#attributes= 进行多个赋值。

还可以实例化相关对象，因此属于 clients 表且具有 master_id 外键的 Client 类可以通过 Client#master 实例化 master。

来源：显示 | 在 GitHub 上

# File activemodel/lib/active_model/attribute_methods.rb, line 507
def method_missing(method, ...)
  if respond_to_without_attributes?(method, true)
    super
  else
    match = matched_attribute_method(method.name)
    match ? attribute_missing(match, ...) : super
  end
end

respond_to?(method, include_private_methods = false)

也称为：respond_to_without_attributes?

来源：显示 | 在 GitHub 上

# File activemodel/lib/active_model/attribute_methods.rb, line 528
def respond_to?(method, include_private_methods = false)
  if super
    true
  elsif !include_private_methods && super(method, true)
    # If we're here then we haven't found among non-private methods
    # but found among all methods. Which means that the given method is private.
    false
  else
    !matched_attribute_method(method.to_s).nil?
  end
end

respond_to_without_attributes?(method, include_private_methods = false)

具有 name 属性的 Person 实例可以询问 person.respond_to?(:name)、person.respond_to?(:name=) 和 person.respond_to?(:name?)，它们都将返回 true。

别名：respond_to?