Lua 中的模塊與 module 函數(shù)

這篇文章主要介紹了 Lua 中的模塊 (module) 和包 (package) 詳解,本文講解了 require 函數(shù)、寫(xiě)一個(gè)模塊、package.loaded、module 函數(shù)等內(nèi)容.

從 Lua5.1 版本開(kāi)始，就對(duì)模塊和包添加了新的支持，可是使用 require 和 module 來(lái)定義和使用模塊和包。require 用于使用模塊，module 用于創(chuàng)建模塊。簡(jiǎn)單的說(shuō)，一個(gè)模塊就是一個(gè)程序庫(kù)，可以通過(guò) require 來(lái)加載。然后便得到了一個(gè)全局變量，表示一個(gè) table。這個(gè) table 就像是一個(gè)命名空間，其內(nèi)容就是模塊中導(dǎo)出的所有東西，比如函數(shù)和常量，一個(gè)符合規(guī)范的模塊還應(yīng)使 require 返回這個(gè) table?，F(xiàn)在就來(lái)具體的總結(jié)一下 require 和 module 這兩個(gè)函數(shù)。如：

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

1. require 函數(shù)：

require 函數(shù)的調(diào)用形式為 require "模塊名"。該調(diào)用會(huì)返回一個(gè)由模塊函數(shù)組成的 table，并且還會(huì)定義一個(gè)包含該 table 的全局變量。在使用 Lua 中的標(biāo)準(zhǔn)庫(kù)時(shí)可以不用顯示的調(diào)用 require，因?yàn)?Lua 已經(jīng)預(yù)先加載了他們。

require 函數(shù)在搜素加載模塊時(shí)，有一套自定義的模式，如：
?;?.lua;c:/windows/?;/usr/local/lua/?/?.lua
在上面的模式中，只有問(wèn)號(hào) (?) 和分號(hào) (;) 是模式字符，分別表示 require 函數(shù)的參數(shù)(模塊名)和模式間的分隔符。如：調(diào)用 require "sql"，將會(huì)打開(kāi)以下的文件：
sql
sql.lua
c:/windows/sql
/usr/local/lua/sql/sql.lua
Lua 將 require 搜索的模式字符串放在變量 package.path 中。當(dāng) Lua 啟動(dòng)后，便以環(huán)境變量 LUA_PATH 的值來(lái)初始化這個(gè)變量。如果沒(méi)有找到該環(huán)境變量，則使用一個(gè)編譯時(shí)定義的默認(rèn)路徑來(lái)初始化。如果 require 無(wú)法找到與模塊名相符的 Lua 文件，就會(huì)找 C 程序庫(kù)。C 程序庫(kù)的搜索模式存放在變量 package.cpath 中。而這個(gè)變量則是通過(guò)環(huán)境變量 LUA_CPATH 來(lái)初始化的。

 2. 編寫(xiě)模塊的基本方法：

新建一個(gè)文件，命名為 game.lua，代碼如下：

local M = {};
local modelName = ...;
_G[modelName] = M;
function M.play()
    print("那么，開(kāi)始吧");
end
function M.quit()
    print("你走吧，我保證你不會(huì)出事的，呵，呵呵");
end
return M;

加載 game.lua，代碼如下：

game = require "test"

game.play()

運(yùn)行：

lua -e "io.stdout:setvbuf 'no'" "HelloWorld.lua" 
那么，開(kāi)始吧
Exit code: 0

3. 使用環(huán)境：

仔細(xì)閱讀上例中的代碼，我們可以發(fā)現(xiàn)一些細(xì)節(jié)上問(wèn)題。比如模塊內(nèi)函數(shù)之間的調(diào)用仍然要保留模塊名的限定符，如果是私有變量還需要加 local 關(guān)鍵字，同時(shí)不能加模塊名限定符。如果需要將私有改為公有，或者反之，都需要一定的修改。那又該如何規(guī)避這些問(wèn)題呢？我們可以通過(guò)Lua的函數(shù)“全局環(huán)境”來(lái)有效的解決這些問(wèn)題。

我們把 game.lua 這個(gè)模塊里的全局環(huán)境設(shè)置為 M，于是，我們直接定義函數(shù)的時(shí)候，不需要再帶 M 前綴。
因?yàn)榇藭r(shí)的全局環(huán)境就是 M，不帶前綴去定義變量，就是全局變量，這時(shí)的全局變量是保存在 M 里。
所以，實(shí)際上，play 和 quit 函數(shù)仍然是在 M 這個(gè) table 里。

local M = {};
local modelName = ...;
_G[modelName] = M;
package.loaded[modname] = M
setfenv(1, M);
function play()
    print("那么，開(kāi)始吧");
end
function quit()
    print("你走吧，我保證你不會(huì)出事的，呵，呵呵");
end
return M;

4. module 函數(shù)：

在 Lua 5.1中，我們可以用 module(...) 函數(shù)來(lái)代替以下代碼，如：

local modname = ...
local M = {}
_G[modname] = M
package.loaded[modname] = M
     --[[
     和普通Lua程序塊一樣聲明外部函數(shù)。
     --]]
setfenv(1,M)

  即是：

module(..., package.seeall);

function play()
    print("那么，開(kāi)始吧")
end

function quit()
    print("你走吧，我保證你不會(huì)出事的，呵，呵呵");
end

由于在默認(rèn)情況下，module 不提供外部訪問(wèn)，必須在調(diào)用它之前，為需要訪問(wèn)的外部函數(shù)或模塊聲明適當(dāng)?shù)木植孔兞?。然?Lua 提供了一種更為方便的實(shí)現(xiàn)方式，即在調(diào)用 module 函數(shù)時(shí)，多傳入一個(gè) package.seeall 的參數(shù)，相當(dāng)于 setmetatable(M, {__index = _G}) .

如：

module(...,package.seeall)