Active Record Validations and Callbacks

参考链接：http://guides.rubyonrails.org/activerecord_validations_callbacks.html

有许多种在保存数据到数据库之前验证数据有效性的方法，包括数据库原生的约束（constraints）、客户端的验证、Controller级别的验证以及Model级别的验证。

数据库约束：
数据库约束和存储过程使得验证机制依赖于数据库本身，会让测试和维护更加困难。但是如果你的数据库会被其它的应用程序所使用，这时候使用一些数据库级别的约束（constraints）会是个好主意。另外，数据库级别的验证可以安全的处理一些很难用其它方式实现的事件（比如大量使用的表的唯一性(uniqueness in heavily-used tables)）。

客户端验证：
客户端的验证是很有用的，但是只单独使用客户端验证一般是不可靠的。如果验证逻辑是用JavaScript来实现，通过关闭用户浏览器的JavaScript可以很容易的绕过验证程序。但是，如果和其它技术（指Controlelr、Model或者数据库级别的验证技术）结合起来使用，客户端验证会是一种给用户提供即时反馈的很方便的方式。

Controller级别的验证：
Controller级别的验证用起来看似很吸引人，但是经常会变得很难控制、难以测试和维护。只要有可能，保持你的Controllers尽量的“瘦”是个好主意（keep your controllers skinny）。从长远来看，这会给你的程序带来很多好处。

Model级别的验证：
Model级别的验证是确保只有通过验证的数据才能被保到数据库的最好方式。Model级别的验证是不依赖于数据库的，并且是不会被最终用户绕开的，同时也是方便测试和维护的。Rails使得Model级别的验证很容易实现，为常见的需求提供了内置的helper，并且还允许你创建你自己的验证方法。

验证什么时候发生？

Rails中有两种ActiveRecord对象：一种和数据库中的每一条记录相对应，另一种则不是。当你创建一个新的对象的时候，比如调用了某个ActiveRecord类的new方法，创建出来的对象还不存在于数据库中。一旦你调用了这个对象的save方法，它将被保存到数据库对应的表中。ActiveRecord使用new_record?实例方法来判断一个对象是否已经保存到数据库中。

创建和保存一个新的ActiveRecord对象会向数据库发送一条INSERT语句，更新一个ActiveRecord对象会向数据库发送一条UPDATE语句。ActiveRecord的验证是在发送这些SQL语句之前进行的，如果验证不通过，对象将被标记为未通过验证的（invalid），并且INSERT、UPDATE命令不会被执行，从而避免了把这些未通过验证的对象保存到数据库中。

有许多改变数据库中对象的状态的方法，其中一些方法会触发验证，而另一些则不会。这意味着如果不小心的话，把一个未通过验证的对象保存到数据库中是有可能的。

以下这些方法将会触发验证：
create
create!
save
save!
update
update_attributes
update_attributes!

其中带感叹号的方法（比如save!）在验证失败的时候将会抛出一个异常，不带感叹号的则不会：save和update_attributes返回false，create和update只会返回对象本身。

以下方法将会跳过验证，并把对象保存到数据库中，要小心使用：
decrement!
decrement_counter
increment!
increment_counter
toggle!
update_all
update_attribute
update_counters

同时要注意，假如给save方法传一个false参数也可以跳过验证，这个技巧也要小心使用。

valid?和invalid?
Rails使用valid?和invalid?方法来判断一个对象是否通过验证，这两个方法都会触发验证，如果验证通过，valid?返回true，invalid?返回false，否则相反。

可以通过ActiveRecord的实例方法errors来得到验证时发生的任何错误信息的集合（一个hash）。如果验证执行完毕，这个hash仍然是空的，说明这个对象通过验证。

errors.invalid?
errors.invalid?用于检查对象的某个属性是否合法，这个方法只能在对象的验证被触发之后调用，因为它只检查errors这个hash，而不会去触发验证。用法：

errors.invalid? :name #true|false

Validation Helpers

validates_acceptance_of
validates_acceptance_of用于验证表单里的checkbox是否被勾上。需要用户同意一些服务条款是validates_acceptance_of很典型的使用场景。这个“acceptance”不需要被持久化到数据库中（如果没有字段与之对应，helper会创建一个虚拟属性（virtual attribute））。

class Person < ActiveRecord::Base
 validates_acceptance_of :terms_of_service 
end 

validates_acceptance_of默认的错误消息是"must be accepted"，每个Rails内建的验证helper都可以用:message选项来指定错误消息：

validates_acceptance_of :terms_of_service, :message=>'some message'

另外，validates_acceptance_of接受一个:accept选项，这个选项所指定的值用于判断“用户是否接受了服务条款”，如果没有指定，默认的值是字符串"1"。

