lua 14 metatable （类似操作符重载）

以你之姓@ 2023-08-17 15:17 109阅读 0赞

转自：http://www.runoob.com/lua/lua-metatables.html

**感性认识：**

“Lua中Metatable这个概念, 国内将他翻译为元表. 元表为重定义Lua中任意一个对象(值)的默认行为提供了一种公开入口. 如同许多OO语言的操作符重载或方法重载. Metatable能够为我们带来非常灵活的编程方式.

具体的说, Lua中每种类型的值都有都有他的默认操作方式, 如, 数字可以做加减乘除等操作, 字符串可以做连接操作, 函数可以做调用操作, 表可以做表项的取值赋值操作. 他们都遵循这些操作的默认逻辑执行, 而这些操作可以通过Metatable来改变. 如, 你可以定义2个表如何相加等.

看一个最简单的例子, 重定义了2个表的加法操作. 这个例子中将c的\_\_add域改写后将a的Metatable设置为c, 当执行到加法的操作时, Lua首先会检查a是否有Metatable并且Metatable中是否存在\_\_add域, 如果有则调用, 否则将检查b的条件(和a相同), 如果都没有则调用默认加法运算, 而table没有定义默认加法运算, 则会报错.

--定义2个表
    a = {5, 6}
    b = {7, 8}
    --用c来做Metatable
    c = {}
    --重定义加法操作
    c.__add = function(op1, op2)
       for _, item in ipairs(op2) do
          table.insert(op1, item)
       end
       return op1
    end
    --将a的Metatable设置为c
    setmetatable(a, c)
    --d现在的样子是{5,6,7,8}
    d = a + b

转自：http://www.cnblogs.com/simonw/archive/2007/01/17/622032.html

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

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

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

这里的 mytable 是指**被操作的table**，mymetatable 是操作符重载函数的定于区域。

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

mytable = setmetatable({},{})

以下为返回对象元表：

getmetatable(mytable)                 -- 这回返回mymetatable

--------------------

## \_\_index 元方法 ##

这是 metatable 最常用的键。

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

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

$ lua
    Lua 5.3.0  Copyright (C) 1994-2015 Lua.org, PUC-Rio
    > other = { foo = 3 } 
    > t = setmetatable({}, { __index = other }) --__index包含一个 table
    > t.foo
    3
    > t.bar
    nil

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

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

mytable = setmetatable({key1 = "value1"}, {
      __index = function(mytable, key) -- __index 包含一个函数，这函数只会 在用序号访问元素时调用
        if key == "key2" then
          return "metatablevalue"
        else
          return nil
        end
      end
    })
    
    print(mytable.key1,mytable.key2)

实例输出结果为：

value1    metatablevalue

实例解析：

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

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

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

摘录 program in lua 中的解释用以加深理解：

“

-- create a namespace
        Window = {}
        -- create the prototype with default values
        Window.prototype = {x=0, y=0, width=100, height=100, }
        -- create a metatable
        Window.mt = {}
        -- declare the constructor function
        function Window.new (o) -- 新建，对 o 添加了 mt，从而绑定 __index 方法
          setmetatable(o, Window.mt)
          return o
        end
    -- Now, we define the __index metamethod:
        Window.mt.__index = function (table, key) -- 在 print 的时候调用
          return Window.prototype[key]
        end
    -- After that code, we create a new window and query it for an absent field:
        w = Window.new{x=10, y=20, i=1}--新建一个 object
        print(w.width)    --> 100，调试可见width是隐藏的，w只有x y 和 i

整体而言，这个语言特性也可以使用简单的办法实现。但是应该在继承和面向对象的特性上有重要作用。目前仅在此简单给出特性，待后续详细体会。

摘自：https://www.lua.org/pil/13.4.1.html

”

### 总结 ###

Lua查找一个表元素时的规则，其实就是如下3个步骤:

*  1.在表中查找，如果找到，返回该元素，找不到则继续
 *  2.判断该表是否有元表，如果没有元表，返回nil，有元表则继续。
 *  3.判断元表有没有\_\_index方法，  
    如果\_\_index方法为nil，则返回nil；  
    如果\_\_index方法是一个表，则重复1、2、3；  
    如果\_\_index方法是一个函数，则返回该函数的返回值。

