Lua中的元表和元方法学习笔记

元表(metatable)是 Lua 里每种类型的值的默认操作方式的集合,例如,数字可以加减乘除、字符串可以连接合并、table 可以插入一对 key-value 值、函数可以被调用等等,这些操作都遵循其预定义的行为来执行。

而值的默认操作方式不是一成不变的,可以通过元表来修改其行为表现,或者是新定义一些默认没有的操作。例如,当两个 table 相加时, Lua 会检查它们之间的元表里是否有 "__add" 这个函数,如果定义有这个函数, 则调用这个函数来执行一次加法操作。

这里,相加这个操作的函数名 -- "__add" 是元表的键名(元表的键名也称之为事件(event),一般以 2 个下划线 "_" 开头),而 "__add" 函数则是这个相加操作的元方法(metamethod)。对于值的操作,Lua 都将其关联上一个被称作事件的指定健,当 Lua 需要对一个值发起这些操作中的一个时, 它会去检查值的元表里是否有对应事件。如果有,则键名对应的值(元方法)将控制 Lua 怎样去执行这个操作。

getmetatable - 获取元表

Lua 里每个值都有一个元表。table 类型和 userdata 类型的值可以有各自独立的元表,而其他类型的值则是公用其类型所预先定义的元表。例如,可以用 getmetatable 来获取一个字符串的元表:

a = "just a test"
print(getmetatable(a))

上面的操作会输出 "table: 0x7fa8614080f0" 的 table,里面包含着预先定义给字符串的操作方法,其内容结构如下:

-__index-sub [function: 0x7fee39408050]
        -upper [function: 0x7fee394080a0]
        -len [function: 0x7fee39407ec0]
        -gfind [function: 0x7fee39407e20]
        -rep [function: 0x7fee39407fb0]
        -find [function: 0x7fee39407d30]
        -match [function: 0x7fee39407f60]
        -char [function: 0x7fee39407c90]
        -dump [function: 0x7fee39407ce0]
        -gmatch [function: 0x7fee39407e20]
        -reverse [function: 0x7fee39408000]
        -byte [function: 0x7fee39407c40]
        -format [function: 0x7fee39407d80]
        -gsub [function: 0x7fee39407e70]
        -lower [function: 0x7fee39407f10]

Lua 在创建新的 table 时不会创建元表,因此想调用 getmetatable 函数获取其元表的话,只会返回一个 nil 值。

tbl = {}
print(getmetatable(tbl))

setmetatable - 修改元表

对于上面所说的新创建的 table 是空元表的问题,可以用 setmetatable 来修改其元表:

tbl = {}
t1 = {key = "val"}
setmetatable(tbl, t1)
print(getmetatable(tbl))

对于上面所说的 2 个 table 相加的情况,可以给 table 添加一个 __add 的元方法就可以进行相加操作:

t1 = {"a", "b", "c", "d"}
t2 = {5, 6, 7, 8, 9}
 
mt = {}
mt.__add = function(a, b)
    local tbl = {}
    local ret = {}
    for k, v in pairs(a) do tbl[v] = true end
    for k, v in pairs(b) do tbl[v] = true end
    for k, v in pairs(tbl) do
        table.insert(ret, k)
    end
    return ret
end
 
setmetatable(t1, mt)
setmetatable(t2, mt)
 
t = t1 + t2
for k, v in pairs(t) do print(v) end