Callback详解

寻技术 Ruby编程 2023年07月11日 133

Callbacks

Callback Registration

在 Rails 中,回调(Callbacks)是一种在模型对象的生命周期中执行特定代码的机制。回调可以在模型对象的创建、更新、删除等操作中执行特定的代码,例如保存对象前执行某些逻辑,或者在对象被删除前执行清理操作。

Rails 中的回调分为两种类型:前置回调(before callbacks)和后置回调(after callbacks)。前置回调在操作执行之前执行,后置回调在操作执行之后执行。可以使用 before_after_ 前缀来指定回调的类型。

以下是一些常见的回调类型:

  • before_validationafter_validation:在验证对象之前和之后执行回调。
  • before_saveafter_save:在保存对象之前和之后执行回调。
  • before_createafter_create:在创建对象之前和之后执行回调。
  • before_updateafter_update:在更新对象之前和之后执行回调。
  • before_destroyafter_destroy:在删除对象之前和之后执行回调。

要注册回调,可以在模型类中使用 before_after_ 前缀来指定回调的类型,然后指定要执行的方法:

class User < ApplicationRecord
  before_save :normalize_email

  private

  def normalize_email
    self.email = email.downcase
  end
end

在上面的例子中,我们将 normalize_email 方法注册为 before_save 回调。这意味着在保存 User 对象之前,Rails 将自动调用 normalize_email 方法。在 normalize_email 方法中,我们将 email 属性转换为小写字母,以确保所有邮件地址都是小写的。

需要注意的是,注册回调时必须指定要执行的方法的名称,可以是一个实例方法或一个类方法。回调方法中可以使用模型对象的任何属性或方法来执行特定的逻辑,例如更新其他对象、发送电子邮件等。

使用回调可以让我们更灵活地控制模型对象的行为,可以在对象的生命周期中执行任意的操作。同时,回调也可以提高代码的可读性和可维护性,使代码更易于理解和修改。

Available Callbacks

在 Rails 中,可以注册多种类型的回调来在模型对象的生命周期中执行特定代码。以下是可用的回调类型:

创建和保存对象

  • before_validation:在验证对象之前执行回调。
  • after_validation:在验证对象之后执行回调。
  • before_save:在保存对象之前执行回调,包括新建和更新操作。
  • around_save:在保存对象之前和之后执行回调,使用 yield 方法来执行保存操作。
  • after_save:在保存对象之后执行回调,包括新建和更新操作。
  • before_create:在创建对象之前执行回调。
  • around_create:在创建对象之前和之后执行回调,使用 yield 方法来执行创建操作。
  • after_create:在创建对象之后执行回调。

更新和删除对象

  • before_update:在更新对象之前执行回调。
  • around_update:在更新对象之前和之后执行回调,使用 yield 方法来执行更新操作。
  • after_update:在更新对象之后执行回调。
  • before_destroy:在删除对象之前执行回调。
  • around_destroy:在删除对象之前和之后执行回调,使用 yield 方法来执行删除操作。
  • after_destroy:在删除对象之后执行回调。

关联对象

  • before_add_association:在添加关联对象之前执行回调。
  • after_add_association:在添加关联对象之后执行回调。
  • before_remove_association:在删除关联对象之前执行回调。
  • after_remove_association:在删除关联对象之后执行回调。

其他

  • after_initialize:在实例化对象之后执行回调。
  • after_find:在从数据库中查找对象之后执行回调。

要注册回调,可以在模型类中使用相应的回调方法来指定回调的类型,然后指定要执行的方法。例如,要在保存对象之前执行特定的逻辑,可以使用 before_save 方法:

class User < ApplicationRecord
  before_save :normalize_email

  private

  def normalize_email
    self.email = email.downcase
  end
end

在上面的例子中,我们将 normalize_email 方法注册为 before_save 回调。这意味着在保存 User 对象之前,Rails 将自动调用 normalize_email 方法。在 normalize_email 方法中,我们将 email 属性转换为小写字母,以确保所有邮件地址都是小写的。

需要注意的是,回调方法中可以使用模型对象的任何属性或方法来执行特定的逻辑,例如更新其他对象、发送电子邮件等。使用回调可以让我们更灵活地控制模型对象的行为,可以在对象的生命周期中执行任意的操作。同时,回调也可以提高代码的可读性和可维护性,使代码更易于理解和修改。

回调前更新属性会怎么办

如果在回调中尝试更新属性,可能会导致一些问题。因为回调的执行顺序是不确定的,所以在某些情况下,属性的更新可能会被其他回调覆盖或被数据库中的持久化数据覆盖。

例如,如果我们在 before_save 回调中尝试更新某个属性,而在 after_save 回调中有另一个回调也尝试更新同一个属性,那么最终属性值可能会是不确定的,因为最后执行的回调会覆盖之前的值。

为了避免这种情况,应该尽量避免在回调中更新属性。如果确实需要更新属性,可以使用 update_column 方法来更新属性,该方法可以直接将属性更新到数据库中,而不触发其他回调。但是需要注意,使用 update_column 方法将跳过所有的验证,包括模型定义的验证,因此需要谨慎使用。

另外,如果在回调中需要使用其他模型对象的数据,可以将逻辑移动到控制器或服务对象中,以确保数据正确性和可维护性。

after_initialize and after_find

after_initializeafter_find 都是 ActiveRecord 模型中的回调方法。

