Active Model – Rails 的模型接口

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

您可以在 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
  

  了解更多

• Callbacks 用于某些操作

  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 类方法，这些方法包装您的创建方法。

  了解更多

• 跟踪值更改

  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"]
  

  了解更多

• Model 名称内省

  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
  

  了解更多

下载和安装

可以使用 RubyGems 安装最新版本的 Active Model

$ gem install activemodel

源代码可以作为 GitHub 上 Rails 项目的一部分下载

• github.com/rails/rails/tree/main/activemodel

许可证

Active Model 在 MIT 许可下发布

• opensource.org/licenses/MIT

支持

API 文档位于

• api.rubyonrails.org

Ruby on Rails 项目的错误报告可以在这里提交

• github.com/rails/rails/issues

功能请求应在 rails-core 邮件列表中讨论，这里

• discuss.rubyonrails.org/c/rubyonrails-core