引言
在Ruby中,当我们想引用某些库或者其它文件中定义的类和方法时候,会使用 require 或者require_relative,load,include
那么,它们两个有什么区别? Ruby怎么知道要去哪里搜索,也就是,Ruby的require的默认搜索路径是什么?
require
require是Ruby中用的最多的,它通常用来导入系统库,还有我们用gem安装的三方库.我们自己工程中的文件之间的相互引用,也是用的它.
require的用法
require 'commander/import'
require 'terminal-table'
require 'term/ansicolor'
require 'csv'
require 'cupertino'
Ruby会在ruby所对应的gem库的搜索路径去寻找指定的文件,什么意思呢,就是说,如果你系统上有多个ruby,那么你用的哪个ruby来跑,那么其搜索使用的就是对应版本的ruby的gem的搜索库
ruquire的搜索路径在全局变量 :,带冒号的)中,
LOAD_PATH.
当我们在ruby中,想使用另外一个ruby中的内容,需要用require关键字来加载另外的ruby文件中的内容 require会在预设的 LOAD_PATH)中去查找对应的文件
例如,在我的电脑上,默认的全局$:的路径是
➜ testRuby ruby -e 'puts $:'
/Users/yohunl/.rvm/rubies/ruby-2.6.0/lib/ruby/gems/2.6.0/gems/did_you_mean-1.3.0/lib
/Users/yohunl/.rvm/rubies/ruby-2.6.0/lib/ruby/site_ruby/2.6.0
/Users/yohunl/.rvm/rubies/ruby-2.6.0/lib/ruby/site_ruby/2.6.0/x86_64-darwin18
/Users/yohunl/.rvm/rubies/ruby-2.6.0/lib/ruby/site_ruby
/Users/yohunl/.rvm/rubies/ruby-2.6.0/lib/ruby/vendor_ruby/2.6.0
/Users/yohunl/.rvm/rubies/ruby-2.6.0/lib/ruby/vendor_ruby/2.6.0/x86_64-darwin18
/Users/yohunl/.rvm/rubies/ruby-2.6.0/lib/ruby/vendor_ruby
/Users/yohunl/.rvm/rubies/ruby-2.6.0/lib/ruby/2.6.0
/Users/yohunl/.rvm/rubies/ruby-2.6.0/lib/ruby/2.6.0/x86_64-darwin18
可能你会觉得奇怪,上面输出的路径似乎并没有包含我们使用gem install安装的三方库.我们用命令输出下gem的安装目录
➜ gem env | grep -A2 'GEM PATHS'
- GEM PATHS:
- /Users/yohunl/.rvm/gems/ruby-2.6.0
- /Users/yohunl/.rvm/rubies/ruby-2.6.0/lib/ruby/gems/2.6.0
其实这是因为,用户gem的安装目录,是在require执行的时候,动态先添加到$:中去的.
我们可以打开irb来验证一下
old_load_path = $LOAD_PATH.dup
require 'cocoapods'
new_load_path = $LOAD_PATH.dup
从输出的结果可以看出来,当执行了一个require后,$:的结果增加了很多,差不多增加了20个....
这也就验证了,在第一次执行到require的时候,require内部会先添加路径.
目前,require已经支持相对路径了!!!!很多文章中说的不支持,已经是过去式了.
例如 在我们目录下下有两个文件 a.rb 和b.rb
.
├── a.rb
└── b.rb
由于require的搜索路径并没有当前目录,所以直接 require "b"是不行的.
有以下几种方式:
require "./b" #采用相对路径
或者
$: << File.dirname(__FILE__)
require "b"
或者
$LOAD_PATH.push File.dirname(__FILE__)
require "b"
或者
$LOAD_PATH.unshift(File.dirname(__FILE__)) unless $LOAD_PATH.include?(File.dirname(__FILE__))
require "b"
或者
require File.dirname(__FILE__) + '/b.rb'
或者
require File.expand_path('../b.rb', __FILE__)
那么,如果我们想包含一个文件夹下有所的文件呢?
最好的方法是将目录添加到加载路径，然后require每个文件的基本名称.当然你也可以用如下的命令来加载文件夹下所有的文件
Dir["/path/to/directory/*.rb"].each {|file| require file }
另外,有人写了一个简单的require_all来实现这个功能,可以用
gem install require_all
来安装它
require_relative
require_relative的调用是相对路径。如当前文件夹下存在一个名为foo.rb的文件时，调用的方式为require_relative 'foo'。它不能调用$LOAD_PATH中的包
load
load也是加载一个文件，它与require_relative的区别是：
require_relative多次加载同一文件时，只会加载一次；load每一次调用都会重加载该文件。
include
我们平时用的很少
Ruby Require VS Load VS Include VS Extend 有详细的介绍,这里摘录关键的部分
在一个模块中,可能会有很多胶水代码,也就是说类A中有一些函数,和类B中一些函数的实现是 一模一样的,这个时候,就可以把 那部分一样的函数提取出来,写在module中,然后在每个类用include这个module
就很简便在这个类中插入了module中的这几个方法了,避免了拷贝型的重复工作
module Log
def class_type
"This class is of type: #{self.class}"
end
end
class TestClass
include Log
end
tc = TestClass.new.class_type
puts tc #This class is of type: TestClass