after_initialize 方法会在创建新的 ActiveRecord 对象或从数据库中加载现有对象时被调用。该方法可以用来执行任意初始化逻辑,例如设置默认值或初始化关联对象。与其他回调不同,after_initialize 方法不需要接收任何参数,因为它是在对象创建之后立即调用的。

以下是一个示例,演示如何使用 after_initialize 方法在创建新对象时设置默认值:

class User < ApplicationRecord
  after_initialize :set_defaults

  private

  def set_defaults
    self.status ||= "active"
  end
end

在上面的例子中,我们将 set_defaults 方法注册为 after_initialize 回调。在 set_defaults 方法中,我们检查 status 属性是否为 nil,如果是,则将其设置为默认值 "active"

after_find 方法会在从数据库中查找 ActiveRecord 对象之后被调用。该方法可以用来执行任意的后处理逻辑,例如计算属性或更新关联对象。after_find 方法接收一个参数,即从数据库中加载的 ActiveRecord 对象。

以下是一个示例,演示如何使用 after_find 方法计算用户的年龄:

class User < ApplicationRecord
  after_find :calculate_age

  private

  def calculate_age
    self.age = Date.today.year - birthday.year
  end
end

在上面的例子中,我们将 calculate_age 方法注册为 after_find 回调。在 calculate_age 方法中,我们使用从数据库中加载的用户对象的生日属性计算用户的年龄,并将结果保存到年龄属性中。

需要注意的是,after_find 方法只会在从数据库中加载对象时被调用,而不会在实例化新对象时被调用。如果需要在对象创建后执行某些逻辑,应该使用 after_initialize 方法。

after_touch什么 意思

after_touch是Rails中的一个回调方法,它会在一个已关联的对象被touch操作更新后被触发。在Rails中,touch操作指的是在更新一个对象时,同时更新关联对象的更新时间戳(updated_at)字段。这个操作可以用来实现缓存失效、重新计算统计数据等功能。

例如,假设你有一个User模型和一个Post模型,一个用户可以拥有多篇文章。当你更新某篇文章时,你可能需要更新相关用户的更新时间戳,以便在用户列表或其他地方正确地排序。你可以使用touch选项来实现这一点,如下所示:

class Post < ApplicationRecord
  belongs_to :user, touch: true
end

class User < ApplicationRecord
  has_many :posts
  after_touch :update_sorting

  def update_sorting
    # 更新用户排序,例如更新`updated_at`字段
    self.touch
  end
end

这段代码定义了两个Active Record模型,PostUser,它们之间存在一个一对多的关联关系。

Post模型中,使用belongs_to :user, touch: true声明了一个属于关联,表示一篇文章属于一个用户。touch: true选项表示当文章被更新时,自动更新与之关联的用户的updated_at字段,以便在用户列表或其他地方正确地排序。

User模型中,使用has_many :posts声明了一个拥有多个关联,表示一个用户可以拥有多篇文章。after_touch :update_sorting声明了一个after_touch回调方法,表示当与之关联的一篇文章被touch操作更新时,自动调用update_sorting方法更新用户排序,例如更新updated_at字段。

update_sorting方法中,使用self.touch方法更新用户的updated_at字段,以便在用户列表或其他地方正确地排序。

需要注意的是,这段代码中使用了touch操作来实现自动更新关联对象的更新时间戳,这可以用来实现缓存失效、重新计算统计数据等功能。在Rails中,touch操作是一种常见的技巧,可以用来简化代码并提高性能。

需要注意的是,after_touch回调方法只会在touch操作触发更新时被调用。如果你手动更新了updated_at字段,after_touch回调方法不会被调用。

运行回调

这些是Rails中常用的Active Record模型操作方法,下面分别介绍它们的作用:

  1. create(attributes = {}):创建一个新的模型对象并将其保存到数据库中。可以传入一个哈希表参数attributes表示要创建的模型对象的属性值。

  2. create!(attributes = {}):与create相同,但如果保存失败会抛出异常。

  3. destroy:从数据库中删除当前模型对象。

  4. destroy!:与destroy相同,但如果删除失败会抛出异常。

  5. destroy_all:删除符合条件的所有模型对象,不进行任何回调和验证。

  6. destroy_by(conditions):根据条件删除符合条件的单个模型对象,不进行任何回调和验证。

  7. save:将当前模型对象的属性值保存到数据库中。如果对象不存在,则创建一个新的对象。

  8. save!:与save相同,但如果保存失败会抛出异常。

  9. save(validate: false):与save相同,但不进行模型对象的验证。

  10. toggle!:将当前模型对象的布尔类型属性取反并保存到数据库中。

  11. touch:更新当前模型对象的updated_at字段,并保存到数据库中。这个方法通常用于更新缓存或触发回调方法。

  12. update_attribute(name, value):更新当前模型对象的单个属性值,并直接保存到数据库中,不进行任何验证。

  13. update(attributes):更新当前模型对象的属性值,并保存到数据库中。可以传入一个哈希表参数attributes表示要更新的属性值。

  14. update!(attributes):与update相同,但如果更新失败会抛出异常。

  15. valid?:检查当前模型对象是否通过验证。如果验证失败,可以使用errors方法查看错误信息。

这些方法是Rails中常用的Active Record模型操作方法,可以用于创建、更新、删除和验证模型对象。需要注意的是,这些方法中有些会触发回调方法、进行验证或抛出异常,具体使用时需要根据实际情况选择合适的方法。

关闭

用微信“扫一扫”