--------------------

## \_\_newindex 元方法 ##

\_\_newindex 元方法用来**对表更新**，\_\_index则用来**对表访问** 。

当你给表的一个缺少的索引赋值，解释器就会查找\_\_newindex 元方法：如果存在则调用这个函数而不进行赋值操作。

以下实例演示了 \_\_newindex 元方法的应用：

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)

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

value1
    nil    新值2
    新值1    nil

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

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

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)

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

new value    "4"

" **下面示例更加明显的展示了 \_\_index 和 \_\_newindex 的差别**：

t = {}   -- original table (created somewhere)
        
        -- keep a private access to original table
        local _t = t
        
        -- create proxy
        t = {}
        
        -- create metatable
        local mt = { -- 注意 metatable 操作符重载可以用这种写法
          __index = function (t,k) -- 在访问元素时调用，即 t[2]
            print("*access to element " .. tostring(k))
            return _t[k]   -- access the original table
          end,
        
          __newindex = function (t,k,v) -- 在增加/修改 元素的值时调用，即 t[2] = 90
            print("*update of element " .. tostring(k) ..
                                 " to " .. tostring(v))
            _t[k] = v   -- update original table
          end
        }
        setmetatable(t, mt)
    This code tracks every access to t:
        > t[2] = 'hello'
        *update of element 2 to hello
        > print(t[2])
        *access to element 2
        hello

这俩的最大差异，就是被不同的过程调用。就好比，\_\_index是访问元素的响应函数，\_\_newindex是增加/修改的响应。

还有一点要注意的是

摘自：https://www.lua.org/pil/13.4.4.html

--------------------

## 为表添加操作符 ##

以下实例演示了两表**相加操作（相当于重载 + ）**：

-- 计算表中最大值，table.maxn在Lua5.2以上版本中已无法使用
    -- 自定义计算表中最大键值函数 table_maxn，即计算表的元素个数
    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

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

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

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

<table> 
 <tbody> 
  <tr> 
   <th>模式</th> 
   <th>描述</th> 
  </tr> 
  <tr> 
   <td>__add</td> 
   <td>对应的运算符 '+'.</td> 
  </tr> 
  <tr> 
   <td>__sub</td> 
   <td>对应的运算符 '-'.</td> 
  </tr> 
  <tr> 
   <td>__mul</td> 
   <td>对应的运算符 '*'.</td> 
  </tr> 
  <tr> 
   <td>__div</td> 
   <td>对应的运算符 '/'.</td> 
  </tr> 
  <tr> 
   <td>__mod</td> 
   <td>对应的运算符 '%'.</td> 
  </tr> 
  <tr> 
   <td>__unm</td> 
   <td>对应的运算符 '-'.</td> 
  </tr> 
  <tr> 
   <td>__concat</td> 
   <td>对应的运算符 '..'.</td> 
  </tr> 
  <tr> 
   <td>__eq</td> 
   <td>对应的运算符 '=='.</td> 
  </tr> 
  <tr> 
   <td>__lt</td> 
   <td>对应的运算符 '&lt;'.</td> 
  </tr> 
  <tr> 
   <td>__le</td> 
   <td>对应的运算符 '&lt;='.</td> 
  </tr> 
 </tbody> 
</table>

--------------------

## \_\_call 元方法 ##

\_\_call 元方法在 Lua **调用一个值**时调用，相当于 **() 的重载**。以下实例演示了计算表中元素的和：

-- 计算表中最大值，table.maxn在Lua5.2以上版本中已无法使用
    -- 自定义计算表中最大键值函数 table_maxn，即计算表的元素个数
    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))

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

--------------------

## \_\_tostring 元方法 ##

\_\_tostring 元方法用于**修改表的输出行为**。以下实例我们**自定义了表的输出内容（被print的时候调用）**：

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)

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

表所有元素的和为 60

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

转载于:https://www.cnblogs.com/alexYuin/p/10011428.html