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)。

以下实例演示了如何对指定的表设置元表：

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

以上代码也可以直接写成一行：

  1. mytable = setmetatable({},{})

以下为返回对象元表：

  1. getmetatable(mytable)                 -- 这回返回mymetatable

__index 元方法

这是 metatable 最常用的键。

当你通过键来访问 table 的时候，如果这个键没有值，那么Lua就会寻找该table的metatable（假定有metatable）中的index 键。如果index包含一个表格，Lua会在表格中查找相应的键。

我们可以在使用 lua 命令进入交互模式查看：

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

如果__index包含一个函数的话，Lua就会调用那个函数，table和键会作为参数传递给函数。

index 元方法查看表中元素是否存在，如果不存在，返回结果为 nil；如果存在则由 index 返回结果。

实例

  1. mytable = setmetatable({key1 = "value1"}, {
  2.   __index = function(mytable, key)
  3.     if key == "key2" then
  4.       return "metatablevalue"
  5.     else
  6.       return nil
  7.     end
  8.   end
  9. })
  11. print(mytable.key1,mytable.key2)

实例输出结果为：

  1. value1    metatablevalue

实例解析：

  • mytable 表赋值为 {key1 = "value1"}。
  • mytable 设置了元表，元方法为 __index。
  • 在mytable表中查找 key1，如果找到，返回该元素，找不到则继续。
  • 在mytable表中查找 key2，如果找到，返回 metatablevalue，找不到则继续。
  • 判断元表有没有index方法，如果index方法是一个函数，则调用该函数。
  • 元方法中查看是否传入 “key2” 键的参数（mytable.key2已设置），如果传入 “key2” 参数返回 “metatablevalue”，否则返回 mytable 对应的键值。

我们可以将以上代码简单写成：

  1. mytable = setmetatable({key1 = "value1"}, { __index = { key2 = "metatablevalue" } })
  2. 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 元方法的应用：

实例

  1. mymetatable = {}
  2. mytable = setmetatable({key1 = "value1"}, { __newindex = mymetatable })
  4. print(mytable.key1)
  6. mytable.newkey = "新值2"
  7. print(mytable.newkey,mymetatable.newkey)
  9. mytable.key1 = "新值1"
  10. print(mytable.key1,mymetatable.key1)

以上实例执行输出结果为：

  1. value1
  2. nil    新值2
  3. 新值1    nil

以上实例中表设置了元方法 newindex，在对新索引键（newkey）赋值时（mytable.newkey = “新值2”），会调用元方法，而不进行赋值。而如果对已存在的索引键（key1），则会进行赋值，而不调用元方法 newindex。

以下实例使用了 rawset 函数来更新表：

  1. mytable = setmetatable({key1 = "value1"}, {
  2.   __newindex = function(mytable, key, value)
  3.                 rawset(mytable, key, "\""..value.."\"")
  5.   end
  6. })
  8. mytable.key1 = "new value"
  9. mytable.key2 = 4
  11. print(mytable.key1,mytable.key2)

以上实例执行输出结果为：

  1. new value    "4"

为表添加操作符

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

实例

  1. -- 计算表中最大值，table.maxn在Lua5.2以上版本中已无法使用
  2. -- 自定义计算表中最大键值函数 table_maxn，即计算表的元素个数
  3. function table_maxn(t)
  4.     local mn = 0
  5.     for k, v in pairs(t) do
  6.         if mn < k then
  7.             mn = k
  8.         end
  9.     end
  10.     return mn
  11. end
  13. -- 两表相加操作
  14. mytable = setmetatable({ 1, 2, 3 }, {
  15.   __add = function(mytable, newtable)
  16.     for i = 1, table_maxn(newtable) do
  17.       table.insert(mytable, table_maxn(mytable)+1,newtable[i])
  18.     end
  19.     return mytable
  20.   end
  21. })
  23. secondtable = {4,5,6}
  25. mytable = mytable + secondtable
  26.         for k,v in ipairs(mytable) do
  27. print(k,v)
  28. end

