Lua 元表(Metatable)


在 Lua table 中我們可以存取對應的key來得到value值，但卻無法對兩個 table 進行操作。

因此 Lua 提供了元表(Metatable)，允許我們改變table的行為，每個行為關聯了對應的元方法。

例如，使用元表我們可以定義Lua如何計算兩個table的相加運算a+b。

當Lua試圖對兩個表進行相加時，先檢查兩者之一是否有元表，之後檢查是否有一個叫"__add"的字段，若找到，則調用對應的值。 "__add"等即時字段，其對應的值（往往是一個函數或是table）就是"元方法"。

有兩個很重要的函數來處理元表：

  • #setmetatable(table,metatable): 對指定table設定元表( metatable)，如果元表(metatable)中存在__metatable鍵值，setmetatable會失敗。

  • getmetatable(table): 傳回物件的元表(metatable)。

以下實例示範如何對指定的表格設定元表：

mytable = {}                          -- 普通表 
mymetatable = {}                      -- 元表
setmetatable(mytable,mymetatable)     -- 把 mymetatable 设为 mytable 的元表

以上程式碼也可以直接寫成一行：

mytable = setmetatable({},{})

以下為傳回物件元表：

getmetatable(mytable)                 -- 这回返回mymetatable

__index 元方法

這是metatable 最常用的鍵。

當你透過鍵來存取 table 的時候，如果這個鍵沒有值，那麼Lua就會尋找該table的metatable（假設有metatable）中的__index 鍵。如果__index包含一個表格，Lua會在表格中尋找對應的鍵。


我們可以在使用lua 指令進入互動模式查看：

$ lua
Lua 5.3.0  Copyright (C) 1994-2015 Lua.org, PUC-Rio
> other = { foo = 3 } 
> t = setmetatable({}, { __index = other }) 
> t.foo
3
> t.bar
nil

如果__index包含一個函數的話，Lua就會呼叫那個函數，table和鍵會作為參數傳遞給函數。

__index 元方法查看表中元素是否存在，如果不存在，則傳回結果為 nil；如果存在則由 __index 傳回結果。 

mytable = setmetatable({key1 = "value1"}, {
  __index = function(mytable, key)
    if key == "key2" then
      return "metatablevalue"
    else
      return nil
    end
  end
})

print(mytable.key1,mytable.key2)

實例輸出結果為：

value1	metatablevalue

實例解析：

  • mytable 表賦值為{key1 = "value1"}。

  • mytable 設定了元表，元方法為 __index。

  • 在mytable表中尋找 key1，如果找到，傳回該元素，找不到則繼續。

  • 在mytable表中尋找 key2，如果找到，返回 metatablevalue，找不到則繼續。

  • 判斷元表有沒有__index方法，如果__index方法是函數，則呼叫該函數。

  • 元方法中查看是否傳入"key2" 鍵的參數（mytable.key2已設定），如果傳入"key2" 參數返回"metatablevalue"，否則返回mytable 對應的鍵值。


我們可以簡單將上述程式碼寫成：

mytable = setmetatable({key1 = "value1"}, { __index = { key2 = "metatablevalue" } })
print(mytable.key1,mytable.key2)

總結

Lua尋找一個表格元素時的規則，其實就是如下3個步驟:

  • #1.在表中查找，如果找到，返回該元素，找不到則繼續

  • 2.判斷該表是否有元表，如果沒有元表，回傳nil，有元表則繼續。

  • 3.判斷元表有沒有__index方法，如果__index方法為nil，則傳回nil；如果__index方法是一個表，則重複1、2、3；如果__index方法是函數，則傳回該函數的傳回值。

__newindex 元方法

__newindex 元方法用來對錶更新，__index則用來對錶存取 。

當你給表的一個缺少的索引賦值，解釋器就會尋找__newindex 元方法：如果存在則呼叫這個函數而不進行賦值操作。

以下實例示範了__newindex 元方法的應用：

mymetatable = {}
mytable = setmetatable({key1 = "value1"}, { __newindex = mymetatable })

print(mytable.key1)

mytable.newkey = "新值2"
print(mytable.newkey,mymetatable.newkey)

mytable.key1 = "新值1"
print(mytable.key1,mymetatable.key1)

以上實例執行輸出結果為：

value1
nil	新值2
新值1	nil

以上實例中表設定了元方法__newindex，在對新索引鍵（newkey）賦值時（mytable.newkey = "新值2"），會呼叫元方法，而不進行賦值。而如果對已存在的索引鍵（key1），則會進行賦值，而不呼叫元方法 __newindex。

以下實例使用了rawset 函數來更新表格：

mytable = setmetatable({key1 = "value1"}, {
  __newindex = function(mytable, key, value)
		rawset(mytable, key, "\""..value.."\"")

  end
})

mytable.key1 = "new value"
mytable.key2 = 4

print(mytable.key1,mytable.key2)

以上實例執行輸出結果為：

new value	"4"

為表格新增運算符

#下列實例示範了兩表相加操作：

-- 计算表中最大值，table.maxn在Lua5.2以上版本中已无法使用
-- 自定义计算表中最大值函数 table_maxn
function table_maxn(t)
    local mn = 0
    for k, v in pairs(t) do
        if mn < k then
            mn = k
        end
    end
    return mn
end

-- 两表相加操作
mytable = setmetatable({ 1, 2, 3 }, {
  __add = function(mytable, newtable)
    for i = 1, table_maxn(newtable) do
      table.insert(mytable, table_maxn(mytable)+1,newtable[i])
    end
    return mytable
  end
})

secondtable = {4,5,6}

mytable = mytable + secondtable
	for k,v in ipairs(mytable) do
print(k,v)
end

以上實例執行輸出結果為：

1	1
2	2
3	3
4	4
5	5
6	6

__add 鍵包含在元表中，並進行相加操作。 表中對應的操作清單如下：

##__add##對應的運算子'+'.__sub對應的運算子'-'.##__concat對應的運算子'..'.#__eq對應的運算子'=='.__lt對應的運算子'<'.__le對應的運算符'<='.
模式描述
##__mul對應的運算子'*'.
__div#對應的運算子'/'.
__mod對應的運算子'%'.
__unm對應的運算子'-'.
__call 元方法

__call 元方法在Lua 呼叫一個值時呼叫。以下實例示範了計算表中元素的和：

-- 计算表中最大值，table.maxn在Lua5.2以上版本中已无法使用
-- 自定义计算表中最大值函数 table_maxn
function table_maxn(t)
    local mn = 0
    for k, v in pairs(t) do
        if mn < k then
            mn = k
        end
    end
    return mn
end

-- 定义元方法__call
mytable = setmetatable({10}, {
  __call = function(mytable, newtable)
	sum = 0
	for i = 1, table_maxn(mytable) do
		sum = sum + mytable[i]
	end
    for i = 1, table_maxn(newtable) do
		sum = sum + newtable[i]
	end
	return sum
  end
})
newtable = {10,20,30}
print(mytable(newtable))

以上實例執行輸出結果為：

70

__tostring 元方法

##__tostring 元方法用於修改表的輸出行為。以下實例我們自訂了表格的輸出內容：

mytable = setmetatable({ 10, 20, 30 }, {
  __tostring = function(mytable)
    sum = 0
    for k, v in pairs(mytable) do
		sum = sum + v
	end
    return "表所有元素的和为 " .. sum
  end
})
print(mytable)

以上實例執行輸出結果為：

表所有元素的和为 60

從本文中我們可以知道元表可以很好的簡化我們的程式碼功能，所以了解Lua 的元表，可以讓我們寫出更簡單、更優秀的Lua 程式碼。

←
→