從Lua 5.1開始,我們可以使用require和module函數(shù)來獲取和創(chuàng)建Lua中的模塊。從使用者的角度來看,一個模塊就是一個程序庫,可以通過require來加載,之后便得到一個類型為table的全局變量。此時的table就像名字空間一樣,可以訪問其中的函數(shù)和常量,如:
1 require "mod"
2 mod.foo()
3 local m2 = require "mod2"
4 local f = mod2.foo
5 f()
1. require函數(shù):
require函數(shù)的調(diào)用形式為require "模塊名"。該調(diào)用會返回一個由模塊函數(shù)組成的table,并且還會定義一個包含該table的全局變量。在使用Lua中的標準庫時可以不用顯示的調(diào)用require,因為Lua已經(jīng)預先加載了他們。
require函數(shù)在搜素加載模塊時,有一套自定義的模式,如:
?;?.lua;c:/windows/?;/usr/local/lua/?/?.lua
在上面的模式中,只有問號(?)和分號(;)是模式字符,分別表示require函數(shù)的參數(shù)(模塊名)和模式間的分隔符。如:調(diào)用require "sql",將會打開以下的文件:
sql
sql.lua
c:/windows/sql
/usr/local/lua/sql/sql.lua
Lua將require搜索的模式字符串放在變量package.path中。當Lua啟動后,便以環(huán)境變量LUA_PATH的值來初始化這個變量。如果沒有找到該環(huán)境變量,則使用一個編譯時定義的默認路徑來初始化。如果require無法找到與模塊名相符的Lua文件,就會找C程序庫。C程序庫的搜索模式存放在變量package.cpath中。而這個變量則是通過環(huán)境變量LUA_CPATH來初始化的。
2. 編寫模塊的基本方法:
見如下代碼和關(guān)鍵性注釋:
1 --將模塊名設(shè)置為require的參數(shù),這樣今后重命名模塊時,只需重命名文件名即可。
2 local modname = ...
3 local M = {}
4 _G[modname] = M
5
6 M.i = {r = 0, i = 1} --定義一個模塊內(nèi)的常量。
7 function M.new(r,i) return {r = r, i = i} end
8 function M.add(c1,c2)
9 return M.new(c1.r + c2.r,c1.i + c2.i)
10 end
11
12 function M.sub(c1,c2)
13 return M.new(c1.r - c2.r,c1.i - c2.i)
14 end
15 --返回和模塊對應的table。
16 return M
3. 使用環(huán)境:
仔細閱讀上例中的代碼,我們可以發(fā)現(xiàn)一些細節(jié)上問題。比如模塊內(nèi)函數(shù)之間的調(diào)用仍然要保留模塊名的限定符,如果是私有變量還需要加local關(guān)鍵字,同時不能加模塊名限定符。如果需要將私有改為公有,或者反之,都需要一定的修改。那又該如何規(guī)避這些問題呢?我們可以通過Lua的函數(shù)“全局環(huán)境”來有效的解決這些問題。見如下修改的代碼和關(guān)鍵性注釋:
1 --模塊設(shè)置和初始化。這一點和上例一致。
2 local modname = ...
3 local M = {}
4 _G[modname] = M
5
6 --聲明這個模塊將會用到的全局函數(shù),因為在setfenv之后將無法再訪問他們,
7 --因此需要在設(shè)置之前先用本地變量獲取。
8 local sqrt = mat.sqrt
9 local io = io
10
11 --在這句話之后就不再需要外部訪問了。
12 setfenv(1,M)
13
14 --后面的函數(shù)和常量定義都無需模塊限定符了。
15 i = {r = 0, i = 1}
16 function new(r,i) return {r = r, i = i} end
17 function add(c1,c2)
18 return new(c1.r + c2.r,c1.i + c2.i)
19 end
20
21 function sub(c1,c2)
22 return new(c1.r - c2.r,c1.i - c2.i)
23 end
24 --返回和模塊對應的table。
25 return M
4. module函數(shù):
在Lua 5.1中,我們可以用module(...)函數(shù)來代替以下代碼,如:
1 local modname = ...
2 local M = {}
3 _G[modname] = M
4 package.loaded[modname] = M
5 --[[
6 和普通Lua程序塊一樣聲明外部函數(shù)。
7 --]]
8 setfenv(1,M)
由于在默認情況下,module不提供外部訪問,必須在調(diào)用它之前,為需要訪問的外部函數(shù)或模塊聲明適當?shù)木植孔兞?。然后Lua提供了一種更為方便的實現(xiàn)方式,即在調(diào)用module函數(shù)時,多傳入一個package.seeall的參數(shù),如:
module(...,package.seeall)