這篇文章主要介紹了Lua中的模塊(module)和包(package)詳解,本文講解了require函數(shù)、寫一個(gè)模塊、package.loaded、module函數(shù)等內(nèi)容.
從Lua5.1版本開始,就對(duì)模塊和包添加了新的支持,可是使用require和module來定義和使用模塊和包。require用于使用模塊,module用于創(chuàng)建模塊。簡(jiǎn)單的說,一個(gè)模塊就是一個(gè)程序庫,可以通過require來加載。然后便得到了一個(gè)全局變量,表示一個(gè)table。這個(gè)table就像是一個(gè)命名空間,其內(nèi)容就是模塊中導(dǎo)出的所有東西,比如函數(shù)和常量,一個(gè)符合規(guī)范的模塊還應(yīng)使require返回這個(gè)table。現(xiàn)在就來具體的總結(jié)一下require和module這兩個(gè)函數(shù)。如:
require "mod"
mod.foo()
local m2 = require "mod2"
local f = mod2.foo
f()
require函數(shù)的調(diào)用形式為require "模塊名"。該調(diào)用會(huì)返回一個(gè)由模塊函數(shù)組成的table,并且還會(huì)定義一個(gè)包含該table的全局變量。在使用Lua中的標(biāo)準(zhǔn)庫時(shí)可以不用顯示的調(diào)用require,因?yàn)長(zhǎng)ua已經(jīng)預(yù)先加載了他們。
require函數(shù)在搜素加載模塊時(shí),有一套自定義的模式,如:
?;?.lua;c:/windows/?;/usr/local/lua/?/?.lua
在上面的模式中,只有問號(hào)(?)和分號(hào)(;)是模式字符,分別表示require函數(shù)的參數(shù)(模塊名)和模式間的分隔符。如:調(diào)用require "sql",將會(huì)打開以下的文件:
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的值來初始化這個(gè)變量。如果沒有找到該環(huán)境變量,則使用一個(gè)編譯時(shí)定義的默認(rèn)路徑來初始化。如果require無法找到與模塊名相符的Lua文件,就會(huì)找C程序庫。C程序庫的搜索模式存放在變量package.cpath中。而這個(gè)變量則是通過環(huán)境變量LUA_CPATH來初始化的。
新建一個(gè)文件,命名為game.lua,代碼如下:
local M = {};
local modelName = ...;
_G[modelName] = M;
function M.play()
print("那么,開始吧");
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"
那么,開始吧
Exit code: 0
仔細(xì)閱讀上例中的代碼,我們可以發(fā)現(xiàn)一些細(xì)節(jié)上問題。比如模塊內(nèi)函數(shù)之間的調(diào)用仍然要保留模塊名的限定符,如果是私有變量還需要加local關(guān)鍵字,同時(shí)不能加模塊名限定符。如果需要將私有改為公有,或者反之,都需要一定的修改。那又該如何規(guī)避這些問題呢?我們可以通過Lua的函數(shù)“全局環(huá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("那么,開始吧");
end
function quit()
print("你走吧,我保證你不會(huì)出事的,呵,呵呵");
end
return M;
在Lua 5.1中,我們可以用module(...)函數(shù)來代替以下代碼,如:
local modname = ...
local M = {}
_G[modname] = M
package.loaded[modname] = M
--[[
和普通Lua程序塊一樣聲明外部函數(shù)。
--]]
setfenv(1,M)
即是:
module(..., package.seeall);
function play()
print("那么,開始吧")
end
function quit()
print("你走吧,我保證你不會(huì)出事的,呵,呵呵");
end
由于在默認(rèn)情況下,module不提供外部訪問,必須在調(diào)用它之前,為需要訪問的外部函數(shù)或模塊聲明適當(dāng)?shù)木植孔兞俊H缓驦ua提供了一種更為方便的實(shí)現(xiàn)方式,即在調(diào)用module函數(shù)時(shí),多傳入一個(gè)package.seeall的參數(shù),相當(dāng)于 setmetatable(M, {__index = _G}) .
如:
module(...,package.seeall)