Lua模块与包学习笔记
从Lua5.1开始,Lua加入了标准的模块管理机制,可以把一些公用的代码放在一个文件里,以API接口的形式在其他地方调用,有利于代码的重用和降低代码耦合度。
创建模块
其实Lua的模块是由变量、函数等已知元素组成的table,因此创建一个模块很简单,就是创建一个table,然后把需要导出的常量、函数放入其中,最后返回这个table就行。格式如下:
--定义一个名为module的模块 module={} --定义一个常量 module.constant="thisisaconstant" --定义一个函数 functionmodule.func1() io.write("thisisapublicfunction!\n") end localfunctionfunc2() print("thisisaprivatefunction!") end functionmodule.func3() func2() end returnmodule
由上可知,模块的结构就是一个table的结构,因此可以像操作调用table里的元素那样来操作调用模块里的常量或函数。不过上面的func2声明为程序块的局部变量,即表示一个私有函数,因此是不能从外部访问模块里的这个私有函数,必须通过模块里的共有函数来调用。
最后,把上面的模块代码保存为跟模块名一样的lua文件里(例如上面是module.lua),那么一个自定义的模块就创建成功。
加载模块
Lua提供一个名为require的函数来加载模块,使用也很简单,它只有一个参数,这个参数就是要指定加载的模块名,例如:
require("<模块名>") --或者是 --require"<模块名>"
然后会返回一个由模块常量或函数组成的table,并且还会定义一个包含该table的全局变量。
或者给加载的模块定义一个别名变量,方便调用:
localm=require("module") print(m.constant) m.func3()
加载机制
对于自定义的模块,模块文件不是放在哪个文件目录都行,函数require有它自己的文件路径加载策略,它会尝试从Lua文件或C程序库中加载模块。
require用于搜索Lua文件的路径是存放在全局变量package.path中,当Lua启动后,会以环境变量LUA_PATH的值来初始这个环境变量。如果没有找到该环境变量,则使用一个编译时定义的默认路径来初始化。
当然,如果没有LUA_PATH这个环境变量,也可以自定义设置,在当前用户根目录下打开.profile文件(没有则创建,打开.bashrc文件也可以),例如把"~/lua/"路径加入LUA_PATH环境变量里:
#LUA_PATH exportLUA_PATH="~/lua/?.lua;;"
文件路径以";"号分隔,最后的2个";;"表示新加的路径后面加上原来的默认路径。
接着,更新环境变量参数,使之立即生效:
source~/.profile
这时假设package.path的值是:
/Users/dengjoe/lua/?.lua;./?.lua;/usr/local/share/lua/5.1/?.lua;/usr/local/share/lua/5.1/?/init.lua;/usr/local/lib/lua/5.1/?.lua;/usr/local/lib/lua/5.1/?/init.lua
那么调用require("module")时就会尝试打开以下文件目录去搜索目标
/Users/dengjoe/lua/module.lua; ./module.lua /usr/local/share/lua/5.1/module.lua /usr/local/share/lua/5.1/module/init.lua /usr/local/lib/lua/5.1/module.lua /usr/local/lib/lua/5.1/module/init.lua
如果找过目标文件,则会调用package.loadfile来加载模块。否则,就会去找C程序库。搜索的文件路径是从全局变量package.cpath获取,而这个变量则是通过环境变量LUA_CPATH来初始。搜索的策略跟上面的一样,只不过现在换成搜索的是so或dll类型的文件。如果找得到,那么require就会通过package.loadlib来加载它。