Lua 模块与包

模块类似于一个封装库，可以把一些公用的代码放在一个文件里，以 API 接口的形式在其他地方调用，有利于代码的重用和降低代码耦合度。

Lua 从 5.1 版本开始，加入了标准的模块管理机制。

Lua 的模块是由变量、函数等已知元素组成的 table。

创建一个 Lua 模块非常简单，就是创建创建一个 table，把需要导出的常量、函数放入其中，返回这个 table 就可以了

下面我们自定义一个名为 mymodule 的模块 mymodule.lua

-- !/usr/bin/lua
-- -*- encoding:utf-8 -*-
-- filename: mymodule.lua
-- author: 简单教程(www.twle.cn)
-- Copyright © 2015-2065 www.twle.cn. All rights reserved.

mymodule = {}

-- 定义一个常量
mymodule.constant = "这是一个模块常量"

-- 定义一个函数
function mymodule.hello()
    io.write("这是一个定义在 mymodule 模块内的公开函数")
    io.write("Hello World!\n")
end

-- 定义一个私有函数

local function priv_func()
    io.write("这是一个定义在 mymodule 模块内的私有函数")
end


-- 定义一个公开函数调用 私有函数 priv_func
function mymodule.call_priv_func()
    priv_func()
end

-- 返回模块
return mymodule

-- 模块定义完成

模块的本质就是定义一个 table。 因此可以像操作调用 table 里的元素那样来操作调用模块里的常量或函数

mymodule 模块中的 priv_func() 声明为模块的局部变量，即表示一个私有函数。 因此是不能从外部访问模块里的 priv_func() 函数，必须通过模块里的公有函数来调用

require 函数

我们已经定义好了一个 mymodule 模块，现在要调用 mymodule 里的函数和常量就缺把 mymodule 引入到程序中了。

Lua 提供了一个 require 函数用来加载模块。

require 函数语法格式如下

require("<模块名>")

或

require "<模块名>"

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

这个全局变量默认与模块中 return 语句返回的 table 同名

范例: 调用 mymodule.lua 模块

-- !/usr/bin/lua
-- -*- encoding:utf-8 -*-
-- filename: main.lua
-- author: 简单教程(www.twle.cn)
-- Copyright © 2015-2065 www.twle.cn. All rights reserved.


-- 调用刚刚定义的模块名
require("mymodule")

print(mymodule.constant)

mymodule.call_priv_func()

运行以上 Lua 脚本，输出结果如下

$ lua main.lua
这是一个模块常量
这是一个定义在 mymodule 模块内的私有函数%

require 函数的返回值可以赋值给一个变量，用来给模块定义一个别名

-- !/usr/bin/lua
-- -*- encoding:utf-8 -*-
-- filename: main.lua
-- author: 简单教程(www.twle.cn)
-- Copyright © 2015-2065 www.twle.cn. All rights reserved.


-- 调用刚刚定义的模块名，并给它定义一个别名 m
local m = require("mymodule")

-- 通过别名调用常量 
print(m.constant)


-- 通过别名调用函数
m.call_priv_func()

运行以上 Lua 脚本，输出结果如下

$ lua main.lua
这是一个模块常量
这是一个定义在 mymodule 模块内的私有函数%

Lua 中的模块加载机制

对于开发者自定义的模块，模块文件不是放在哪个文件目录都行。

require 函数有着自己的文件路径加载策略，它会尝试从 Lua 文件或 C 程序库中搜索并加载模块

require 用于搜索 Lua 文件的路径是存放在全局变量 package.path 中

当 Lua 启动后，会以环境变量 LUA_PATH的值来初始这个环境变量。 如果没有找到该环境变量，则使用一个编译时定义的默认路径来初始化。 当然，如果没有 LUA_PATH 这个环境变量，也可以自定义设置，打开当前用户目录下的 ~/.profile 或者 ~/.bashrc 设置一个 LUA_PATH 的环境变量

如果没有这两个文件，则自己新建一个。现在的系统，一般都有的。

例如把 ~/lua/ 路径加入 LUA_PATH 环境变量里，可以添加如下设置

#LUA_PATH
export LUA_PATH="~/lua/?.lua;;"

LUA_PATH 文件路径以分号 (;) 分隔，最后的 2 个分号(";;") 表示新加的路径后面加上原来的默认路径。

然后使用 source 命令更新环境变量参数，使之立即生效

source ~/.profile

我们假设经过以上设置后，package.path 的值是为

/Users/yufei/lua/?.lua;./?.lua;/usr/local/share/lua/5.3/?.lua;
/usr/local/share/lua/5.3/?/init.lua;/usr/local/lib/lua/5.3/?.lua;
/usr/local/lib/lua/5.3/?/init.lua

那么调用 require("mymodule") 时就会尝试打开以下文件目录去搜索目标

/Users/yufei/lua/mymodule.lua;
./mymodule.lua
/usr/local/share/lua/5.3/mymodule.lua
/usr/local/share/lua/5.3/mymodule/init.lua
/usr/local/lib/lua/5.3/mymodule.lua
/usr/local/lib/lua/5.3/mymodule/init.lua

如果找到目标文件，则会调用 package.loadfile 函数来加载模块。 否则，就会去找 C 程序库。

搜索 C 程序库的文件路径是从全局变量 package.cpath 获取，而这个变量则是通过环境变量 LUA_CPATH 来初始化的

搜索 C 程序库的策略跟上面的一样，只是搜索的文件名由 .lua 换成了 .so 或 .dll 。 如果找到，那么 require 函数就会通过 package.loadlib 来加载它

C 语言模块

Lua 天生仿佛天生就是和 C 语言结合的。

使用 C 语言开发 Lua 模块是一件非常简单的事情。

与 Lua 中定义模块不同，使用一个 C 语言 Lua 模块前必须首先加载并连接。 在大多数系统中最容易的实现方式是通过动态连接库机制。

Lua 使用 loadlib() 函数来提供所有的动态连接的功能。

loadlib() 函数有两个参数: 库的绝对路径和初始化函数。

典型的调用 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\\lua5.3\\luasocket.dll"，这是 Window 平台下
local f = assert(loadlib(path, "luaopen_socket"))
f()  -- 调用初始化函数初始化模块

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

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