Active Model 验证器
一个简单的基类,可与 ActiveModel::Validations::ClassMethods.validates_with
一起使用
class Person
include ActiveModel::Validations
validates_with MyValidator
end
class MyValidator < ActiveModel::Validator
def validate(record)
if some_complex_logic
record.errors.add(:base, "This record is invalid")
end
end
private
def some_complex_logic
# ...
end
end
任何继承自 ActiveModel::Validator 的类都必须实现一个名为 validate
的方法,该方法接受一个 record
。
class Person
include ActiveModel::Validations
validates_with MyValidator
end
class MyValidator < ActiveModel::Validator
def validate(record)
record # => The person instance being validated
options # => Any non-standard options passed to validates_with
end
end
要引发验证错误,您必须直接在验证器消息中将错误添加到 record
的错误中。
class MyValidator < ActiveModel::Validator
def validate(record)
record.errors.add :base, "This is some custom error message"
record.errors.add :first_name, "This is some complex validation"
# etc...
end
end
要向 initialize 方法添加行为,请使用以下签名
class MyValidator < ActiveModel::Validator
def initialize(options)
super
@my_custom_field = options[:field_name] || :first_name
end
end
请注意,验证器仅在整个应用程序生命周期中初始化一次,而不是在每次验证运行时初始化。
添加用于验证单个属性的自定义验证器的最简单方法是使用方便的 ActiveModel::EachValidator
类。
class TitleValidator < ActiveModel::EachValidator
def validate_each(record, attribute, value)
record.errors.add attribute, 'must be Mr., Mrs., or Dr.' unless %w(Mr. Mrs. Dr.).include?(value)
end
end
现在可以将其与 validates
方法结合使用。有关更多信息,请参阅 ActiveModel::Validations::ClassMethods#validates
。
class Person
include ActiveModel::Validations
attr_accessor :title
validates :title, presence: true, title: true
end
当存在先决条件(例如 attr_accessor
存在)时,访问使用该验证器的类可能很有用。此类可以通过构造函数中的 options[:class]
访问。要设置您的验证器,请覆盖构造函数。
class MyValidator < ActiveModel::Validator
def initialize(options={})
super
options[:class].attr_accessor :custom_attribute
end
end
方法
属性
[R] | options |
类公共方法
kind() 链接
返回验证器的类型。
PresenceValidator.kind # => :presence
AcceptanceValidator.kind # => :acceptance
来源: 显示 | 在 GitHub 上
# File activemodel/lib/active_model/validator.rb, line 103 def self.kind @kind ||= name.split("::").last.underscore.chomp("_validator").to_sym unless anonymous? end
new(options = {}) 链接
接受将通过 options
阅读器提供给您的选项。
来源: 显示 | 在 GitHub 上
# File activemodel/lib/active_model/validator.rb, line 108 def initialize(options = {}) @options = options.except(:class).freeze end
实例公共方法
kind() 链接
返回此验证器的类型。
PresenceValidator.new(attributes: [:username]).kind # => :presence
AcceptanceValidator.new(attributes: [:terms]).kind # => :acceptance
来源: 显示 | 在 GitHub 上
# File activemodel/lib/active_model/validator.rb, line 116 def kind self.class.kind end
validate(record) 链接
在子类中用验证逻辑覆盖此方法,并在必要时将错误添加到记录的 errors
数组中。
来源: 显示 | 在 GitHub 上
# File activemodel/lib/active_model/validator.rb, line 122 def validate(record) raise NotImplementedError, "Subclasses must implement a validate(record) method." end