rails 指南总结（三）——Model之Active Record 数据验证

1.概览

1. 为什么要做数据验证？

数据验证确保只有有效的数据才能存入数据库。

1.2会触发数据验证的方法

• create
• create!
• save
• save!
• update
• update!

爆炸方法（例如 save!）会在验证失败后抛出异常。
非爆炸方法不会抛出异常，save 和 update 返回 false，create 返回对象本身。

1.3会跳过数据验证的方法

• decrement!
• decrement_counter
• increment!
• increment_counter
• toggle!
• touch
• update_all
• update_attribute
• update_column
• update_columns
• update_counters

使用 save 时如果传入 validate: false 参数，也会跳过验证。save(validate: false)

1.4 valid? 和 invalid?

• valid? 方法会触发数据验证，如果对象上没有错误，返回 true，否则返回 false。
• invalid? 的作用与 valid? 相反，它会触发数据验证，如果找到错误就返回 true，否则返回 false。

Active Record 执行验证后，所有发现的错误都可以通过实例方法 errors.messages 获取。该方法返回一个错误集合。如果数据验证后，这个集合为空，说明对象是有效的

class Person < ApplicationRecord
  validates :name, presence: true
end
 
>> p = Person.new
# => #<Person id: nil, name: nil>
>> p.errors.messages
# => {}
 
>> p.valid?
# => false
>> p.errors.messages
# => {name:["can't be blank"]}

注：注意，使用 new 方法初始化对象时，即使无效也不会报错，因为只有保存对象时才会验证数据，例如调用 create 或 save 方法。

2 数据验证辅助方法

2.1 acceptance

• 这个方法检查表单提交时，用户界面中的复选框是否被选中。

  validates :terms_of_service, acceptance: true

• 这个辅助方法的默认错误消息是“must be accepted”。通过 message 选项可以传入自定义的消息。

validates :terms_of_service, acceptance: { message: 'must be abided' }

• 这个辅助方法还接受 :accept 选项，指定把哪些值视作“接受”。默认为 [‘1’, true]，不过可以轻易修改

  validates :terms_of_service, acceptance: { accept: ['TRUE', 'accepted'] }

这种验证只针对 Web 应用，接受与否无需存入数据库。
如果没有对应的字段，该方法会创建一个虚拟属性。
如果数据库中有对应的字段，必须把 accept 选项的值设为或包含 true，否则验证不会执行。

2.2 validates_associated

如果模型和其他模型有关联，而且关联的模型也要验证，要使用这个辅助方法。保存对象时，会在相关联的每个对象上调用 valid? 方法。

2.3 confirmation

• 检查两个文本字段的值是否完全相同,例如，确认电子邮件地址或密码。这个验证创建一个虚拟属性，其名字为要验证的属性名后加 _confirmation

class Person < ApplicationRecord
 validates :email, confirmation: true
 validates :email_confirmation, presence: true
end 

• 只有 email_confirmation 的值不是 nil 时才会检查。所以要为确认属性加上存在性验证

在视图模板中可以这么写：

<%= text_field :person, :email %>
<%= text_field :person, :email_confirmation %>

还可以使用 :case_sensitive 选项指定确认时是否区分大小写。这个选项的默认值是 true。

  validates :email, confirmation: { case_sensitive: false }

2.4 inclusion

