Lua中的元表与元方法

Posted 2020-09-17 slgkaifa

前言

Lua中每一个值都可具有元表。 元表是普通的Lua表，定义了原始值在某些特定操作下的行为。

你可通过在值的原表中设置特定的字段来改变作用于该值的操作的某些行为特征。

比如。当数字值作为加法的操作数时，Lua检查其元表中的"__add"字段是否有个函数。假设有，Lua调用它运行加法。

我们称元表中的键为事件（event）。称值为元方法（metamethod）。前述样例中的事件是"add"，元方法是运行加法的函数。

可通过函数getmetatable查询不论什么值的元表。

在table中，我能够又一次定义的元方法有下面几个：

__add(a, b) --加法
__sub(a, b) --减法
__mul(a, b) --乘法
__div(a, b) --除法
__mod(a, b) --取模
__pow(a, b) --乘幂
__unm(a) --相反数
__concat(a, b) --连接
__len(a) --长度
__eq(a, b) --相等
__lt(a, b) --小于
__le(a, b) --小于等于
__index(a, b) --索引查询
__newindex(a, b, c) --索引更新（PS：不懂的话，后面会有讲）
__call(a, ...) --运行方法调用
__tostring(a) --字符串输出
__metatable --保护元表

Lua中的每一个表都有其Metatable。Lua默认创建一个不带metatable的新表

t = {}
print(getmetatable(t)) --> nil

能够使用setmetatable函数设置或者改变一个表的metatable

t1 = {}
setmetatable(t, t1)
assert(getmetatable(t) == t1)

不论什么一个表都能够是其它一个表的metatable，一组相关的表能够共享一个metatable（描写叙述他们共同的行为）。一个表也能够是自身的metatable（描写叙述其私有行为）。

接下来就介绍介绍假设去又一次定义这些方法。

算术类的元方法

如今我使用完整的实例代码来具体的说明算术类元方法的使用。

Set = {}
local mt = {} -- 集合的元表
 
-- 依据參数列表中的值创建一个新的集合
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{} -- 此处相当于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

如今，我定义“+”来计算两个集合的并集，那么就须要让全部用于表示集合的table共享一个元表，而且在该元表中定义怎样运行一个加法操作。首先创建一个常规的table，准备用作集合的元表。然后改动Set.new函数。在每次创建集合的时候，都为新的集合设置一个元表。

代码例如以下：

Set = {}
local mt = {} -- 集合的元表
 
-- 依据參数列表中的值创建一个新的集合
function Set.new(l)
    local set = {}
     setmetatable(set, mt)
    for _, v in pairs(l) do set[v] = true end
     return set
end

在此之后，全部由Set.new创建的集合都具有一个同样的元表。比如：

local set1 = Set.new({10, 20, 30})
local set2 = Set.new({1, 2})
print(getmetatable(set1))
print(getmetatable(set2))
assert(getmetatable(set1) == getmetatable(set2))

最后，我们须要把元方法加入元表中。代码例如以下：

mt.__add = Set.union

这以后，仅仅要我们使用“+”符号求两个集合的并集，它就会自己主动的调用Set.union函数，并将两个操作数作为參数传入。比方下面代码：

local set1 = Set.new({10, 20, 30})
local set2 = Set.new({1, 2})
local set3 = set1 + set2
Set.print(set3)

在上面列举的那些能够重定义的元方法都能够使用上面的方法进行重定义。如今就出现了一个新的问题，set1和set2都有元表。那我们要用谁的元表啊？尽管我们这里的演示样例代码使用的都是一个元表。可是实际coding中，会遇到我这里说的问题，对于这种问题。Lua是依照下面步骤进行解决的：

1. 对于二元操作符。假设第一个操作数有元表，而且元表中有所须要的字段定义。比方我们这里的__add元方法定义。那么Lua就以这个字段为元方法，而与第二个值无关；
2. 对于二元操作符，假设第一个操作数有元表，可是元表中没有所须要的字段定义，比方我们这里的__add元方法定义。那么Lua就去查找第二个操作数的元表；
3. 假设两个操作数都没有元表。或者都没有相应的元方法定义。Lua就引发一个错误。

以上就是Lua处理这个问题的规则，那么我们在实际编程中该怎样做呢？

比方set3 = set1 + 8这种代码。就会打印出下面的错误提示：

lua: test.lua:16: bad argument #1 to ‘pairs‘ (table expected, got number)

可是，我们在实际编码中。能够依照下面方法，弹出我们定义的错误消息，代码例如以下：

function Set.union(a, b)
     if getmetatable(a) ~= mt or getmetatable(b) ~= mt then
          error("metatable error.")
     end
 
    local retSet = Set.new{} -- 此处相当于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

当两个操作数的元表不是同一个元表时。就表示二者进行并集操作时就会出现故障，那么我们就能够打印出我们须要的错误消息。

