1. 程式人生 > >lua 14 metatable (類似操作符重載)

lua 14 metatable (類似操作符重載)

names air 種類 sim span space 重要 概念 hello

轉自: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.maxnLua5.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 鍵包含在元表中,並進行相加操作。 表中對應的操作列表如下:(註意:__是兩個下劃線)

模式描述
__add 對應的運算符 ‘+‘.
__sub 對應的運算符 ‘-‘.
__mul 對應的運算符 ‘*‘.
__div 對應的運算符 ‘/‘.
__mod 對應的運算符 ‘%‘.
__unm 對應的運算符 ‘-‘.
__concat 對應的運算符 ‘..‘.
__eq 對應的運算符 ‘==‘.
__lt 對應的運算符 ‘<‘.
__le 對應的運算符 ‘<=‘.

__call 元方法

__call 元方法在 Lua 調用一個值時調用。以下實例演示了計算表中元素的和:

-- 計算表中最大值,table.maxnLua5.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))

以上實例執行輸出結果為:

70

__tostring 元方法

__tostring 元方法用於修改表的輸出行為。以下實例我們自定義了表的輸出內容:

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 代碼。

lua 14 metatable (類似操作符重載)