Rails 5生产环境Api常量自动加载失败问题咨询

1. 自动加载配置的作用范围不匹配 #

Rails 5 中config.autoload_paths仅对开发环境的懒加载逻辑生效，生产环境默认启用预加载（eager loading）模式，只会加载config.eager_load_paths路径下的常量。你仅配置了autoload_paths未同步配置eager_load_paths，首先就会导致生产环境和开发环境的加载范围不一致。

配置逻辑额外问题：你使用Dir[Rails.root.join('app', 'my_folder', '{**/}')]会把app/my_folder下所有子目录都直接加入自动加载根路径，而非将app/my_folder作为根路径，这是触发后续常量冲突的核心诱因。

2. 同名常量的查找优先级冲突 #

你的控制器声明为Api::TestController，Rails加载该类时需要先定位顶层Api命名空间：

• 正常情况下如果存在app/controllers/api/目录，Rails会默认该目录对应顶层Api模块，即使目录下没有显式定义api.rb，Rails也会隐式生成该模块
• 由于你把app/my_folder/service_name也加入了自动加载根路径，Rails扫描Api常量时会优先匹配到该目录下的api.rb文件，尝试从该文件加载顶层Api常量
• 该文件实际定义的并非顶层Api模块（大概率是嵌套在ServiceName下的子模块），因此直接抛出expected /app/my_folder/service_name/api.rb to define it的错误

3. 开发、生产环境表现不一致的原因 #

开发环境采用懒加载策略，只有用到对应常量时才会触发加载：如果请求流程中先触发了控制器相关的Api模块加载，Rails会先隐式生成顶层Api模块，后续不会再搜索其他路径的同名文件，因此不会报错。
生产环境启动时会预加载所有eager_load_paths下的文件，加载顺序不受业务请求逻辑影响，优先匹配到了service_name/api.rb，因此启动时直接抛出异常。

临时修复 #

• 同步生产环境的预加载路径配置：

config.autoload_paths += Dir[Rails.root.join('app', 'my_folder', '{**/}')]
config.eager_load_paths += Dir[Rails.root.join('app', 'my_folder', '{**/}')]

• 显式在app/controllers/api.rb中定义顶层Api模块，提升优先级避免冲突：

# app/controllers/api.rb
module Api
end

最优方案 #

不要递归把app/my_folder的所有子目录加入自动加载根路径，仅将app/my_folder作为根路径加入，让Rails按照目录嵌套层级匹配对应命名空间：

# 替换原有自动加载配置
config.autoload_paths << Rails.root.join('app', 'my_folder')
config.eager_load_paths << Rails.root.join('app', 'my_folder')

调整后app/my_folder/service_name/api.rb会自动匹配ServiceName::Api常量，不会再和顶层Api命名空间产生冲突。

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