Ruby 模块 - 包括 do 结束块

Question

有一个模块MyModule:

module MyModule

  extend ActiveSupport::Concern

  def first_method
  end

  def second_method
  end

  included do
    second_class_method
  end

  module ClassMethods
    def first_class_method
    end

    def second_class_method
    end
  end
end

当某个类includes 这个模块时，它将有2个方法暴露为实例方法（first_method和second_method）和2个类方法（first_class_method和second_class_method） - 很清楚。

据说

included 块将在类的上下文中执行 包括模块。

具体是什么意思？意思是，这个方法（second_class_method）到底什么时候执行？

Answer 1

这是一个实际的例子。

class MyClass
  include MyModule
end

当您将模块包含在一个类中时，included 挂钩将被调用。所以second_class_method会在Class的范围内被调用。

这里发生的是

1. first_method 和 second_method 包含在 MyClass. 的实例方法中

   instance = MyClass.new
   instance.first_method
   # => whatever returned value of first_method is
   

2. ClassMethods 的方法自动混合为MyClass 的类方法。这是ActiveSupport::Concern 封装的常见Ruby 模式。非 Rails Ruby 代码是

   module MyModule
     def self.included(base)
       base.extend ClassMethods
     end
   
     module ClassMethods
       def this_is_a_class_method
       end
     end
   end
   

   结果

   MyClass.this_is_a_class_method
   

   或者在你的情况下

   MyClass.first_class_method
   

3. included 是一个对以下代码有效的钩子

   # non-Rails version
   module MyModule
     def self.included(base)
       base.class_eval do
         # somecode
       end
     end
   end
   
   # Rails version with ActiveSupport::Concerns
   module MyModule
     included do
       # somecode
     end
   end
   

   它主要是常见模式的“语法糖”。在实践中发生的情况是，当您混合模块时，该代码会在混合器类的上下文中执行。

Answer 2

included 在你包含module 到一个类时被调用，它用于定义关系、范围、验证，... 它甚至在您从该类创建对象之前就被调用。

例子

module M
...
  included do
    validates :attr, presence: true
    has_many :groups
  end
 ...
end