Lua 中的模块与 module 函数

这篇文章主要介绍了 Lua 中的模块 (module) 和包 (package) 详解,本文讲解了 require 函数、写一个模块、package.loaded、module 函数等内容.

从 Lua5.1 版本开始，就对模块和包添加了新的支持，可是使用 require 和 module 来定义和使用模块和包。require 用于使用模块，module 用于创建模块。简单的说，一个模块就是一个程序库，可以通过 require 来加载。然后便得到了一个全局变量，表示一个 table。这个 table 就像是一个命名空间，其内容就是模块中导出的所有东西，比如函数和常量，一个符合规范的模块还应使 require 返回这个 table。现在就来具体的总结一下 require 和 module 这两个函数。如：

require "mod"
mod.foo()
local m2 = require "mod2"
local f = mod2.foo
f()

1. require 函数：

require 函数的调用形式为 require "模块名"。该调用会返回一个由模块函数组成的 table，并且还会定义一个包含该 table 的全局变量。在使用 Lua 中的标准库时可以不用显示的调用 require，因为 Lua 已经预先加载了他们。

require 函数在搜素加载模块时，有一套自定义的模式，如：
?;?.lua;c:/windows/?;/usr/local/lua/?/?.lua
在上面的模式中，只有问号 (?) 和分号 (;) 是模式字符，分别表示 require 函数的参数(模块名)和模式间的分隔符。如：调用 require "sql"，将会打开以下的文件：
sql
sql.lua
c:/windows/sql
/usr/local/lua/sql/sql.lua
Lua 将 require 搜索的模式字符串放在变量 package.path 中。当 Lua 启动后，便以环境变量 LUA_PATH 的值来初始化这个变量。如果没有找到该环境变量，则使用一个编译时定义的默认路径来初始化。如果 require 无法找到与模块名相符的 Lua 文件，就会找 C 程序库。C 程序库的搜索模式存放在变量 package.cpath 中。而这个变量则是通过环境变量 LUA_CPATH 来初始化的。

 2. 编写模块的基本方法：

新建一个文件，命名为 game.lua，代码如下：

local M = {};
local modelName = ...;
_G[modelName] = M;
function M.play()
    print("那么，开始吧");
end
function M.quit()
    print("你走吧，我保证你不会出事的，呵，呵呵");
end
return M;

加载 game.lua，代码如下：

game = require "test"

game.play()

运行：

lua -e "io.stdout:setvbuf 'no'" "HelloWorld.lua" 
那么，开始吧
Exit code: 0

3. 使用环境：

仔细阅读上例中的代码，我们可以发现一些细节上问题。比如模块内函数之间的调用仍然要保留模块名的限定符，如果是私有变量还需要加 local 关键字，同时不能加模块名限定符。如果需要将私有改为公有，或者反之，都需要一定的修改。那又该如何规避这些问题呢？我们可以通过Lua的函数“全局环境”来有效的解决这些问题。

我们把 game.lua 这个模块里的全局环境设置为 M，于是，我们直接定义函数的时候，不需要再带 M 前缀。
因为此时的全局环境就是 M，不带前缀去定义变量，就是全局变量，这时的全局变量是保存在 M 里。
所以，实际上，play 和 quit 函数仍然是在 M 这个 table 里。

local M = {};
local modelName = ...;
_G[modelName] = M;
package.loaded[modname] = M
setfenv(1, M);
function play()
    print("那么，开始吧");
end
function quit()
    print("你走吧，我保证你不会出事的，呵，呵呵");
end
return M;

4. module 函数：

在 Lua 5.1中，我们可以用 module(...) 函数来代替以下代码，如：

local modname = ...
local M = {}
_G[modname] = M
package.loaded[modname] = M
     --[[
     和普通Lua程序块一样声明外部函数。
     --]]
setfenv(1,M)

  即是：

module(..., package.seeall);

function play()
    print("那么，开始吧")
end

function quit()
    print("你走吧，我保证你不会出事的，呵，呵呵");
end

由于在默认情况下，module 不提供外部访问，必须在调用它之前，为需要访问的外部函数或模块声明适当的局部变量。然后 Lua 提供了一种更为方便的实现方式，即在调用 module 函数时，多传入一个 package.seeall 的参数，相当于 setmetatable(M, {__index = _G}) .

如：

module(...,package.seeall)