validates_acceptance_of :terms_of_service, :accept=>'yes', :message=>'some message'

validates_associated
validates_associated用于验证关联的对象（调用valid?）：

class Book < ActiveRecord::Base
  has_one :author
  validates_associated :author 
end

class Author < ActiveRecord::Base
  belongs_to :book
  validates_presence_of :name
end

book = Book.new
book.author = Author.new
book.valid? #false
book.errors.invalid? :author #true
book.author.name = 'somebody'
book.valid? #true

要注意的一点是，别在相关联的两个类中同时使用validates_associated，否则在触发验证的时候会引起无限循环。

validates_confirmation_of
validates_confirmation_of用于检查两个字段的内容是否相同，比如在“用户注册”的时候，可以用它检查“密码”和“确认密码”、“邮箱”和“确认邮箱”的内容是否相同。
这个helper会创建一个虚拟属性，这个虚拟属性的名字以被要求确认的属性名开头，以_confirmation结尾：

class Person < ActiveRecord::Base
 validates_confirmation_of :email 
end 

在view模板里可以这样用：

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

检查只在email_confirmation不为nil的时候执行，所以需要给email_confirmation添加一个validates_presence_of验证，像这样：

class Person < ActiveRecord::Base
 validates_confirmation_of :email
 validates_presence_of :email_confirmation 
end 

validates_exclusion_of
validates_exclusion_of用于保证对象的属性值不在指定的集合中，例如在注册域名的时候，"www"是预留的，不允许用户注册，可以这样：

class Account < ActiveRecord::Base
 validates_exclusion_of :subdomain, :in => %w(www),
 :message => "Subdomain {{value}} is reserved." 
end 

:in选项接受一个集合，这个集合可以是任何可枚举的对象（enumerable object），集合里存放的是那些被排除的值。另外，:in有个别名:within。这里:message的用法展示了如何在消息中包含属性值（{{value}}）。

validates_format_of
validates_format_of用于验证文本的格式，有个:with选项，用来指定要匹配的正则表达式：

class Product < ActiveRecord::Base
 validates_format_of :legacy_code, :with => /\A[a-zA-Z]+\z/,
 :message => "Only letters allowed" 
end 

validates_inclusion_of
validates_inclusion_of用于确保对象的属性值在指定的集合中，例如：

class Coffee < ActiveRecord::Base
 validates_inclusion_of :size, :in => %w(small medium large),
 :message => "{{value}} is not a valid size" 
end 

这样，Coffee的size（……Coffee的size是个什么概念？）只能为"small"、"medium"或者"large"。同样，这里的:in也有一个别名:within。

validates_length_of（别名validates_size_of）
validates_length_of看着简单，用法却很多。用于指定某属性的字符串长度，有多种指定方式，比如最大值、最小值、在某个区间内或者直接指定长度：

class Person < ActiveRecord::Base
 validates_length_of :name, :minimum => 2
 validates_length_of :bio, :maximum => 500
 validates_length_of :password, :in => 6..20
 validates_length_of :registration_number, :is => 6 
end 

:message选项可以用:wrong_length、:too_long、和:too_short来替代。根据情况选择，比如:minimun对应:too_short。在message里可以使用{{count}}作为允许长度的占位符：

class Person < ActiveRecord::Base
 validates_length_of :bio, :maximum => 1000,
 :too_long => "{{count}} characters is the maximum allowed" 
end 

另外，可以使用指定的算法来分割字符串，计算字符串的长度（估计是考虑到双字节字符，例如中文）。:tokenizer用于指定分割算法：

class Essay < ActiveRecord::Base
 validates_length_of :content, :minimum => 300,
 :maximum => 400,
 :tokenizer => lambda { |str| str.scan(/\w+/) },
 :too_short => "must have at least {{count}} words",
 :too_long => "must have at most {{count}} words" 
end 

validates_numericality_of
validates_numericality_of用于验证某属性值是否为数字。它默认允许整数和浮点数，如果你只希望得到一个整数，那么可以设置:only_integer选项的值为true，这样Rails将会使用正则表达式

/\A[+-]?\d+\Z/

来匹配属性值。

class Player < ActiveRecord::Base
 validates_numericality_of :points
 validates_numericality_of :games_played, :only_integer => true
end 

除了:only_integer，validates_numericality_of 还有许多其它选项：

引用

:greater_than – Specifies the value must be greater than the supplied value. The default error message for this option is “must be greater than {{count}}”.
:greater_than_or_equal_to – Specifies the value must be greater than or equal to the supplied value. The default error message for this option is “_must be greater than or equal to {{count}}”.
:equal_to – Specifies the value must be equal to the supplied value. The default error message for this option is “must be equal to {{count}}”.
:less_than – Specifies the value must be less than the supplied value. The default error message for this option is “must be less than {{count}}”.
:less_than_or_equal_to – Specifies the value must be less than or equal the supplied value. The default error message for this option is “must be less or equal to {{count}}”.
:odd – Specifies the value must be an odd number if set to true. The default error message for this option is “must be odd”.
:even – Specifies the value must be an even number if set to true. The default error message for this option is “must be even”.

