Ruby中确保引入自定义模块的类同时引入SemanticLogger::Loggable的方法

核心思路是利用Ruby模块的included钩子，让自定义模块被其他类引入时，自动触发目标类引入SemanticLogger::Loggable，从根源上确保所有使用该自定义模块的类都具备logger实例方法，避免调用失败。

示例代码实现 #

module MyCustomModule
  def self.included(base)
    # 自动让引入当前模块的类包含Loggable
    base.include(SemanticLogger::Loggable)
  end

  # 自定义模块的实例方法，可安全调用logger
  def do_something
    logger.info("执行do_something方法")
    # 其他业务逻辑代码
  end
end

# 使用示例
class MyService
  include MyCustomModule
end

service = MyService.new
service.do_something # logger方法正常可用，不会报错

方案说明 #

• included是Ruby模块的回调方法，当模块被include到某个类（即参数base）时自动触发。
• 在钩子中执行base.include(SemanticLogger::Loggable)，相当于替引入类完成了Loggable的引入操作，无需每个类手动编写该语句。
• 此时自定义模块的实例方法调用logger时，实际调用的是引入类（比如MyService）的logger实例方法，完全匹配SemanticLogger的设计逻辑，能获取类专属的日志对象。

为什么直接在自定义模块include Loggable不可行？ #

如果直接在MyCustomModule中写include SemanticLogger::Loggable，Loggable的实例方法会被添加到模块自身的实例上下文，但模块无法被实例化，这些方法最终会被引入类继承。而Loggable的logger实例方法依赖于类的上下文，这种方式下无法正确关联到引入类的日志对象，必然导致调用失败。

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