这个辅助方法检查属性的值是否在指定的集合中。集合可以是任何一种可枚举的对象。

  validates :size, inclusion: { in: %w(small medium large),

2.5 exclusion

这个辅助方法检查属性的值是否不在指定的集合中。集合可以是任何一种可枚举的对象。

  validates :subdomain, exclusion: { in: %w(www us ca jp),

2.6 format

这个辅助方法检查属性的值是否匹配 :with 选项指定的正则表达式。

  validates :legacy_code, format: { with: /\A[a-zA-Z]+\z/,

2.7 length

这个辅助方法验证属性值的长度，有多个选项，可以使用不同的方法指定长度约束：

• :minimum：属性的值不能比指定的长度短；
• :maximum：属性的值不能比指定的长度长；
• :in（或 :within）：属性值的长度在指定的范围内。该选项的值必须是一个范围；
• :is：属性值的长度必须等于指定值；

 validates :name, length: { minimum: 2 }
  validates :bio, length: { maximum: 500 }
  validates :password, length: { in: 6..20 }
  validates :registration_number, length: { is: 6 }

2.8 numericality

这个辅助方法检查属性的值是否只包含数字。

 validates :points, numericality: true
 validates :games_played, numericality: { only_integer: true }

除了 :only_integer 之外，这个方法还可指定以下选项，限制可接受的值：

• :greater_than：属性值必须比指定的值大。
• :greater_than_or_equal_to：属性值必须大于或等于指定的值。
• :equal_to：属性值必须等于指定的值。
• :less_than：属性值必须比指定的值小。
• :less_than_or_equal_to：属性值必须小于或等于指定的值。
• :other_than：属性值必须与指定的值不同。
• :odd：如果设为 true，属性值必须是奇数。 :even：如果设为 true，属性值必须是偶数。

numericality 默认不接受 nil 值。可以使用 allow_nil: true 选项允许接受 nil。

2.9 presence

这个辅助方法检查指定的属性是否为非空值。它调用 blank? 方法检查值是否为 nil 或空字符串，即空字符串或只包含空白的字符串。

• 为了能验证关联的对象是否存在，要在关联中指定 :inverse_of 选项。

  has_many :line_items, inverse_of: :order

如果要验证布尔值字段是否存在，要使用下述验证中的一个：

validates :boolean_field_name, inclusion: { in: [true, false] }
validates :boolean_field_name, exclusion: { in: [nil] }

2.10 absence

这个辅助方法验证指定的属性值是否为空。与presence相反

2.11 uniqueness

• 这个辅助方法在保存对象之前验证属性值是否是唯一的。这个验证会在模型对应的表中执行一个 SQL 查询，检查现有的记录中该字段是否已经出现过相同的值。
• 该方法不会在数据库中创建唯一性约束，所以有可能两次数据库连接创建的记录具有相同的字段值。为了避免出现这种问题，必须在数据库的字段上建立唯一性索引。
  :scope 选项用于指定检查唯一性时使用的一个或多个属性：

 validates :name, uniqueness: { scope: :year,
    message: "should happen once per year" }

2.12 validates_with

这个辅助方法把记录交给其他类做验证。

2.13 validates_each

这个辅助方法使用代码块中的代码验证属性。它没有预先定义验证函数，你要在代码块中定义验证方式。要验证的每个属性都会传入块中做验证。

3 常用的验证选项

• allow_nil 如果要验证的值为 nil 就跳过验证。
• allow_blank 如果要验证的值为空（调用 blank? 方法判断，例如 nil 或空字符串），就跳过验证。
• :message 如果验证失败，会把 :message 选项指定的字符串添加到 errors 集合中。如果没指定这个选项，Active Record 使用各个验证辅助方法的默认错误消息。
• :on 选项指定什么时候验证。所有内置的验证辅助方法默认都在保存时（新建记录或更新记录）验证。如果想修改，可以使用 on: :create，指定只在创建记录时验证；

4 严格验证

strict :数据验证还可以使用严格模式，当对象无效时抛出 ActiveModel::StrictValidationFailed 异常。

validates :name, presence: { strict: true }

5 条件验证

只有满足特定条件时做验证,条件可通过 :if 和 :unless 选项指定

5.1 使用符号

:if 和 :unless 选项的值为符号时，表示要在验证之前执行对应的方法。这是最常用的设置方法。

class Order < ApplicationRecord
  validates :card_number, presence: true, if: :paid_with_card?
 
  def paid_with_card?
    payment_type == "card"
  end
end

5.2 使用 Proc

:if and :unless 选项的值还可以是 Proc。使用 Proc 对象可以在行间编写条件，不用定义额外的方法。这种形式最适合用在一行代码能表示的条件上。

 validates :password, confirmation: true, unless: Proc.new { |a| a.password.blank? }

5.3 条件组合

有时，同一个条件会用在多个验证上，这时可以使用 with_options 方法：

class User < ApplicationRecord
  with_options if: :is_admin? do |admin|
    admin.validates :password, length: { minimum: 10 }
    admin.validates :email, presence: true
  end
end

with_options 代码块中的所有验证都会使用 if: :is_admin? 这个条件。

5.4 联合条件

另一方面，如果是否做某个验证要满足多个条件时，可以使用数组。而且，一个验证可以同时指定 :if 和 :unless 选项。

6 自定义验证

自定义的验证类继承自 ActiveModel::Validator，必须实现 validate 方法，其参数是要验证的记录，然后验证这个记录是否有效。自定义的验证类通过 validates_with 方法调用。

7 处理验证错误

7.1 errors

ActiveModel::Errors 的实例包含所有的错误。键是每个属性的名称，值是一个数组，包含错误消息字符串。

person.errors.messages
 # => {:name=>["can't be blank", "is too short (minimum is 3 characters)"]}

7.2 errors[:attribute]

• errors[:attribute] 中包含与 :attribute 有关的所有错误。 返回结果是一个由该属性所有错误消息字符串组成的数组，每个字符串表示一个错误消息。如果某个属性没有错误，就会返回空数组。
• 这个方法只在数据验证之后才能使用，因为它只是用来收集错误信息的，并不会触发验证。

person.errors[:name] # => ["is too short (minimum is 3 characters)"]

7.3 errors.details[:attribute]

查看是哪个验证导致属性无效的，它的返回值是一个由散列组成的数组，:error 键的值是一个符号，指明出错的数据验证。

7.4 errors.add

add 方法用于手动添加某属性的错误消息，它的参数是属性和错误消息。

  def a_method_used_for_validation_purposes
    errors.add(:name, "cannot contain the characters !@#%*()_-+=")
  end

或

 def a_method_used_for_validation_purposes
  errors.messages[:name] << "cannot contain the characters !@#%*()_-+="
end

7.5 errors[:base]

错误消息可以添加到整个对象上，而不是针对某个属性。errors[:base] 是个数组，可以添加字符串作为错误消息。

    errors[:base] << "This person is invalid because ..."

7.6 errors.clear

清除 errors 集合中的所有错误消息

7.7 errors.size

size 方法返回对象上错误消息的总数。

8 在视图中显示验证错误

在模型中加入数据验证后，如果在表单中创建模型，出错时，你或许想把错误消息显示出来。
假如有个模型对象存储在实例变量 @article 中，视图的代码可以这么写：

<% @article.errors.full_messages.each do |msg| %>
      <li><%= msg %></li>
<% end %>