为何Ruby模块方法无法访问模块类变量？代码异常排查

首先，咱们先还原下你可能的代码场景（根据描述基本能匹配）：

module AppNavigation
  # 定义模块类变量并存入哈希
  @@main_menu = { home: "首页", about: "关于我们" }

  def self.main_menu
    # 第一行无法输出哈希值
    puts @@main_menu
    # 注释后第二行输出"NOTHING THERE"，说明变量为nil
    puts @@main_menu.nil? ? "NOTHING THERE" : "哈希存在"
  end

  # 方法内创建哈希则正常
  def self.test_menu
    temp_menu = { home: "首页", about: "关于我们" }
    puts temp_menu # 能正常输出
  end
end

出现这种情况，大概率是下面两个原因之一：

1. 模块类变量（@@）的作用域冲突 #

Ruby里的模块类变量（以@@开头）是共享作用域——如果你的模块被其他类include或者extend了，那包含这个模块的类会共享这个@@变量。举个例子：

module AppNavigation
  @@main_menu = { home: "首页" }

  def self.main_menu
    puts @@main_menu
  end
end

class UserController
  include AppNavigation
  # 这里定义了同名的类变量，直接覆盖了模块里的@@main_menu
  @@main_menu = nil
end

# 此时调用模块的main_menu，会输出nil！
AppNavigation.main_menu

这是因为@@变量会在模块和所有包含它的类之间共享，一旦某个类修改了它，模块里的变量也会跟着变。

2. 变量初始化时机不对 #

如果你的模块类变量不是在模块顶层初始化的，而是放在了某个需要手动触发的方法里（比如setup方法），那如果没调用这个方法就访问变量，自然会得到nil：

module AppNavigation
  def self.setup
    @@main_menu = { home: "首页" }
  end

  def self.main_menu
    puts @@main_menu # 没调用setup的话，这里就是nil
  end
end

# 直接调用，输出nil
AppNavigation.main_menu

解决办法 #

改用模块实例变量（推荐） #

模块本身也是一个对象，用@定义的模块实例变量只属于模块自己，不会被其他包含它的类共享，完美避免作用域冲突：

module AppNavigation
  # 定义模块实例变量
  @main_menu = { home: "首页", about: "关于我们" }

  def self.main_menu
    puts @main_menu # 正常输出哈希
    puts @main_menu.nil? ? "NOTHING THERE" : "哈希存在"
  end
end

确保类变量的作用域独立性 #

如果你一定要用@@类变量，那要确保没有其他包含该模块的类修改它，或者在模块里通过类方法严格控制变量的访问和修改：

module AppNavigation
  @@main_menu = { home: "首页", about: "关于我们" }

  def self.main_menu
    @@main_menu
  end

  # 只允许通过这个方法修改变量
  def self.update_main_menu(new_menu)
    @@main_menu = new_menu
  end
end

确认初始化时机 #

如果变量是在特定方法里初始化的，一定要确保在访问变量前调用这个初始化方法：

module AppNavigation
  def self.setup
    @@main_menu = { home: "首页" }
  end

  def self.main_menu
    puts @@main_menu
  end
end

# 先调用初始化，再访问变量
AppNavigation.setup
AppNavigation.main_menu # 正常输出

内容的提问来源于stack exchange，提问作者C. Ball