以上实例执行输出结果为：

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

add 键包含在元表中，并进行相加操作。表中对应的操作列表如下：(注意：是两个下划线)

模式描述
add对应的运算符 '+'.
sub对应的运算符 '-'.
mul对应的运算符 '*'.
div对应的运算符 '/'.
mod对应的运算符 '%'.
unm对应的运算符 '-'.
concat对应的运算符 '..'.
eq对应的运算符 '=='.
lt对应的运算符 '<'.
le对应的运算符 '<='.

__call 元方法

__call 元方法在 Lua 调用一个值时调用。以下实例演示了计算表中元素的和：

实例

  1. -- 计算表中最大值，table.maxn在Lua5.2以上版本中已无法使用
  2. -- 自定义计算表中最大键值函数 table_maxn，即计算表的元素个数
  3. function table_maxn(t)
  4.     local mn = 0
  5.     for k, v in pairs(t) do
  6.         if mn < k then
  7.             mn = k
  8.         end
  9.     end
  10.     return mn
  11. end
  13. -- 定义元方法__call
  14. mytable = setmetatable({10}, {
  15.   __call = function(mytable, newtable)
  16.         sum = 0
  17.         for i = 1, table_maxn(mytable) do
  18.                 sum = sum + mytable[i]
  19.         end
  20.     for i = 1, table_maxn(newtable) do
  21.                 sum = sum + newtable[i]
  22.         end
  23.         return sum
  24.   end
  25. })
  26. newtable = {10,20,30}
  27. print(mytable(newtable))

以上实例执行输出结果为：

  1. 70

__tostring 元方法

__tostring 元方法用于修改表的输出行为。以下实例我们自定义了表的输出内容：

实例

  1. mytable = setmetatable({ 10, 20, 30 }, {
  2.   __tostring = function(mytable)
  3.     sum = 0
  4.     for k, v in pairs(mytable) do
  5.                 sum = sum + v
  6.         end
  7.     return "表所有元素的和为 " .. sum
  8.   end
  9. })
  10. print(mytable)

以上实例执行输出结果为：

  1. 表所有元素的和为 60

从本文中我们可以知道元表可以很好的简化我们的代码功能，所以了解 Lua 的元表，可以让我们写出更加简单优秀的 Lua 代码。

实现 __index 元方法

  1. text = { }
  2. text.defaultValue = { size = 14, content = "hello" }
  3. text.mt = { }  -- 创建元表
  5. function text.new( a )
  6.   setmetatable( a, text.mt )
  7.   return a
  8. end
  10. text.mt.__index = function( tb, key )
  11.   return text.defaultValue[key]
  12. end
  14. local x = text.new{ content = "bye" }
  15. print( x.size )   --> 14

Lua 算术运算的 Metamethods

