Ruby模块中extend self与class << self的最佳实践及运行时差异

一、合适的命名建议 #

你说的这种仅包含模块级方法、不用于被类include的模块，业内通常叫工具类模块（Utility Module）或者命名空间模块（Namespace Module），核心作用是把相关功能的静态方法归类到统一命名空间下，避免全局方法污染。

二、extend self是否为好实践？ #

在这种明确只做工具类、禁止被include的场景下，extend self绝对是推荐的好实践，理由如下：

• 代码简洁直观：只需要在模块顶部加一行extend self，后续所有定义的实例方法都会自动转为模块方法，读者一眼就能明白这个模块的定位，不用逐个检查方法是否带.self
• 避免遗漏风险：相比class << self需要把所有方法包裹在代码块内，extend self不会出现“方法写在块外变成实例方法”的失误，维护起来更省心
• 符合Ruby社区惯用写法：不少Ruby工具类库都会采用这种方式，属于约定俗成的最佳实践之一

三、class << self与extend self的运行时差异 #

两者在功能上都能实现模块方法，但运行时的底层逻辑有以下区别：

1. 方法定义的归属不同 #

• class << self是直接在模块的**单例类（eigenclass）**中定义方法，这些方法本质是单例类的实例方法，对外表现为模块的静态方法
• extend self是把模块自身的实例方法，添加到模块的单例类中，相当于让模块“继承”了自己的实例方法，模块方法和原实例方法是同一个方法对象的引用

2. 方法修改的联动性不同 #

如果后续修改模块的实例方法，两者的表现完全不同：

# 使用 class << self 的情况
module Tool1
  class << self
    def greet
      "Hello"
    end
  end

  # 定义同名实例方法，不会影响模块方法
  def greet
    "Hi"
  end
end
Tool1.greet # => "Hello"

# 使用 extend self 的情况
module Tool2
  extend self

  def greet
    "Hello"
  end

  # 修改实例方法，模块方法会同步变化
  def greet
    "Hi"
  end
end
Tool2.greet # => "Hi"

3. 方法查找路径的细微差异 #

• class << self定义的方法，直接存在于模块的单例类中，方法查找时会优先命中
• extend self的模块方法，是通过模块单例类包含了模块自身，方法查找需要多走一层“包含链”，但这个差异在日常开发中完全可以忽略，性能影响微乎其微

四、额外约束建议 #

如果你想进一步强化“禁止被类include”的规则，可以在模块里加一个钩子方法，防止误包含：

module MyUtils
  extend self

  def self.included(base)
    raise "MyUtils is a utility module and should not be included in #{base}"
  end

  # 工具方法...
end

内容的提问来源于stack exchange，提问作者Keith Bennett