35、Lua 中的模块与module函数

Lua 中的模块与module函数

require函数
编写模块的基本方法
使用环境
module函数

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

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

lua 复制代码

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

require函数

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

equire函数在搜素加载模块时，有一套自定义的模式，如：

lua 复制代码

?;?.lua;c:/windows/?;/usr/local/lua/?/?.lua

在上面的模式中，只有问号(?)和分号(;)是模式字符，分别表示require函数的参数(模块名)和模式间的分隔符。如：调用require "sql"，将会打开以下的文件：

lua 复制代码

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来初始化的。

编写模块的基本方法

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

lua 复制代码

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

加载game.lua，代码如下

lua 复制代码

game = require "test"

game.play()

运行

lua 复制代码

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

使用环境

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

我们把game.lua这个模块里的全局环境设置为M，于是，我们直接定义函数的时候，不需要再带M前缀。

因为此时的全局环境就是M，不带前缀去定义变量，就是全局变量，这时的全局变量是保存在M里。

所以，实际上，play和quit函数仍然是在M这个table里。

lua 复制代码

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

module函数

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

lua 复制代码

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

即是

lua 复制代码

module(..., package.seeall);

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

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

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

如:

lua 复制代码

module(...,package.seeall)