元表

在 Lua 5.1 语言中,元表 (metatable) 的表现行为类似于 C++ 语言中的操作符重载,例如我们可以重载 “__add” 元方法 (metamethod),来计算两个 Lua 数组的并集;或者重载 “__index” 方法,来定义我们自己的 Hash 函数。Lua 提供了两个十分重要的用来处理元表的方法,如下:

  • setmetatable(table, metatable):此方法用于为一个表设置元表。
  • getmetatable(table):此方法用于获取表的元表对象。

设置元表的方法很简单,如下:

  1. local mytable = {}
  2. local mymetatable = {}
  3. setmetatable(mytable, mymetatable)

上面的代码可以简写成如下的一行:

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

修改表的操作符行为

通过重载 “__add” 元方法来计算集合的并集实例:

  1. local set1 = {10, 20, 30} -- 集合
  2. local set2 = {20, 40, 50} -- 集合
  3. -- 将用于重载__add的函数,注意第一个参数是self
  4. local union = function (self, another)
  5. local set = {}
  6. local result = {}
  7. -- 利用数组来确保集合的互异性
  8. for i, j in pairs(self) do
  9. set[j] = true
  10. end
  11. for i, j in pairs(another) do
  12. set[j] = true
  13. end
  14. -- 加入结果集合
  15. for i, j in pairs(set) do
  16. table.insert(result, i)
  17. end
  18. return result
  19. end
  20. setmetatable(set1, {__add = union}) -- 重载 set1 表的 __add 元方法
  21. local set3 = set1 + set2
  22. for _, j in pairs(set3) do
  23. io.write(j.." ") -->output30 50 20 40 10
  24. end

除了加法可以被重载之外,Lua 提供的 所有操作符 都可以被重载:

序号 元方法 含义
1 “__add” + 操作
2 “__sub” - 操作,其行为类似于 “add” 操作
3 “__mul” * 操作,其行为类似于 “add” 操作
4 “__div” / 操作,其行为类似于 “add” 操作
5 “__mod” % 操作,其行为类似于 “add” 操作
6 “__pow” ^ (幂)操作,其行为类似于 “add” 操作
7 “__unm” 一元 - 操作
8 “__concat” .. (字符串连接)操作
9 “__len” # 操作
10 “__eq” == 操作,函数 getcomphandler 定义了 Lua 怎样选择一个处理器来作比较操作;
仅在两个对象类型相同且有对应操作相同的元方法时才起效
11 “__lt” < 操作
12 “__le” <= 操作

除了操作符之外,如下 元方法 也可以被重载,下面会依次解释使用方法:

序号 元方法 含义
1 “__index” 取下标操作,用于访问 table[key]
2 “__newindex” 赋值给指定下标 table[key] = value
3 “__tostring” 转换成字符串
4 “__call” 当 Lua 调用一个值时调用
5 “__mode” 用于弱表 (week table)
6 “__metatable” 用于保护 metatable 不被访问

__index 元方法

下面的例子中,我们实现了在表中查找键,不存在时转而在元表中查找该键的功能:

  1. mytable = setmetatable(
  2. {key1 = "value1"}, --原始表
  3. {
  4. __index = function(self, key) --重载函数
  5. if key == "key2" then
  6. return "metatablevalue"
  7. end
  8. end
  9. }
  10. )
  11. print(mytable.key1,mytable.key2) --> outputvalue1 metatablevalue

关于 __index 元方法,有很多比较高阶的技巧,例如:__index 的元方法不需要非是一个函数,它也可以是一个表。

  1. t = setmetatable({[1] = "hello"}, {__index = {[2] = "world"}})
  2. print(t[1], t[2]) -->hello world

第一句代码有点绕,解释一下:

  • 先是把 {__index = {}} 作为元表,但 __index 接受一个表,而不是函数,这个表中包含 [2] = “world” 这个键值对。
  • 当 t[2] 在自身的表中找不到时,到 __index 的表中去寻找,然后找到了 [2] = “world” 这个键值对。

__index 元方法还可以实现给表中每一个值赋上默认值,和 __newindex 元方法联合监控对表的读取、修改等比较高阶的功能,待读者自己去开发吧。

__tostring 元方法

与 Java 中的 toString() 函数类似,可以实现自定义的字符串转换。

  1. arr = {1, 2, 3, 4}
  2. arr = setmetatable(
  3. arr,
  4. {
  5. __tostring = function (self)
  6. local result = '{'
  7. local sep = ''
  8. for _, i in pairs(self) do
  9. result = result ..sep .. i
  10. sep = ', '
  11. end
  12. result = result .. '}'
  13. return result
  14. end
  15. }
  16. )
  17. print(arr) --> {1, 2, 3, 4}

__call 元方法

__call 元方法的功能类似于 C++ 中的仿函数,使得普通的表也可以被调用。

  1. functor = {}
  2. function func1(self, arg)
  3. print ("called from", arg)
  4. end
  5. setmetatable(functor, {__call = func1})
  6. functor("functor") --> called from functor
  7. print(functor) --> output0x00076fc8 (后面这串数字可能不一样)

__metatable 元方法

假如想保护我们的对象,使其使用者既看不到也不能修改 metatables。我们可以对 metatable 设置 __metatable 的值,getmetatable 将返回这个域的值,而调用 setmetatable 将会出错:

  1. Object = setmetatable({}, {__metatable = "You cannot access here"})
  2. print(getmetatable(Object)) --> You cannot access here
  3. setmetatable(Object, {}) --> 引发编译器报错