rails的自动加载模块

在 rails 的很多模块定义里经常看到这样的代码：

module Rails
  extend ActiveSupport::Autoload
  autoload :FooBar

看名称就知道它与自动加载有关。实际上 ruby 的Kernel模块里已经定义了一个这样的方法，autoload(module, filename)这个方法的作用是当第一次遇到指定模块时，自动按照指定的路径加载。

为什么 rails 还要再定义一个这样的方法呢？原因是为了方便。rails 有大量的模块分散在不同的文件里，并且这些文件按一定的规则组织在一起。ActiveSupport::Autoload模块中的autoload能根据模块名称和约定的规则生成文件路径加载模块，不用每次都指定路径。除此之外，该模块还定义了 eager_load! 方法，用于提前加载指定的一组模块。
其用法如下：

module MyLib
  extend ActiveSupport::Autoload
  autoload :Model

  eager_autoload do
    autoload :Cache
  end
end
MyLib.eager_load!

ActiveSupport::Autoload的源代码文件在
~/.rvm/gems/ruby-2.4.0/gems activesupport-5.0.1/lib/active_support/dependencies/autoload.rb这是我电脑上的路径，根据不同的安装环境可能会有不同。这个模块的定义很简单，只有70多行，下面对其主要的方法进行分析。

module Autoload
  # 当宿主模块 extend ActiveSupport::Autoload 时，在宿主模块的上下文中初始化几个变量。
  def self.extended(base) # :nodoc:
    base.class_eval do
      @_autoloads = {}  # 保存 eager_load! 所需加载的模块
      @_under_path = nil  # 保存中间路径
      @_at_path = nil  # 保存准确路径
      @_eager_autoload = false  
    end
  end

  # 该模块的核心方法，主要作用是生成路径，并调用 ruby 自带的 autoload。
  def autoload(const_name, path = @_at_path)
    unless path
      # 路径生成规则，name 为宿主模块的类方法，返回宿主模块名称。
      # 例如在Rails模块里 autoload :Foo，将返回路径 Rails/Foo。
      # @_under_path 默认是 nil，可通过 autoload_under(path)更改。
      full = [name, @_under_path, const_name.to_s].compact.join("::")
      # 将形如 Rails::Foo::Bar 改为 Rails/Foo/Bar
      path = Inflector.underscore(full)
    end

    # 为 true 时，模块保存到 @_autoloads，从而可通过 eager_load! 提前加载
    if @_eager_autoload
      @_autoloads[const_name] = path
    end

    # 生成路径后，调用 ruby 自带的 autoload 方法
    super const_name, path
  end

  # 增加中间路径
  def autoload_under(path)
    @_under_path, old_path = path, @_under_path
    yield
  ensure
    @_under_path = old_path
  end

  # 将模块加入 @_autoloads，为 eager_load! 作准备
  def eager_autoload
    old_eager, @_eager_autoload = @_eager_autoload, true
    yield
  ensure
    @_eager_autoload = old_eager
  end

  # 依次加载 @_autoloads 中的模块
  def eager_load!
    @_autoloads.each_value { |file| require file }
  end
  ......

小结

ActiveSupport::Autoload按照 Rails 的约定规则生成路径自动加载模块。改写了 autoload方法来自动加载，提供eager_load!方法来提前加载。生成路径的规则为当前模块名/加载模块名，如有中间路径，可通过autoload_under插入。