validates_presence_of
validates_presence_of在前面见过，用于验证“必填”的属性，它会调用对象属性的blank?方法来判断：

class Person < ActiveRecord::Base
 validates_presence_of :name, :login, :email 
end 

由于false.blank?的值是true，如果你想验证某个布尔属性是否被赋值，应当这样做：

validates_inclusion_of :field_name, :in => [true, false]

validates_uniqueness_of
validates_uniqueness_of用来确保某属性的唯一性，比如“用户注册”时的用户名、email等。一般用法：

class Account < ActiveRecord::Base
 validates_uniqueness_of :email
end 

这个验证在触发时会执行一条SQL语句（大概像这样SELECT * FROM accounts WHERE email='[e-mail]'）。
这个helper有一个:scope选项，用于限制查询的范围，比如：

class Holiday < ActiveRecord::Base
 validates_uniqueness_of :name, :scope => :year,
 :message => "should happen once per year" 
end 

还有个:case_sensitive用于指定是否忽略大小写：

class Person < ActiveRecord::Base
 validates_uniqueness_of :name, :case_sensitive => false 
end 

validates_each
这个helper需要靠一个block来验证属性，它没有预定义的函数，但可以使用block创建一个验证规则，所有传递给validates_each的属性都靠这个规则来验证。在下面这个例子中，我们希望name和surname不以小写字母开头：

class Person < ActiveRecord::Base
 validates_each :name, :surname do |model, attr, value|
  model.errors.add(attr, 'must start with upper case') if value =~ /\A[a-z]/
 end 
end 

这里的block接收3个参数，分别是model对象本身、属性名和属性值。

validation helper中常见的选项

:allow_nil 顾名思义。值为true或false。另外，guides上面说：

引用

Using :allow_nil with validates_presence_of allows for nil, but any other blank? value will still be rejected.

但经试验，发现好像并不是这样，:allow_nil=>true在validates_presence_of里好像不起作用。
:allow_blank

class Topic < ActiveRecord::Base
 validates_length_of :title, :is => 5, :allow_blank => true 
end 
Topic.create("title" => "").valid? # => true 
Topic.create("title" => nil).valid? # => true 

:message这里就不用解释了。
:on
:on选项允许设置验证触发的时机。Rails默认触发验证的时机是在保存对象之前（save、create、update）。如果你想改变这一规则，可以使用:on选项，比如:on=>:save会使验证只在save方法被调用之前触发验证。

Conditional Validation

:if和:unless选项
这两个选项用于设置验证触发的条件，值可以是symbol，可以是string，也可以是一个lambda/proc。
当值为symbol时，Rails会在验证触发之前调用symbol对应的方法，再根据返回结果决定是否执行验证；
当值为string时，Rails会在验证触发之前用eval来执行这个string，再根据返回结果决定是否执行验证；
当值为lambda/proc表达式时，Rails会在验证触发之前执行这个表达式，再根据返回结果决定是否执行验证。

自定义验证
当Rails内建的验证规则满足不了你的需求时，可以用validate、validate_on_create或者validate_on_update自定义验证规则。它的参数是一个或多个symbol，这些symbol每个都对应一个方法（同名），这些方法将在验证触发的时候被调用。
另外，甚至可以这样定义自己的validation helper：

ActiveRecord::Base.class_eval do 
 def self.validates_as_radio(attr_name, n, options={})
  validates_inclusion_of attr_name, {:in => 1..n}.merge(options) 
 end 
end 

class Movie < ActiveRecord::Base
 validates_as_radio :rating, 5 
end

Working with Validation Errors

errors.add_to_base
errors.add_to_base用于将error添加到对象上而不是对象的某个具体属性上。使用很简单，只要给它一个string参数作为错误信息。

class Person < ActiveRecord::Base
 def a_method_used_for_validation_purposes
  errors.add_to_base("This person is invalid because ...") 
 end 
end 

errors.add
errors.add用于将error添加到对象某个特定的属性上。可以使用full_messages方法来查看将会显示在页面上的错误信息：

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

person = Person.create(:name => "!@#") 
person.errors.on(:name)  # => "cannot contain the characters !@#%*()_-+=" 
person.errors.full_messages # => ["Name cannot contain the characters !@#%*()_-+="] 

errors.on
errors.on用于检查某个特定属性的错误信息。它根据指定的属性的不同状态返回不同的对象：如果指定的属性没有错误，errors.on返回nil；如果指定的属性有1个错误，errors.on返回这个错误的message（字符串）；如果指定的属性有多个错误，errors.on返回这些错误的message（字符串）数组。

