這篇文章主要介紹了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()
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來初始化的。
新建一個文件,命名為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
仔細閱讀上例中的代碼,我們可以發現一些細節上問題。比如模塊內函數之間的調用仍然要保留模塊名的限定符,如果是私有變量還需要加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;
在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)