Lua 元表(Metatable)

在 Lua table 中我們可以訪問(wèn)對(duì)應(yīng)的key來(lái)得到value值，但是卻無(wú)法對(duì)兩個(gè) table 進(jìn)行操作。

因此 Lua 提供了元表(Metatable)，允許我們改變table的行為，每個(gè)行為關(guān)聯(lián)了對(duì)應(yīng)的元方法。

例如，使用元表我們可以定義Lua如何計(jì)算兩個(gè)table的相加操作a+b。

當(dāng)Lua試圖對(duì)兩個(gè)表進(jìn)行相加時(shí)，先檢查兩者之一是否有元表，之后檢查是否有一個(gè)叫"__add"的字段，若找到，則調(diào)用對(duì)應(yīng)的值。"__add"等即時(shí)字段，其對(duì)應(yīng)的值（往往是一個(gè)函數(shù)或是table）就是"元方法"。

有兩個(gè)很重要的函數(shù)來(lái)處理元表：

• setmetatable(table,metatable): 對(duì)指定 table 設(shè)置元表(metatable)，如果元表(metatable)中存在 __metatable 鍵值，setmetatable 會(huì)失敗。

• getmetatable(table): 返回對(duì)象的元表(metatable)。

以下示例演示了如何對(duì)指定的表設(shè)置元表：

mytable = {}                          -- 普通表 
mymetatable = {}                      -- 元表
setmetatable(mytable,mymetatable)     -- 把 mymetatable 設(shè)為 mytable 的元表

以上代碼也可以直接寫(xiě)成一行：

mytable = setmetatable({},{})

以下為返回對(duì)象元表：

getmetatable(mytable)                 -- 這回返回mymetatable

__index 元方法

這是 metatable 最常用的鍵。

當(dāng)你通過(guò)鍵來(lái)訪問(wèn) table 的時(shí)候，如果這個(gè)鍵沒(méi)有值，那么Lua就會(huì)尋找該table的metatable（假定有metatable）中的__index 鍵。如果__index包含一個(gè)表格，Lua會(huì)在表格中查找相應(yīng)的鍵。

我們可以在使用 lua 命令進(jìn)入交互模式查看：

$ 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包含一個(gè)函數(shù)的話，Lua就會(huì)調(diào)用那個(gè)函數(shù)，table和鍵會(huì)作為參數(shù)傳遞給函數(shù)。

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

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

print(mytable.key1,mytable.key2)

示例輸出結(jié)果為：

value1    metatablevalue

示例解析：

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

• mytable 設(shè)置了元表，元方法為 __index。

• 在mytable表中查找 key1，如果找到，返回該元素，找不到則繼續(xù)。

• 在mytable表中查找 key2，如果找到，返回 metatablevalue，找不到則繼續(xù)。

• 判斷元表有沒(méi)有__index方法，如果__index方法是一個(gè)函數(shù)，則調(diào)用該函數(shù)。

• 元方法中查看是否傳入 "key2" 鍵的參數(shù)（mytable.key2已設(shè)置），如果傳入 "key2" 參數(shù)返回 "metatablevalue"，否則返回 mytable 對(duì)應(yīng)的鍵值。

我們可以將以上代碼簡(jiǎn)單寫(xiě)成：

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

總結(jié)

Lua 查找一個(gè)表元素時(shí)的規(guī)則，其實(shí)就是如下 3 個(gè)步驟:

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

• 2.判斷該表是否有元表，如果沒(méi)有元表，返回 nil，有元表則繼續(xù)。

• 3.判斷元表有沒(méi)有 __index 方法，如果 __index 方法為 nil，則返回 nil；如果 __index 方法是一個(gè)表，則重復(fù) 1、2、3；如果 __index 方法是一個(gè)函數(shù)，則返回該函數(shù)的返回值。

該部分內(nèi)容來(lái)自作者寰子：https://blog.csdn.net/xocoder/article/details/9028347

__newindex 元方法

__newindex 元方法用來(lái)對(duì)表更新，__index則用來(lái)對(duì)表訪問(wèn) 。

當(dāng)你給表的一個(gè)缺少的索引賦值，解釋器就會(huì)查找__newindex 元方法：如果存在則調(diào)用這個(gè)函數(shù)而不進(jìn)行賦值操作。

以下示例演示了 __newindex 元方法的應(yīng)用：

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)

以上示例執(zhí)行輸出結(jié)果為：

value1
nil    新值2
新值1    nil

以上示例中表設(shè)置了元方法 __newindex，在對(duì)新索引鍵(newkey)賦值時(shí)（mytable.newkey = "新值2"），會(huì)調(diào)用元方法，而不進(jìn)行賦值。而如果對(duì)已存在的索引鍵(key1)，則會(huì)進(jìn)行賦值，而不調(diào)用元方法 __newindex。

以下示例使用了 rawset 函數(shù)來(lái)更新表：

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)

以上示例執(zhí)行輸出結(jié)果為：

new value    "4"

為表添加操作符

以下示例演示了兩表相加操作：

-- 計(jì)算表中最大值，table.maxn在Lua5.2以上版本中已無(wú)法使用
-- 自定義計(jì)算表中最大鍵值函數(shù) table_maxn，即計(jì)算表的元素個(gè)數(shù)
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

以上示例執(zhí)行輸出結(jié)果為：

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

__add 鍵包含在元表中，并進(jìn)行相加操作。 表中對(duì)應(yīng)的操作列表如下：(注意：__是兩個(gè)下劃線)

__call 元方法

__call 元方法在 Lua 調(diào)用一個(gè)值時(shí)調(diào)用。以下示例演示了計(jì)算表中元素的和：

-- 計(jì)算表中最大值，table.maxn在Lua5.2以上版本中已無(wú)法使用
-- 自定義計(jì)算表中最大鍵值函數(shù) table_maxn，即計(jì)算表的元素個(gè)數(shù)
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))

以上示例執(zhí)行輸出結(jié)果為：

70

__tostring 元方法

__tostring 元方法用于修改表的輸出行為。以下示例我們自定義了表的輸出內(nèi)容：

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)

以上示例執(zhí)行輸出結(jié)果為：

表所有元素的和為 60

從本文中我們可以知道元表可以很好的簡(jiǎn)化我們的代碼功能，所以了解 Lua 的元表，可以讓我們寫(xiě)出更加簡(jiǎn)單優(yōu)秀的 Lua 代碼。