Ruby on Rails 4.0.13 应在哪个文件添加require 'csv'使核心及gem扩展的Model可用
首先明确核心前提:Rails 4.0 为了压缩应用启动时间,默认不会自动加载Ruby标准库中的csv模块,要实现核心应用、所有挂载的扩展gem内的Model全局可用CSV能力,必须严格匹配Rails 4的启动加载时序放置引入代码,避免出现时序差导致的未加载报错。
标准放置规则
1. 核心应用侧的放置位置
把require 'csv'写在核心应用的config/application.rb中,位置要比所有框架配置、自动加载目录定义的代码更靠前。
Rails 4的启动流程是:bundler完成gem路径加载后,会第一时间执行application.rb的全量配置,之后才会依次执行initializer、加载app目录下的业务代码、挂载所有gem形式的Rails引擎扩展模块。这个位置的加载时序能保证核心应用后续所有环节加载的代码,都可以直接调用CSV相关的方法,不会出现未引入的问题。
2. 扩展gem侧的适配放置
如果你的扩展gem需要支持独立运行(比如跑gem自身的单元测试、单独被其他项目引用),不能依赖核心应用的引入逻辑,需要在gem自身的lib目录入口文件(通常是lib/[你的gem名称].rb,也就是gem加载时第一个被执行的文件)的最顶部,同样加上require 'csv'。
这种写法能保证gem内部的所有Model、业务代码,不管在什么加载场景下,都能正常使用CSV能力,不会因为脱离核心应用就出现功能报错。
明确不推荐的放置方式
- 不要把
require 'csv'写在单个Model类的文件里:这种写法只有当这个Model被引用时才会加载csv模块,其他未关联这个Model的地方调用to_csv方法依然会报错,完全达不到全局可用的效果 - 不要把引入代码随便丢在
config/initializers的自定义文件里就认为没问题:虽然initializer的执行时间早于业务代码加载,但部分Gemfile中靠前位置的gem会被框架在initializer执行前就触发常量加载,很容易因为时序差出现偶发的未加载报错 - 不需要额外写
Array#to_csv的自定义补丁:只要正确引入csv模块,csv库会自动给Array、Hash等常用数据结构扩展原生的to_csv方法,完全匹配Rails 4的内置支持逻辑,不需要额外改代码
验证方式
启动Rails控制台后,直接执行测试代码
[["表头1","表头2"],["数据1","数据2"]].to_csv,如果能正常输出结构化的CSV文本,就说明加载生效;之后随机调用核心应用、扩展gem里任意一个Model的类方法执行同样的数组测试,没有出现undefined method 'to_csv'的报错,就代表配置完全符合要求。
内容的提问来源于stack exchange,提问作者Love Movement Global.org

