lua模块与包

lua模块与包

---

模块类似一个封装库，从lua5.1开始，lua加入了标准的模块管理机制，可以把一些公用的代码放在一个文件里，以api接口的形式在其他地方调用，有利于代码的重用和降低代码耦合度。

lua的模块是由变量、函数等已知元素组成的table，因此创建一个模块很简单，就是创建一个table，然后把需要导出的常量、函数放入其中，最后返回这个table就行。

以下创建自定义模块module.lua：

--文件名 module.lua
--定义一个名为module的模块
module = {}

--定义一个常量
module.constant = "这是一个常量"

--定义一个函数
function module.func1()
	io.write("这是一个公有函数！\n")
end

local function func2()
	print("这是一个私有函数")
end

function module.func3()
	func2()
end

return module

由上可知，模块的结构就是一个table的数据结构，因此可以像操作调用table里的元素那样来操作调用模块里的常量或函数。

上面的func2声明为程序块的局部变量，即表示一个私有函数，因此不能从外部访问模块里的这个私有函数，必须通过模块里的公有函数来调用。

 

require函数

---

lua提供了一个名为require的函数用来加载模块。要加载一个模块，只需要简单地调用就可以了。

例如：

require（“<模块名>”）

或者

require "<模块名>"

执行require后会返回一个由模块常量或函数组成的table，并且还会定义一个包含该table的全局变量。

-- test_module.lua
-- module 模块为上文提到的module.lua

require "module"

print(module.constant)

module.func3()

root@mzs:/home/mzs/lua_study/lua_mzs/hello# lua test_module.lua 
这是一个常量
这是一个私有函数

或者给加载的模块定义一个别名变量，方便调用：

-- test_module2.lua
-- module 模块为上文提到的module.lua

-- 别名变量
local m = require("module")

print(m.constant)

m.func3()

root@mzs:/home/mzs/lua_study/lua_mzs/hello# lua test_module2.lua 
这是一个常量
这是一个私有函数

加载机制

---

对于自定义的模块，模块文件不是放在哪个文件目录都行，函数require有它自己的文件路径加载策略，它会尝试从lua文件或c程序库中加载模块。

require 用于搜索Lua文件的路径是存放在全局变量package.path中，当lua启动后，会以环境变量LUA_PATH的值来初始这个环境变量。如果没有找到该环境变量，则使用一个编译时定义的默认路径来初始化。

当然，如果没有LUA_PATH这个环境变量，也可以自己定义设置，在当前用户根目录下打开.profile文件（没有这创建，打开.bashrc文件也可以），例如吧~/lua/路径加入LUA_PATH环境变量里：

#LUA_PATH

export LUA_PATH=“~/lua/?.lua;;”

文件路径以“;”号分隔 ，最后两个“;;” 表示新加的路径后面加上原来的默认路径。

接着，更新环境变量参数，使之立即生效。

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来加载它。

 

c包

---

lua和c很容易结合的，使用c为lua写包。

与lua中使用包不同，c包在使用以前必须首先加载并连接 ，在大多数系统中最容易的实现方式是通过动态链接库机制。

lua在一个叫loadlib的函数内提供了所有的动态连接功能。这个函数有两个参数：库的绝对路径和初始化函数。

所以典型的调用的例子如下：

local path = "/usr/local/lua/lib/libluasocket.so"

local f = loadlib(path,"luaopen_socket")

loadlib函数加载指定的库并且连接到lua，然而它并不打开库（也就是说没有调用初始化函数），反之它返回初始化函数作为lua的一个函数，这样我们就可以直接在lua中调用他。

如果加载动态库或者查找初始化函数时出错，loadlib将返回Nil和错误信息。我们可以修改前面一段代码，使其检测错误然后调用初始化函数：

local path = "/usr/local/lua/lib/libluasocket.so"
-- 或者 path = "C:\\windows\\luasocket.dll"，这是 Window 平台下
local f = assert(loadlib(path, "luaopen_socket"))
f()  -- 真正打开库

一般情况下我们期望二进制的发布库包含一个与前面代码段相似的stub文件，安装二进制库的时候可以随便放在某个目录，只需要修改stub文件对应二进制库的实际路径即可。

将stub文件所在的目录加入到LUA_PATH，这样设定后就可以使用require函数加载C库了。