ActiveSupport::Concern 源码分析与实际应用

在 Ruby on Rails 中， ActiveSupport::Concern 是一个非常有用的模块，它能够简化我们在编写可重用和组合的代码片段时的工作流程。本文将对 ActiveSupport::Concern 的源代码进行分析，并结合实际项目案例，帮助我们更好地理解其工作原理与应用方式。

# 源码分析

首先，让我们来分析一下 ActiveSupport::Concern 的源码。它的核心思想是利用 Ruby 的模块特性来实现代码的封装和复用。

# 关键方法

included 类方法：定义一个在模块被包含到其他类或模块时执行的回调方法。
class_methods 类方法：定义一个模块，其中的方法将成为使用该模块的类的类方法。
append_features 实例方法：在模块被包含到类中时，通过调用 append_features 方法来将模块中的实例方法添加到类中。
extended 类方法：定义一个在模块被扩展到对象时执行的回调方法。

# 工作原理

当一个模块使用 include 关键字被包含到一个类中时，Ruby 会调用该模块的 append_features 方法。
在 append_features 方法内部， ActiveSupport::Concern 会自动将模块中的实例方法添加到包含模块的类中。
如果模块定义了 included 方法，该方法会在模块被包含到其他类中时被触发。

# 实际应用场景

# 1. Model Callbacks

在 Rails 中，我们经常需要定义模型的回调方法来执行一些特定的操作。通过使用 ActiveSupport::Concern ，我们可以将模型的回调方法封装为一个模块，并在需要时引入到模型中。

module Sluggable
  extend ActiveSupport::Concern

  included do
    before_validation :generate_slug
  end

  def generate_slug
    self.slug = ... # 生成唯一的 slug 的逻辑
  end
end

class Post < ApplicationRecord
  include Sluggable
end

通过这种方式，我们可以将模型的回调逻辑封装到一个模块中，使代码更加简洁和可读。

# 2. Controller Concerns

在 Rails 控制器中，我们经常需要共享一些公共的行为或配置。ActiveSupport::Concern 提供了一种简洁的方式来封装这些公共行为，并在控制器中引入。

module Pagination
  extend ActiveSupport::Concern

  included do
    before_action :set_page, only: [:index]
  end

  def set_page
    @page = params[:page] || 1
  end
end

class UsersController < ApplicationController
  include Pagination

  def index
    @users = User.page(@page)
    # ...
  end
end

这样，我们可以将控制器中的公共行为封装到一个模块中，使代码更加模块化和可维护。

# 总结一下

# 1. 编写一个示例描述 ActiveSupport::Concern 的用法

module ActiveAble
	extend ActiveSupport::Concern

	included do |base|
		scope :active, -> { where(is_active: true) }
	end
end

class Post < AcitveRecord::Base
	include ActiveAble
end

class Comment < AcitveRecord::Base
	include ActiveAble
end

# Post.active
# Comment.active

# 2. 请说明 ActiveSupport 库加入 Concern 模块是为了解决什么问题

重复的代码放在一个 concern 中，供多个 model 使用，代码简洁化
提高了代码的可读性，方便代码进行重构

Concern 最好命名以 able 结尾～

Step by Step

Sai {{moment(1681976013000).fromNow()}}