Lua中提供的元表是用于幫助Lua數據變量完成某些非預定義功能的個性化行為,如兩個table的相加。假設a和b都是table,通過元表可以定義如何計算表達式a+b。當Lua試圖將兩個table相加時,它會先檢查兩者之一是否有元表,然后檢查該元表中是否存在__add字段,如果有,就調用該字段對應的值。這個值就是所謂的“元方法”,這個函數用于計算table的和。
Lua中每個值都有一個元表。table和userdata可以有各自獨立的元表,而其它數據類型的值則共享其類型所屬的單一元表。缺省情況下,table在創建時沒有元表,如:
t = {}
print(getmetatable(t)) --輸出為nil
這里我們可以使用setmetatable函數來設置或修改任何table的元表。
t1 = {}
setmetatable(t,t1)
assert(getmetatable(t) == t1)
任何table都可以作為任何值的元表,而一組相關的table也可以共享一個通用的元表,此元表將描述了它們共同的行為。一個table甚至可以作為它自己的元表,用于描述其特有的行為。在Lua代碼中,只能設置table的元表,若要設置其它類型值的元表,則必須通過C代碼來完成。
1. 算術類的元方法:
在下面的示例代碼中,將用table來表示集合,并且有一些函數用來計算集合的并集和交集等。

1 Set = {}
2 local metatable = {} --元表
3
4 --根據參數列表中的值創建一個新的集合
5 function Set.new(l)
6 local set = {}
7 --將所有由該方法創建的集合的元表都指定到metatable
8 setmetatable(set,metatable)
9 for _, v in ipairs(l) do
10 set[v] = true
11 end
12 return set
13 end
14
15 --取兩個集合并集的函數
16 function Set.union(a,b)
17 local res = Set.new{}
18 for k in pairs(a) do
19 res[k] = true
20 end
21 for k in pairs(b) do
22 res[k] = true
23 end
24 return res
25 end
26
27 --取兩個集合交集的函數
28 function Set.intersection(a,b)
29 local res = Set.new{}
30 for k in pairs(a) do
31 res[k] = b[k]
32 end
33 return res
34 end
35
36 function Set.tostring(set)
37 local l = {}
38 for e in pairs(set) do
39 l[#l + 1] = e
40 end
41 return "{" .. table.concat(l,", ") .. "}";
42 end
43
44 function Set.print(s)
45 print(Set.tostring(s))
46 end
47
48 --最后將元方法加入到元表中,這樣當兩個由Set.new方法創建出來的集合進行
49 --加運算時,將被重定向到Set.union方法,乘法運算將被重定向到Set.intersection
50 metatable.__add = Set.union
51 metatable.__mul = Set.intersection
52
53 --下面為測試代碼
54 s1 = Set.new{10,20,30,50}
55 s2 = Set.new{30,1}
56 s3 = s1 + s2
57 Set.print(s3)
58 Set.print(s3 * s1)
59
60 --輸出結果為:
61 --{1, 30, 10, 50, 20}
62 --{30, 10, 50, 20}

在元表中,每種算術操作符都有對應的字段名,除了上述的__add(加法)和__mul(乘法)外,還有__sub(減法)、__div(除法)、__unm(相反數)、__mod(取模)和__pow(乘冪)。此外,還可以定義__concat字段,用于描述連接操作符的行為。
對于上面的示例代碼,我們在算術運算符的兩側均使用了table類型的操作數。那么如果為s1 = s1 + 8,Lua是否還能正常工作呢?答案是肯定的,因為Lua定位元表的步驟為,如果第一個值有元表,且存在__add字段,那么Lua將以這個字段為元方法,否則會再去查看第二個值否是有元表且包含__add字段,如果有則以此字段為元方法。最后,如果兩個值均不存在元方法,Lua就引發一個錯誤。然而對于上例中的Set.union函數,如果執行s1 = s1 + 8將會引發一個錯誤,因為8不是table對象,不能基于它執行pairs方法調用。為了得到更準確的錯誤信息,我們需要給Set.union函數做如下的修改,如:
1 function Set.union(a,b)
2 if getmetatable(a) ~= metatable or getmetatable(b) ~= metatable then
3 error("attempt to 'add' a set with a non-set value")
4 end
5 --后面的代碼與上例相同。
6 ... ...
7 end
2. 關系類的元方法:
元表還可以指定關系操作符的含義,元方法分別為__eq(等于)、__lt(小于)和__le(小于等于),至于另外3個關系操作符,Lua沒有提供相關的元方法,可以通過前面3個關系運算符的取反獲得。見如下示例:
1 Set = {}
2 local metatable = {}
3
4 function Set.new(l)
5 local set = {}
6 setmetatable(set,metatable)
7 for _, v in ipairs(l) do
8 set[v] = true
9 end
10 return set
11 end
12
13 metatable.__le = function(a,b)
14 for k in pairs(a) do
15 if not b[k] then return false end
16 end
17 return true
18 end
19 metatable.__lt = function(a,b) return a <= b and not (b <= a) end
20 metatable.__eq = function(a,b) return a <= b and b <= a end
21
22 --下面是測試代碼:
23 s1 = Set.new{2,4}
24 s2 = Set.new{4,10,2}
25 print(s1 <= s2) --true
26 print(s1 < s2) --true
27 print(s1 >= s1) --true
28 print(s1 > s1) --false
與算術類的元方法不同,關系類的元方法不能應用于混合的類型。
3. 庫定義的元方法:
除了上述基于操作符的元方法外,Lua還提供了一些針對框架的元方法,如print函數總是調用tostring來格式化其輸出。如果當前對象存在__tostring元方法時,tostring將用該元方法的返回值作為自己的返回值,如:
1 Set = {}
2 local metatable = {}
3
4 function Set.new(l)
5 local set = {}
6 setmetatable(set,metatable)
7 for _, v in ipairs(l) do
8 set[v] = true
9 end
10 return set
11 end
12
13 function Set.tostring(set)
14 local l = {}
15 for e in pairs(set) do
16 l[#l + 1] = e
17 end
18 return "{" .. table.concat(l,", ") .. "}";
19 end
20
21 metatable.__tostring = Set.tostring
22
23
24 --下面是測試代碼:
25 s1 = Set.new{4,5,10}
26 print(s1) --{5,10,4}
函數setmetatable和getmetatable也會用到元表中的一個字段(__metatable),用于保護元表,如:
1 mt.__metatable = "not your business"
2 s1 = Set.new{}
3 print(getmetatable(s1)) --此時將打印"not your business"
4 setmetatable(s1,{}) --此時將輸出錯誤信息:"cannot change protected metatable"
從上述代碼的輸出結果即可看出,一旦設置了__metatable字段,getmetatable就會返回這個字段的值,而setmetatable將引發一個錯誤。
4. table訪問的元方法:
算術類和關系類運算符的元方法都為各種錯誤情況定義了行為,它們不會改變語言的常規行為。但是Lua還提供了一種可以改變table行為的方法。有兩種可以改變的table行為:查詢table及修改table中不存在的字段。
1). __index元方法:
當訪問table中不存在的字段時,得到的結果為nil。如果我們為該table定義了元方法__index,那個訪問的結果將由該方法決定。見如下示例代碼:
1 Window = {}
2 Window.prototype = {x = 0, y = 0, width = 100, height = 100}
3 Window.mt = {} --Window的元表
4
5 function Window.new(o)
6 setmetatable(o,Window.mt)
7 return o
8 end
9
10 --將Window的元方法__index指向一個匿名函數
11 --匿名函數的參數table和key取自于table.key。
12 Window.mt.__index = function(table,key) return Window.prototype[key] end
13
14 --下面是測試代碼:
15 w = Window.new{x = 10, y = 20}
16 print(w.width) --輸出100
17 print(w.width1) --由于Window.prototype變量中也不存在該字段,因此返回nil。
最后,Lua為__index元方法提供了一種更為簡潔的表示方式,如:Window.mt.__index = Window.prototype。該方法等價于上例中的匿名函數表示方法。相比而言,這種簡潔的方法執行效率更高,但是函數的方法擴展性更強。
如果想在訪問table時禁用__index元方法,可以通過函數rawget(table,key)完成。通過該方法并不會加速table的訪問效率。
2). __newindex元方法:
和__index不同的是,該元方法用于不存在鍵的賦值,而前者則用于訪問。當對一個table中不存在的索引賦值時,解釋器就會查找__newindex元方法。如果有就調用它,而不是直接賦值。如果這個元方法指向一個table,Lua將對此table賦值,而不是對原有的table賦值。此外,和__index一樣,Lua也同樣提供了避開元方法而直接操作當前table的函數rawset(table,key,value),其功能類似于rawget(table,key)。
3). 具有默認值的table:
缺省情況下,table的字段默認值為nil。但是我們可以通過元表修改這個默認值,如:
1 function setDefault(table,default)
2 local mt = {__index = function() return default end }
3 setmetatable(table,mt)
4 end
5 tab = {x = 10, y = 20}
6 print(tab.x,tab.z) --10 nil
7 setDefault(tab,0)
8 print(tab.x,tab.z) --10 0
4). 跟蹤table的訪問:
__index和__newindex都是在table中沒有所需訪問的index時才發揮作用的。因此,為了監控某個table的訪問狀況,我們可以為其提供一個空table作為代理,之后再將__index和__newindex元方法重定向到原來的table上,見如下代碼:
1 t = {} --原來的table
2 local _t = t --保持對原有table的私有訪問。
3 t = {} --創建代理
4 --創建元表
5 local mt = {
6 __index = function(table,key)
7 print("access to element " .. tostring(key))
8 return _t[key] --通過訪問原來的表返回字段值
9 end,
10
11 __newindex = function(table,key,value)
12 print("update of element " .. tostring(key) .. " to " .. tostring(value))
13 _t[key] = value --更新原來的table
14 end
15 }
16 setmetatable(t,mt)
17
18 t[2] = "hello"
19 print(t[2])
20
21 --輸出結果為
22 --update of element 2 to hello
23 --access to element 2
24 --hello
5). 只讀的table:
通過代理的概念,可以很容易的實現只讀table。只需跟蹤所有對table的更新操作,并引發一個錯誤即可,見如下示例代碼:
1 function readOnly(t)
2 local proxy = {}
3 local mt = {
4 __index = t,
5 __newindex = function(t,k,v)
6 error("attempt to update a read-only table")
7 end
8 }
9 setmetatable(proxy,mt)
10 return proxy
11 end
12
13 days = readOnly{"Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"}
14 print(days[1])
15 days[2] = "Noday"
16
17 --輸出結果為:
18 --[[
19 Sunday
20 lua: d:/test.lua:6: attempt to update a read-only table
21 stack traceback:
22 [C]: in function 'error'
23 d:/test.lua:6: in function <d:/test.lua:5>
24 d:/test.lua:15: in main chunk
25 [C]: ?
26 ]]--