前言
元表對(duì)應(yīng)的英文是metatable，元方法是metamethod。我們都知道，在C++中，兩個(gè)類是無(wú)法直接相加的，但是，如果你重載了“+”符號(hào)，就可以進(jìn)行類的加法運(yùn)算。在Lua中也有這個(gè)道理，兩個(gè)table類型的變量，你是無(wú)法直接進(jìn)行“+”操作的，如果你定義了一個(gè)指定的函數(shù)，就可以進(jìn)行了。那這篇博文就是主要講的如何定義這個(gè)指定的函數(shù)，這個(gè)指定的函數(shù)是什么？希望對(duì)學(xué)習(xí)Lua的朋友有幫助。
Lua是怎么做的？
通常，Lua中的每個(gè)值都有一套預(yù)定義的操作集合，比如數(shù)字是可以相加的，字符串是可以連接的，但是對(duì)于兩個(gè)table類型，則不能直接進(jìn)行“+”操作。這需要我們進(jìn)行一些操作。在Lua中有一個(gè)元表，也就是上面說(shuō)的metatable，我們可以通過(guò)元表來(lái)修改一個(gè)值得行為，使其在面對(duì)一個(gè)非預(yù)定義的操作時(shí)執(zhí)行一個(gè)指定的操作。比如，現(xiàn)在有兩個(gè)table類型的變量a和b，我們可以通過(guò)metatable定義如何計(jì)算表達(dá)式a+b，具體的在Lua中是按照以下步驟進(jìn)行的：
先判斷a和b兩者之一是否有元表；
檢查該元表中是否有一個(gè)叫__add的字段；
如果找到了該字段，就調(diào)用該字段對(duì)應(yīng)的值，這個(gè)值對(duì)應(yīng)的是一個(gè)metamethod；（Lua中方法是可以放在一個(gè)字段中的，還記得？？？忘了點(diǎn)這里）
調(diào)用__add對(duì)應(yīng)的metamethod計(jì)算a和b的值。
上述四個(gè)步驟就是計(jì)算table類型變量a+b的過(guò)程。在Lua中，每個(gè)值都有一個(gè)元表，table和userdata類型的每個(gè)變量都可以有各自獨(dú)立的元表，而其他類型的值則共享其類型所屬的單一元表。
告別metatable小白
現(xiàn)在就說(shuō)說(shuō)最基本的metatable內(nèi)容。Lua在創(chuàng)建新的table時(shí)不會(huì)創(chuàng)建元表，比如以下代碼就可以演示：
復(fù)制代碼 代碼如下:
local t = {1, 2}
print(getmetatable(t)) -- nil
我們是使用getmetatable來(lái)獲取一個(gè)table或userdata類型變量的元表，當(dāng)創(chuàng)建新的table變量時(shí)，使用getmetatable去獲得元表，將返回nil；同理，我們也可以使用setmetatable去設(shè)置一個(gè)table或userdata類型變量的元表，例如以下代碼：
復(fù)制代碼 代碼如下:
local t = {}
print(getmetatable(t)) -->nil
local t1 = {}
setmetatable(t, t1)
assert(getmetatable(t) == t1)
任何table都可以作為任何值得元表，而一組相關(guān)的table有可以共享一個(gè)通用的元表，此元表描述了它們共同的行為。一個(gè)table甚至可以作為它自己的元表，用于描述其特有的行為。總之，任何搭配形式都是合法的。
在Lua代碼中，只能設(shè)置table的元表。若要設(shè)置其它類型的值得元表，則必須通過(guò)C代碼來(lái)完成。還存在一個(gè)特例，對(duì)于字符串，標(biāo)準(zhǔn)的字符串程序庫(kù)為所有的字符串都設(shè)置了一個(gè)元表，而其它類型在默認(rèn)情況下都沒(méi)有元表。查看兩句代碼的打印值，就可以看出來(lái)：
復(fù)制代碼 代碼如下:
print(getmetatable("Hello World"))
print(getmetatable(10))
在table中，我可以重新定義的元方法有以下幾個(gè)：
復(fù)制代碼 代碼如下:
__add(a, b) --加法
__sub(a, b) --減法
__mul(a, b) --乘法
__div(a, b) --除法
__mod(a, b) --取模
__pow(a, b) --乘冪
__unm(a) --相反數(shù)
__concat(a, b) --連接
__len(a) --長(zhǎng)度
__eq(a, b) --相等
__lt(a, b) --小于
__le(a, b) --小于等于
__index(a, b) --索引查詢
__newindex(a, b, c) --索引更新（PS：不懂的話，后面會(huì)有講）
__call(a, ...) --執(zhí)行方法調(diào)用
__tostring(a) --字符串輸出
__metatable --保護(hù)元表
接下來(lái)就介紹介紹如果去重新定義這些方法。
算術(shù)類的元方法
現(xiàn)在我使用完整的實(shí)例代碼來(lái)詳細(xì)的說(shuō)明算術(shù)類元方法的使用。我準(zhǔn)備定義一些對(duì)集合的操作方法，所有的方法都放入Set這個(gè)table中，至于為什么table中可以存放函數(shù)，可以參考《Lua中的函數(shù)》這篇文章。下面的代碼是我模擬的一個(gè)集合的操作：
復(fù)制代碼 代碼如下:
Set = {}
local mt = {} -- 集合的元表
-- 根據(jù)參數(shù)列表中的值創(chuàng)建一個(gè)新的集合
function Set.new(l)
local set = {}
setmetatable(set, mt)
for _, v in pairs(l) do set[v] = true end
return set
end
-- 并集操作
function Set.union(a, b)
local retSet = Set.new{} -- 此處相當(dāng)于Set.new({})
for v in pairs(a) do retSet[v] = true end
for v in pairs(b) do retSet[v] = true end
return retSet
end
-- 交集操作
function Set.intersection(a, b)
local retSet = Set.new{}
for v in pairs(a) do retSet[v] = b[v] end
return retSet
end
-- 打印集合的操作
function Set.toString(set)
local tb = {}
for e in pairs(set) do
tb[#tb + 1] = e
end
return "{" .. table.concat(tb, ", ") .. "}"
end
function Set.print(s)
print(Set.toString(s))
end
現(xiàn)在，我定義“+”來(lái)計(jì)算兩個(gè)集合的并集，那么就需要讓所有用于表示集合的table共享一個(gè)元表，并且在該元表中定義如何執(zhí)行一個(gè)加法操作。首先創(chuàng)建一個(gè)常規(guī)的table，準(zhǔn)備用作集合的元表，然后修改Set.new函數(shù)，在每次創(chuàng)建集合的時(shí)候，都為新的集合設(shè)置一個(gè)元表。代碼如下：
復(fù)制代碼 代碼如下:
Set = {}
local mt = {} -- 集合的元表
-- 根據(jù)參數(shù)列表中的值創(chuàng)建一個(gè)新的集合
function Set.new(l)
local set = {}
setmetatable(set, mt)
for _, v in pairs(l) do set[v] = true end
return set
end
在此之后，所有由Set.new創(chuàng)建的集合都具有一個(gè)相同的元表，例如：
復(fù)制代碼 代碼如下:
local set1 = Set.new({10, 20, 30})
local set2 = Set.new({1, 2})
print(getmetatable(set1))
print(getmetatable(set2))
assert(getmetatable(set1) == getmetatable(set2))
最后，我們需要把元方法加入元表中，代碼如下：
復(fù)制代碼 代碼如下:
mt.__add = Set.union
這以后，只要我們使用“+”符號(hào)求兩個(gè)集合的并集，它就會(huì)自動(dòng)的調(diào)用Set.union函數(shù)，并將兩個(gè)操作數(shù)作為參數(shù)傳入。比如以下代碼：
復(fù)制代碼 代碼如下:
local set1 = Set.new({10, 20, 30})
local set2 = Set.new({1, 2})
local set3 = set1 + set2
Set.print(set3)
在上面列舉的那些可以重定義的元方法都可以使用上面的方法進(jìn)行重定義。現(xiàn)在就出現(xiàn)了一個(gè)新的問(wèn)題，set1和set2都有元表，那我們要用誰(shuí)的元表啊？雖然我們這里的示例代碼使用的都是一個(gè)元表，但是實(shí)際coding中，會(huì)遇到我這里說(shuō)的問(wèn)題，對(duì)于這種問(wèn)題，Lua是按照以下步驟進(jìn)行解決的：
1.對(duì)于二元操作符，如果第一個(gè)操作數(shù)有元表，并且元表中有所需要的字段定義，比如我們這里的__add元方法定義，那么Lua就以這個(gè)字段為元方法，而與第二個(gè)值無(wú)關(guān)；
2.對(duì)于二元操作符，如果第一個(gè)操作數(shù)有元表，但是元表中沒(méi)有所需要的字段定義，比如我們這里的__add元方法定義，那么Lua就去查找第二個(gè)操作數(shù)的元表；
3.如果兩個(gè)操作數(shù)都沒(méi)有元表，或者都沒(méi)有對(duì)應(yīng)的元方法定義，Lua就引發(fā)一個(gè)錯(cuò)誤。
以上就是Lua處理這個(gè)問(wèn)題的規(guī)則，那么我們?cè)趯?shí)際編程中該如何做呢？比如set3 = set1 + 8這樣的代碼，就會(huì)打印出以下的錯(cuò)誤提示：
復(fù)制代碼 代碼如下:
lua: test.lua:16: bad argument #1 to 'pairs' (table expected, got number)
但是，我們?cè)趯?shí)際編碼中，可以按照以下方法，彈出我們定義的錯(cuò)誤消息，代碼如下：
復(fù)制代碼 代碼如下:
function Set.union(a, b)
if getmetatable(a) ~= mt or getmetatable(b) ~= mt then
error("metatable error.")
end
local retSet = Set.new{} -- 此處相當(dāng)于Set.new({})
for v in pairs(a) do retSet[v] = true end
for v in pairs(b) do retSet[v] = true end
return retSet
end
當(dāng)兩個(gè)操作數(shù)的元表不是同一個(gè)元表時(shí)，就表示二者進(jìn)行并集操作時(shí)就會(huì)出現(xiàn)問(wèn)題，那么我們就可以打印出我們需要的錯(cuò)誤消息。
上面總結(jié)了算術(shù)類的元方法的定義，關(guān)系類的元方法和算術(shù)類的元方法的定義是類似的，這里不做累述。
__tostring元方法
寫過(guò)Java或者C#的人都知道，Object類中都有一個(gè)tostring的方法，程序員可以重寫該方法，以實(shí)現(xiàn)自己的需求。在Lua中，也是這樣的，當(dāng)我們直接print(a)（a是一個(gè)table）時(shí)，是不可以的。那怎么辦，這個(gè)時(shí)候，我們就需要自己重新定義__tostring元方法，讓print可以格式化打印出table類型的數(shù)據(jù)。
函數(shù)print總是調(diào)用tostring來(lái)進(jìn)行格式化輸出，當(dāng)格式化任意值時(shí)，tostring會(huì)檢查該值是否有一個(gè)__tostring的元方法，如果有這個(gè)元方法，tostring就用該值作為參數(shù)來(lái)調(diào)用這個(gè)元方法，剩下實(shí)際的格式化操作就由__tostring元方法引用的函數(shù)去完成，該函數(shù)最終返回一個(gè)格式化完成的字符串。例如以下代碼：
復(fù)制代碼 代碼如下:
mt.__tostring = Set.toString
如何保護(hù)我們的“奶酪”——元表
我們會(huì)發(fā)現(xiàn)，使用getmetatable就可以很輕易的得到元表，使用setmetatable就可以很容易的修改元表，那這樣做的風(fēng)險(xiǎn)是不是太大了，那么如何保護(hù)我們的元表不被篡改呢？
在Lua中，函數(shù)setmetatable和getmetatable函數(shù)會(huì)用到元表中的一個(gè)字段，用于保護(hù)元表，該字段是__metatable。當(dāng)我們想要保護(hù)集合的元表，是用戶既不能看也不能修改集合的元表，那么就需要使用__metatable字段了；當(dāng)設(shè)置了該字段時(shí)，getmetatable就會(huì)返回這個(gè)字段的值，而setmetatable則會(huì)引發(fā)一個(gè)錯(cuò)誤；如以下演示代碼：
復(fù)制代碼 代碼如下:
function Set.new(l)
local set = {}
setmetatable(set, mt)
for _, v in pairs(l) do set[v] = true end
mt.__metatable = "You cannot get the metatable" -- 設(shè)置完我的元表以后，不讓其他人再設(shè)置
return set
end
local tb = Set.new({1, 2})
print(tb)
print(getmetatable(tb))
setmetatable(tb, {})
上述代碼就會(huì)打印以下內(nèi)容：
復(fù)制代碼 代碼如下:
{1, 2}
You cannot get the metatable
lua: test.lua:56: cannot change a protected metatable
__index元方法
是否還記得當(dāng)我們?cè)L問(wèn)一個(gè)table中不存在的字段時(shí)，會(huì)返回什么值？默認(rèn)情況下，當(dāng)我們?cè)L問(wèn)一個(gè)table中不存在的字段時(shí)，得到的結(jié)果是nil。但是這種狀況很容易被改變；Lua是按照以下的步驟決定是返回nil還是其它值得：
1.當(dāng)訪問(wèn)一個(gè)table的字段時(shí)，如果table有這個(gè)字段，則直接返回對(duì)應(yīng)的值；
2.當(dāng)table沒(méi)有這個(gè)字段，則會(huì)促使解釋器去查找一個(gè)叫__index的元方法，接下來(lái)就就會(huì)調(diào)用對(duì)應(yīng)的元方法，返回元方法返回的值；
3.如果沒(méi)有這個(gè)元方法，那么就返回nil結(jié)果。
下面通過(guò)一個(gè)實(shí)際的例子來(lái)說(shuō)明__index的使用。假設(shè)要?jiǎng)?chuàng)建一些描述窗口，每個(gè)table中都必須描述一些窗口參數(shù)，例如顏色，位置和大小等，這些參數(shù)都是有默認(rèn)值得，因此，我們?cè)趧?chuàng)建窗口對(duì)象時(shí)可以指定那些不同于默認(rèn)值得參數(shù)。
復(fù)制代碼 代碼如下:
Windows = {} -- 創(chuàng)建一個(gè)命名空間
-- 創(chuàng)建默認(rèn)值表
Windows.default = {x = 0, y = 0, width = 100, height = 100, color = {r = 255, g = 255, b = 255}}
Windows.mt = {} -- 創(chuàng)建元表
-- 聲明構(gòu)造函數(shù)
function Windows.new(o)
setmetatable(o, Windows.mt)
return o
end
-- 定義__index元方法
Windows.mt.__index = function (table, key)
return Windows.default[key]
end
local win = Windows.new({x = 10, y = 10})
print(win.x) -- >10 訪問(wèn)自身已經(jīng)擁有的值
print(win.width) -- >100 訪問(wèn)default表中的值
print(win.color.r) -- >255 訪問(wèn)default表中的值
根據(jù)上面代碼的輸出，結(jié)合上面說(shuō)的那三步，我們?cè)賮?lái)看看，print(win.x)時(shí)，由于win變量本身就擁有x字段，所以就直接打印了其自身?yè)碛械淖侄蔚闹担籶rint(win.width)，由于win變量本身沒(méi)有width字段，那么就去查找是否擁有元表，元表中是否有__index對(duì)應(yīng)的元方法，由于存在__index元方法，返回了default表中的width字段的值，print(win.color.r)也是同樣的道理。
在實(shí)際編程中，__index元方法不必一定是一個(gè)函數(shù)，它還可以是一個(gè)table。當(dāng)它是一個(gè)函數(shù)時(shí)，Lua以table和不存在key作為參數(shù)來(lái)調(diào)用該函數(shù)，這就和上面的代碼一樣；當(dāng)它是一個(gè)table時(shí)，Lua就以相同的方式來(lái)重新訪問(wèn)這個(gè)table，所以上面的代碼也可以是這樣的：
復(fù)制代碼 代碼如下:
-- 定義__index元方法
Windows.mt.__index = Windows.default
__newindex元方法
__newindex元方法與__index類似，__newindex用于更新table中的數(shù)據(jù)，而__index用于查詢table中的數(shù)據(jù)。當(dāng)對(duì)一個(gè)table中不存在的索引賦值時(shí)，在Lua中是按照以下步驟進(jìn)行的：
1.Lua解釋器先判斷這個(gè)table是否有元表；
2.如果有了元表，就查找元表中是否有__newindex元方法；如果沒(méi)有元表，就直接添加這個(gè)索引，然后對(duì)應(yīng)的賦值；
3.如果有這個(gè)__newindex元方法，Lua解釋器就執(zhí)行它，而不是執(zhí)行賦值；
4.如果這個(gè)__newindex對(duì)應(yīng)的不是一個(gè)函數(shù)，而是一個(gè)table時(shí)，Lua解釋器就在這個(gè)table中執(zhí)行賦值，而不是對(duì)原來(lái)的table。
那么這里就出現(xiàn)了一個(gè)問(wèn)題，看以下代碼：
復(fù)制代碼 代碼如下:
local tb1 = {}
local tb2 = {}
tb1.__newindex = tb2
tb2.__newindex = tb1
setmetatable(tb1, tb2)
setmetatable(tb2, tb1)
tb1.x = 10
發(fā)現(xiàn)什么問(wèn)題了么？是不是循環(huán)了，在Lua解釋器中，對(duì)這個(gè)問(wèn)題，就會(huì)彈出錯(cuò)誤消息，錯(cuò)誤消息如下：
復(fù)制代碼 代碼如下:
loop in settable
丟掉那該死的元表
有的時(shí)候，我們就不想從__index對(duì)應(yīng)的元方法中查詢值，我們也不想更新table時(shí)，也不想執(zhí)行__newindex對(duì)應(yīng)的方法，或者_(dá)_newindex對(duì)應(yīng)的table。那怎么辦？在Lua中，當(dāng)我們查詢table中的值，或者更新table中的值時(shí)，不想理那該死的元表，我們可以使用rawget函數(shù)，調(diào)用rawget(tb, i)就是對(duì)table tb進(jìn)行了一次“原始的（raw）”訪問(wèn)，也就是一次不考慮元表的簡(jiǎn)單訪問(wèn)；你可能會(huì)想，一次原始的訪問(wèn)，沒(méi)有訪問(wèn)__index對(duì)應(yīng)的元方法，可能有性能的提升，其實(shí)一次原始訪問(wèn)并不會(huì)加速代碼執(zhí)行的速度。對(duì)于__newindex元方法，可以調(diào)用rawset(t, k, v)函數(shù)，它可以不涉及任何元方法而直接設(shè)置table t中與key k相關(guān)聯(lián)的value v。
總結(jié)
這篇博文具體的總結(jié)了Lua中的元表和元方法，可以說(shuō)Lua中的元表和元方法是很多內(nèi)容的基礎(chǔ)，所以我在這里總結(jié)的很詳細(xì)，并結(jié)合了很多代碼。如果你有幸看到了這篇文章，希望你也花點(diǎn)時(shí)間認(rèn)真的讀一讀，想要理解Lua，玩轉(zhuǎn)Lua，當(dāng)然了，不能只是會(huì)一些語(yǔ)法，掌握元表和元方法是必不可少的。最后，也希望這篇文章對(duì)大家有用。下一篇博文，我會(huì)結(jié)合__index和__newindex說(shuō)一些實(shí)例代碼。
您可能感興趣的文章:- Lua教程（九）：元表與元方法詳解
- Lua中的元表(metatable)、元方法(metamethod)詳解
- 舉例說(shuō)明Lua中元表和元方法的使用
