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插入。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,128评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,316评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,737评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,283评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,384评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,458评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,467评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,251评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,688评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,980评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,155评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,818评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,492评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,142评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,382评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,020评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,044评论 2 352

推荐阅读更多精彩内容