errors.clear
errors.clear用于清除错误信息。

引用

Of course, calling errors.clear upon an invalid object won’t actually make it valid: the errors collection will now be empty, but the next time you call valid? or any method that tries to save this object to the database, the validations will run again. If any of the validations fail, the errors collection will be filled again.

errors.size不用解释。

Displaying Validation Errors in the View
当使用form_for来创建表单的时候，可以使用form builder的error_messaages方法来显示验证错误的结果。

class Product < ActiveRecord::Base
 validates_presence_of :description, :value 
 validates_numericality_of :value, :allow_nil => true 
end 

<% form_for(@product) do |f| %> 
 <%= f.error_messages %>
  <p>
   <%= f.label :description %><br />
   <%= f.text_field :description %>
  </p>
  <p>
   <%= f.label :value %><br />
   <%= f.text_field :value %>
  </p>
  <p>
   <%= f.submit "Create" %>
  </p> 
<% end %> 

也可以使用error_messages_for这个helper来达到同样的效果：

<%= error_messages_for :product %> 

这两个方法都接受3个同样的选项：:header_message， :message和:header_tag。下面是效果对比：

<%= error_messages_for :book %>

<%= error_messages_for :book, :header_message=>'header_message',
		:message=>'message', :header_tag=>'h1'%>

<%= error_messages_for :book, :header_message=>nil,
		:message=>nil, :header_tag=>nil%>

8.2 Customizing the Error Messages CSS
8.3 Customizing the Error Messages HTML 略：
http://guides.rubyonrails.org/activerecord_validations_callbacks.html#customizing-the-error-messages-css

Callback Registration

callbacks的参数可以是对应某个方法的symbol，也可以是一个block。

引用

Here is a list with all the available Active Record callbacks, listed in the same order in which they will get called during the respective operations:
10.1 Creating an Object

    * before_validation
    * before_validation_on_create
    * after_validation
    * after_validation_on_create
    * before_save
    * before_create
    * INSERT OPERATION
    * after_create
    * after_save

10.2 Updating an Object

    * before_validation
    * before_validation_on_update
    * after_validation
    * after_validation_on_update
    * before_save
    * before_update
    * UPDATE OPERATION
    * after_update
    * after_save

10.3 Destroying an Object

    * before_destroy
    * DELETE OPERATION
    * after_destroy

after_save runs both on create and update, but always after the more specific callbacks after_create and after_update, no matter the order in which the macro calls were executed.

另外，after_initialize将在Active Record对象实例化之后被调用。包括调用类方法new或者从数据库中加载对象。
after_find将在Active Record从数据库加载对象之后调用，如果同时定义了after_initialize，after_find将先被调用。
注意，after_initialize和after_find这两个callbacks和其它的有点不同。首先，这两个callbacks没有对应的before_* callbacks。同时，由于性能上的原因，使用它们的唯一方式是将它们定义为一个普通的方法，否则这两个callbacks将被忽略。（This behaviour is due to performance reasons, since after_initialize and after_find will both be called for each record found in the database, significantly slowing down the queries. 说实话，其实看不太明白。。）：

class User < ActiveRecord::Base
 def after_initialize
  puts "You have initialized an object!" 
 end 
 def after_find
  puts "You have found an object!" 
 end 
end 

Running Callbacks

下面的方法将会触发callbacks：
    *  create
    * create!
    * decrement!
    * destroy
    * destroy_all
    * increment!
    * save
    * save!
    * save(false)
    * toggle!
    * update
    * update_attribute
    * update_attributes
    * update_attributes!
    * valid?
after_find callbacks会被以下方法触发：
    * all
    * first
    * find
    * find_all_by_attribute
    * find_by_attribute
    * find_by_attribute!
    * last
以下方法会跳过callbacks：
    *  decrement
    * decrement_counter
    * delete
    * delete_all
    * find_by_sql
    * increment
    * increment_counter
    * toggle
    * update_all
    * update_counters

Conditional Callbacks
同Conditional Validation，只是Conditional Callbacks支持:if和:unless混用。

class Comment < ActiveRecord::Base
 after_create :send_email_to_author, :if => :author_wants_emails?, 
 :unless => Proc.new { |comment| comment.post.ignore_comments? } 
end 

评论

3 楼 hedahai119 2009-12-14  

  挺详细

2 楼 yuan 2009-11-11  

夜鸣猪 写道

hello
先赞一下，再读

最好是对照着英文读，笔记不是很完整，有些地方没记录，比如最后的Observers那部分。有时间再完善一下。

1 楼 夜鸣猪 2009-11-11  

hello
先赞一下，再读