Active Model – Rails 的模型接口¶ ↑

Active Model 提供了一组已知的接口供模型类使用。例如，它们允许 Action Pack 助手与非 Active Record 模型进行交互。Active Model 也有助于构建自定义 ORM 以在 Rails 框架之外使用。

您可以在 Active Model 基础知识指南中了解更多关于 Active Model 的信息。

在 Rails 3.0 之前，如果插件或 gem 的开发者想要让一个对象与 Action Pack 助手进行交互，就必须复制 Rails 中的代码片段，或者对整个助手进行猴子补丁，使其能够处理不完全符合 Active Record 接口的对象。这会导致代码重复和应用程序脆弱，在升级时容易出错。Active Model 通过定义明确的 API 来解决这个问题。您可以在 ActiveModel::Lint::Tests 中阅读有关 API 的更多信息。

Active Model 提供了一个默认模块，该模块实现了开箱即用与 Action Pack 集成所需的基本 API：ActiveModel::API。

class Person
  include ActiveModel::API

  attr_accessor :name, :age
  validates_presence_of :name
end

person = Person.new(name: 'bob', age: '18')
person.name   # => 'bob'
person.age    # => '18'
person.valid? # => true

它包括模型名称内省、转换、翻译和验证，从而生成一个适合与 Action Pack 一起使用的类。更多示例请参见 ActiveModel::API。

Active Model 还提供了以下功能，可实现开箱即用的类 ORM 行为：

为对象添加属性魔法

class Person
  include ActiveModel::AttributeMethods

  attribute_method_prefix 'clear_'
  define_attribute_methods :name, :age

  attr_accessor :name, :age

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

person = Person.new
person.clear_name
person.clear_age

了解更多

某些操作的回调

class Person
  extend ActiveModel::Callbacks
  define_model_callbacks :create

  def create
    run_callbacks :create do
      # Your create action methods here
    end
  end
end

这会生成 before_create、around_create 和 after_create 类方法来包装您的 create 方法。

了解更多

跟踪值变化

class Person
  include ActiveModel::Dirty

  define_attribute_methods :name

  def name
    @name
  end

  def name=(val)
    name_will_change! unless val == @name
    @name = val
  end

  def save
    # do persistence work
    changes_applied
  end
end

person = Person.new
person.name             # => nil
person.changed?         # => false
person.name = 'bob'
person.changed?         # => true
person.changed          # => ['name']
person.changes          # => { 'name' => [nil, 'bob'] }
person.save
person.name = 'robert'
person.save
person.previous_changes # => {'name' => ['bob, 'robert']}

了解更多

为对象添加 errors 接口

公开错误消息允许对象与 Action Pack 助手无缝交互。

class Person

  def initialize
    @errors = ActiveModel::Errors.new(self)
  end

  attr_accessor :name
  attr_reader   :errors

  def validate!
    errors.add(:name, "cannot be nil") if name.nil?
  end

  def self.human_attribute_name(attr, options = {})
    "Name"
  end
end

person = Person.new
person.name = nil
person.validate!
person.errors.full_messages
# => ["Name cannot be nil"]

了解更多

模型名称内省

class NamedPerson
  extend ActiveModel::Naming
end

NamedPerson.model_name.name   # => "NamedPerson"
NamedPerson.model_name.human  # => "Named person"

了解更多

使对象可序列化

ActiveModel::Serialization 提供了一个标准接口，供您的对象提供 to_json 序列化。

class SerialPerson
  include ActiveModel::Serialization

  attr_accessor :name

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

s = SerialPerson.new
s.serializable_hash   # => {"name"=>nil}

class SerialPerson
  include ActiveModel::Serializers::JSON
end

s = SerialPerson.new
s.to_json             # => "{\"name\":null}"

了解更多

国际化 (i18n) 支持

class Person
  extend ActiveModel::Translation
end

Person.human_attribute_name('my_attribute')
# => "My attribute"

了解更多

验证支持

class Person
  include ActiveModel::Validations

  attr_accessor :first_name, :last_name

  validates_each :first_name, :last_name do |record, attr, value|
    record.errors.add attr, "starts with z." if value.start_with?("z")
  end
end

person = Person.new
person.first_name = 'zoolander'
person.valid?  # => false

了解更多

自定义验证器

class HasNameValidator < ActiveModel::Validator
  def validate(record)
    record.errors.add(:name, "must exist") if record.name.blank?
  end
end

class ValidatorPerson
  include ActiveModel::Validations
  validates_with HasNameValidator
  attr_accessor :name
end

p = ValidatorPerson.new
p.valid?                  # =>  false
p.errors.full_messages    # => ["Name must exist"]
p.name = "Bob"
p.valid?                  # =>  true