上面总结了算术类的元方法的定义。关系类的元方法和算术类的元方法的定义是相似的，这里不做累述。

__tostring元方法

写过Java或者C#的人都知道。Object类中都有一个tostring的方法，程序猿能够重写该方法。以实现自己的需求。

在Lua中。也是这种。当我们直接print(a)（a是一个table）时，是不能够的。那怎么办。这个时候，我们就须要自己又一次定义__tostring元方法，让print能够格式化打印出table类型的数据。
函数print总是调用tostring来进行格式化输出。当格式化随意值时。tostring会检查该值是否有一个__tostring的元方法，假设有这个元方法，tostring就用该值作为參数来调用这个元方法，剩下实际的格式化操作就由__tostring元方法引用的函数去完毕，该函数终于返回一个格式化完毕的字符串。

比例如以下面代码：

mt.__tostring = Set.toString

怎样保护我们的“奶酪”——元表

我们会发现。使用getmetatable就能够非常轻易的得到元表，使用setmetatable就能够非常easy的改动元表，那这样做的风险是不是太大了。那么怎样保护我们的元表不被篡改呢？在Lua中，函数setmetatable和getmetatable函数会用到元表中的一个字段，用于保护元表，该字段是__metatable。当我们想要保护集合的元表，是用户既不能看也不能改动集合的元表，那么就须要使用__metatable字段了；当设置了该字段时，getmetatable就会返回这个字段的值，而setmetatable则会引发一个错误；例如以下面演示代码：

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" -- 设置完我的元表以后。不让其它人再设置
     return set
end
 
local tb = Set.new({1, 2})
print(tb)
 
print(getmetatable(tb))
setmetatable(tb, {})

上述代码就会打印下面内容：

{1, 2}
You cannot get the metatable
lua: test.lua:56: cannot change a protected metatable

__index元方法

是否还记得当我们訪问一个table中不存在的字段时，会返回什么值？默认情况下。当我们訪问一个table中不存在的字段时，得到的结果是nil。

可是这种状况非常easy被改变。Lua是依照下面的步骤决定是返回nil还是其它值得：

1. 当訪问一个table的字段时，假设table有这个字段。则直接返回相应的值；
2. 当table没有这个字段。则会促使解释器去查找一个叫__index的元方法。接下来就就会调用相应的元方法。返回元方法返回的值。
3. 假设没有这个元方法，那么就返回nil结果。

下面通过一个实际的样例来说明__index的使用。

假设要创建一些描写叙述窗体，每一个table中都必须描写叙述一些窗体參数，比如颜色，位置和大小等，这些參数都是有默认值得。因此。我们在创建窗体对象时能够指定那些不同于默认值得參数。

Windows = {} -- 创建一个命名空间
 
-- 创建默认值表
Windows.default = {x = 0, y = 0, width = 100, height = 100, color = {r = 255, g = 255, b = 255}}
 
Windows.mt = {} -- 创建元表
 
-- 声明构造函数
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 訪问自身已经拥有的值
print(win.width)          -- >100 訪问default表中的值
print(win.color.r)          -- >255 訪问default表中的值

依据上面代码的输出。结合上面说的那三步，我们再来看看，print(win.x)时。因为win变量本身就拥有x字段。所以就直接打印了其自身拥有的字段的值。print(win.width)，因为win变量本身没有width字段，那么就去查找是否拥有元表，元表中是否有__index相应的元方法。因为存在__index元方法，返回了default表中的width字段的值，print(win.color.r)也是同样的道理。

在实际编程中，__index元方法不必一定是一个函数，它还能够是一个table。当它是一个函数时，Lua以table和不存在key作为參数来调用该函数，这就和上面的代码一样；当它是一个table时，Lua就以同样的方式来又一次訪问这个table，所以上面的代码也能够是这种：

-- 定义__index元方法
Windows.mt.__index = Windows.default

__newindex元方法

__newindex元方法与__index相似。__newindex用于更新table中的数据，而__index用于查询table中的数据。当对一个table中不存在的索引赋值时，在Lua中是依照下面步骤进行的：

Lua解释器先推断这个table是否有元表。

1. 假设有了元表，就查找元表中是否有__newindex元方法。假设没有元表，就直接加入这个索引。然后相应的赋值；
2. 假设有这个__newindex元方法，Lua解释器就运行它。而不是运行赋值。
3. 假设这个__newindex相应的不是一个函数。而是一个table时，Lua解释器就在这个table中运行赋值。而不是对原来的table。

那么这里就出现了一个问题。看下面代码：

local tb1 = {}
local tb2 = {}
 
tb1.__newindex = tb2
tb2.__newindex = tb1
 
setmetatable(tb1, tb2)
setmetatable(tb2, tb1)
 
tb1.x = 10

发现什么问题了么？是不是循环了，在Lua解释器中，对这个问题，就会弹出错误消息，错误消息例如以下：

loop in settable

引用博客：http://www.jellythink.com/archives/511