Ruby on Rails模块配置实例变量意外置空问题排查

这个问题的核心是Rails开发环境的自动代码重新加载机制导致你的模块配置丢失了，具体原因和解决方法如下：

为什么会出现这个问题？ #

在开发环境下，Rails会自动重新加载修改过的代码（比如你删除控制器里的puts行），以此提升开发效率。如果你的CML模块放在app/lib目录下，且该目录被加入了Rails的自动加载路径（Rails 6及之前默认包含app/lib，Rails 7默认不包含，但手动配置后也会触发），那么当控制器被重新加载时，Rails会连带重新加载CML模块。

而初始化器只会在服务器启动时运行一次，模块被重新加载后，原来设置的@scheduler实例变量会被重置为nil，所以你在控制器中访问CML.scheduler时得到的就是空值。

解决方案 #

方案1：将模块移到非自动加载目录并手动require #

这是最稳妥的生产环境可用方案：

1. 把app/lib/cml.rb移动到项目根目录下的lib文件夹（没有的话直接创建）。
2. 在初始化器config/initializers/cml.rb顶部添加require语句：

   require 'cml'
   

3. 重启服务器。

lib目录默认不在Rails的自动加载路径中，模块只会被加载一次，初始化器设置的配置值会一直保留，不会因为代码重新加载而丢失。

方案2：禁用该模块的自动重新加载（保留在app/lib） #

如果你想继续把模块放在app/lib，可以让Rails的自动加载器忽略这个文件：

1. 在config/environments/development.rb中添加配置：

   Rails.autoloaders.main.ignore(Rails.root.join('app/lib/cml.rb'))
   

2. 在初始化器config/initializers/cml.rb顶部添加require语句：

   require 'cml'
   

3. 重启服务器。

这样Rails就不会自动重新加载这个模块，配置值就能稳定保持。

方案3：临时改用类变量存储配置（不推荐生产环境） #

如果只是临时测试，可以修改模块代码，用类变量代替实例变量存储配置（但类变量在Ruby中容易引发意外冲突，不推荐生产环境使用）：

module CML
  class << self
    @@scheduler = nil
    
    def scheduler
      @@scheduler
    end
    
    def scheduler=(value)
      @@scheduler = value
    end
    
    def configure
      yield self
    end
  end
end

验证 #

按照上述方案修改后，重启服务器，修改控制器文件后再次请求/action1，你应该能在日志中看到预期的Scheduler: hey了。

内容的提问来源于stack exchange，提问作者Lukáš Březina