这一部分我们通过一个简单的例子介绍如何使用 metamethods。假定我们使用 table 来描述结合，使用函数来描述集合的并操作，交集操作，like 操作。我们在一个表内定义这些函数，然后使用构造函数创建一个集合：

  1. Set = {}
  2. Set.mt = {}   --将所有集合共享一个metatable
  3. function Set.new (t)   --新建一个表
  4.     local set = {}
  5.     setmetatable(set,Set.mt)
  6.     for _, l in ipairs(t) do set[l] = true end
  7.     return set
  8. end
  9. function Set.union(a,b)   --并集
  10.     local res = Set.new{}  --注意这里是大括号
  11.     for i in pairs(a) do res[i] = true end
  12.     for i in pairs(b) do res[i] = true end
  13.     return res
  14. end
  15. function Set.intersection(a,b)   --交集
  16.     local res = Set.new{}   --注意这里是大括号
  17.     for i in pairs(a) do
  18.         res[i] = b[i]
  19.     end
  20.     return res
  21. end
  22. function Set.tostring(set)  --打印函数输出结果的调用函数
  23.     local s = "{"
  24.     local sep = ""
  25.     for i in pairs(set) do
  26.         s = s..sep..i
  27.         sep = ","
  28.     end
  29.     return s.."}"
  30. end
  31. function Set.print(set)   --打印函数输出结果
  32.     print(Set.tostring(set))
  33. end
  34. --[[
  35. Lua中定义的常用的Metamethod如下所示：
  36. 算术运算符的Metamethod：
  37. __add（加运算）、__mul（乘）、__sub(减)、__div(除)、__unm(负)、__pow(幂)，__concat（定义连接行为）。
  38. 关系运算符的Metamethod：
  39. __eq（等于）、__lt（小于）、__le（小于等于），其他的关系运算自动转换为这三个基本的运算。
  40. 库定义的Metamethod：
  41. __tostring（tostring函数的行为）、__metatable（对表getmetatable和setmetatable的行为）。
  42. ]]
  43. Set.mt.__add = Set.union
  45. s1 = Set.new{1,2}
  46. s2 = Set.new{3,4}
  47. print(getmetatable(s1))
  48. print(getmetatable(s2))   
  49. s3 = s1 + s2 
  50. Set.print(s3)
  52. Set.mt.__mul = Set.intersection   --使用相乘运算符来定义集合的交集操作
  53. Set.print((s1 + s2)*s1)

如上所示，用表进行了集合的并集和交集操作。

Lua 选择 metamethod 的原则：如果第一个参数存在带有 __add 域的 metatable，Lua 使用它作为 metamethod，和第二个参数无关；

否则第二个参数存在带有 __add 域的 metatable，Lua 使用它作为 metamethod 否则报错。

lua 元方法 _newindex 实现只读的 table

根据 newindex 的这一个特性，可以用来跟踪一个 table 赋值更新的操作，如果是一个只读的 table ，可以通过 newindex 来实现下面是代码 lua 中 newindex 的调用机制跟 index 的调用机制是一样的，当访问 table 中一个不存在的 key，并对其赋值的时候，lua 解释器会查找 __newindex 元方法，如果存在，调用该方法，如果不存在，直接对原 table 索引进行赋值操作。

  1. local t = {}
  2. local prototype = {}
  3. local mt = {__index = function(t,k)
  4.     return prototype[k]
  5.     end
  6. ,__newindex = function(t,k,v)
  7.     print("attempt to update a table k-v")
  8.     prototype[k] = v
  9. end}
  11. setmetatable(t,mt)
  12. t[2] = "hello"
  13. print(t[2])

输出：

  1. >attempt to update a table k-v
  2. hello

根据 newindex 的这一个特性，可以用来跟踪一个 table 赋值更新的操作，如果是一个只读的 table ，可以通过 newindex 来实现下面是代码:

  1. function readOnly(t)
  2.     local proxy = {}  --定义一个空表，访问任何索引都是不存在的，所以会调用__index 和__newindex
  3.     local mt = {
  4.     __index = t, ---__index 可以是函数，也可以是table，是table的话，调用直接返回table的索引值
  5.     __newindex = function(t,k,v)
  6.         error("attempt to update a read-only table",2)
  7.     end
  8.     }
  9.     setmetatable(proxy,mt)
  10.     return proxy
  11. end
  13. days = readOnly{"Sunday","Monday","Tuesday","Wednessday","Thursday","Friday","Saturday"} 
  14. print(days[1])
  15. days[2] = "hello"  --这一行就非法访问了

输出：

  1. >Sunday
  2. >: attempt to update a read-only table

__newindex 有两个规则

  • 1、如果 __newindex 是一个函数，则在给 table 中不存在的字段赋值时，会调用这个函数，并且赋值不成功。
  • 2、如果 newindex 是一个 table，则在给 table 中不存在的字段赋值时，会直接给 newindex的table 赋值。