前言
从Lua5.1版本开始,就对模块和包添加了新的支持,可是使用require和module来定义和使用模块和包。require用于使用模块,module用于创建模块。简单的说,一个模块就是一个程序库,可以通过require来加载。然后便得到了一个全局变量,表示一个table。这个table就像是一个命名空间,其内容就是模块中导出的所有东西,比如函数和常量,一个符合规范的模块还应使require返回这个table。现在就来具体的总结一下require和module这两个函数。
require函数
Lua提供了一个名为require的函数用来加载模块。要加载一个模块,只需要简单地调用require “<模块名>”就可以了。这个调用会返回一个由模块函数组成的table,并且还会定义一个包含该table的全局变量。但是,这些行为都是由模块完成的,而非require。所以,有些模块会选择返回其它值,或者具有其它的效果。那么require到底是如何加载模块的呢?
首先,要加载一个模块,就必须的知道这个模块在哪里。知道了这个模块在哪里以后,才能进行正确的加载。当我们写下require “mod”这样的代码以后,Lua是如何找这个mod的呢?这里面就有说道了,我这里就详细的说一说。
在搜索一个文件时,在windows上,很多都是根据windows的环境变量path来搜索,而require所使用的路径与传统的路径不同,require采用的路径是一连串的模式,其中每项都是一种将模块名转换为文件名的方式。require会用模块名来替换每个“?”,然后根据替换的结果来检查是否存在这样一个文件,如果不存在,就会尝试下一项。路径中的每一项都是以分号隔开,比如路径为以下字符串:
?;?.lua;c:\windows\?;/usr/local/lua/?/?.lua
</div>
那么,当我们require “mod”时,就会尝试着打开以下文件:
mod
mod.lua
c:\windows\mod
/usr/local/lua/mod/mod.lua
</div>
可以看到,require函数只处理了分号和问好,其它的都是由路径自己定义的。在实际编程中,require用于搜索的Lua文件的路径存放在变量package.path中,在我的电脑上,print(package.path)会输出以下内容:
;.\?.lua;D:\Lua\5.1\lua\?.lua;D:\Lua\5.1\lua\?\init.lua;D:\Lua\5.1\?.lua;D:\Lua\5.1\?\init.lua;D:\Lua\5.1\lua\?.luac
</div>
如果require无法找到与模块名相符的Lua文件,那Lua就会开始找C程序库;这个的搜索地址为package.cpath对应的地址,在我的电脑上,print(package.cpath)会输出以下值:
.\?.dll;.\?51.dll;D:\Lua\5.1\?.dll;D:\Lua\5.1\?51.dll;D:\Lua\5.1\clibs\?.dll;D:\Lua\5.1\clibs\?51.dll;D:\Lua\5.1\loadall.dll;D:\Lua\5.1\clibs\loadall.dll
</div>
当找到了这个文件以后,如果这个文件是一个Lua文件,它就通过loadfile来加载该文件;如果找到的是一个C程序库,就通过loadlib来加载。loadfile和loadlib都只是加载了代码,并没有运行它们,为了运行代码,require会以模块名作为参数来调用这些代码。如果lua文件和C程序库都找不到,怎么办?我们试一下,随便require一个东西,比如:
require "jellythink"
lua: test.lua:1: module 'jellythink' not found:
no field package.preload['jellythink']
no file '.\jellythink.lua'
no file 'D:\Lua\5.1\lua\jellythink.lua'
no file 'D:\Lua\5.1\lua\jellythink\init.lua'
no file 'D:\Lua\5.1\jellythink.lua'
no file 'D:\Lua\5.1\jellythink\init.lua'
no file 'D:\Lua\5.1\lua\jellythink.luac'
no file '.\jellythink.dll'
no file '.\jellythink51.dll'
no file 'D:\Lua\5.1\jellythink.dll'
no file 'D:\Lua\5.1\jellythink51.dll'
no file 'D:\Lua\5.1\clibs\jellythink.dll'
no file 'D:\Lua\5.1\clibs\jellythink51.dll'
no file 'D:\Lua\5.1\loadall.dll'
no file 'D:\Lua\5.1\clibs\loadall.dll'
</div>
是的,会报错的。以上就是require的一般工作流程。
奇淫技巧
可以看到,上面总结的都是通过模块的名称来使用它们。但有的时候需要将一个模块改名,以避免名称冲突。比如有这样的场景,在测试中需要加载同一模块的不同版本,而获得版本之间的性能区别。那么我们如何加载同一模块的不同版本呢?对于一个Lua文件来说,我们可以很轻易的改掉它的名称,但是对于一个C程序库来说,我们是没有办法编辑其中的luaopen_*函数的名称的。为了这种重命名的需求,require用到了一个小的技巧:如果一个模块名中包含了连字符,require就会用连字符后的内容来创建luaopen_*函数名。比如:如果一个模块的名称为a-b,require就会认为它的open函数名为luaopen_b,并不是luaopen_a-b。现在好了,对于上面提出的不同版本进行测试的需求,就可以迎刃而解了。
写一个我们自己的模块
在Lua中创建一个模块最简单的方法是:创建一个table,并将所有需要导出的函数放入其中,最后返回这个table就可以了。相当于将导出的函数作为table的一个字段,在Lua中函数是第一类值,提供了天然的优势。来写一个我们自己的模块,代码如下:
complex = {} -- 全局的变量,模块名称
function complex.new(r, i) return {r = r, i = i} end
-- 定义一个常量i
complex.i = complex.new(0, 1)
function complex.add(c1, c2)
return complex.new(c1.r + c2.r, c1.i + c2.i)
end
function complex.sub(c1, c2)
return complex.new(c1.r - c2.r, c1.i - c2.i)
end
return complex -- 返回模块的table
</div>
上面就是一个最简单的模块。在编写代码的过程中,会发现必须显式地将模块名放到每个函数定义中;而且,一个函数在调用同一个模块中的另一个函数时,必须限定被调用函数的名称,然而我们可以稍作变通,在模块中定义一个局部的table类型的变量,通过这个局部的变量来定义和调用模块内的函数,然后将这个局部名称赋予模块的最终的名称,代码如下:
local M = {} -- 局部的变量
complex = M -- 将这个局部变量最终赋值给模块名
function M.new(r, i) return {r = r, i = i} end
-- 定义一个常量i
M.i = M.new(0, 1)
function M.add(c1, c2)
return M.new(c1.r + c2.r, c1.i + c2.i)
end
function M.sub(c1, c2)
return M.new(c1.r - c2.r, c1.i - c2.i)
end
return complex -- 返回模块的table
</div>
这样,我们在模块内部其实使用的是一个局部的变量。这样看起来比较简单粗暴,但是每个函数仍需要一个前缀。实际上,我们可以完全避

