Metatable In Lua 淺嘗輒止

什麼是Metatable

 

      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

有了個感性的認識後, 我們看看Metatable的具體特性.

      Metatable並不神秘, 他只是一個普通的table, 在table這個資料結構當中, Lua定義了許多重定義這些操作的入口. 他們均以雙底線開頭為table的域, 如上面例子的__add. 當你為一個值設定了Metatable, 並在Metatable中設定了重寫了相應的操作域, 在這個值執行這個操作的時候就會觸發重寫的自訂動作. 當然每個操作都有每個操作的方法格式簽名, 如__add會將加號兩邊的兩個運算元做為參數傳入並且要求一個傳回值. 有人把這樣的行為比作事件, 當xx行為觸發會啟用事件自訂動作.

Metatable中定義的操作

add, sub, mul, div, mod, pow, unm, concat, len, eq, lt, le, tostring, gc, index, newindex, call...

      在Lua中任何一個值都有Metatable, 不同的值可以有不同的Metatable也可以共用同樣的Metatable, 但在Lua本身提供的功能中, 不允許你改變除了table類型值外的任何其他類型值的Metatable, 除非使用C擴充或其他庫. setmetatable和getmetatable是唯一一組操作table類型的Metatable的方法.

Metatable與物件導向

      Lua是個面向過程的語言, 但通過Metatable可以類比出物件導向的樣子. 其關鍵就在於__index這個域. 他提供了表的索引值入口. 這很像重寫C#中的索引器, 當表要索引一個值時如table[key], Lua會首先在table本身中尋找key的值, 如果沒有並且這個table存在一個帶有__index屬性的Metatable, 則Lua會按照__index所定義的函數邏輯尋找. 仔細想想, 這不正為物件導向中的核心思想繼承, 提供了實現方式麼. Lua中實現物件導向的方式非常多, 但無論哪種都離不開__index.

      這個例子中我使用了Programming In Lua中的實現OO的方式, 建立了Bird(鳥)對象, 擁有會飛的屬性, 其他鳥對象基於此原型, Ostrich(鴕鳥)是鳥的一種但不會飛. 結果很明顯, Bird和Ostrich分別有獨立的狀態.

local Bird = {CanFly = true}

function Bird:New()
    local b = {}
    setmetatable(b, self)
    self.__index = self
    return b
end

local Ostrich = Bird:New() --Bird.CanFly is true, Ostrich.CanFly is true
Ostrich.CanFly = false --Bird.CanFly is true, Ostrich.CanFly is false

__newindex與__index相對應, 在對table的key做更新時觸發. 可以使用rawset和rawget對table的key操作來跳過這些事件的觸發.

調用與截獲

      Java與C#中需要費不少周折來實現動態代理和AOP, 類似這樣的功能在Lua中確很簡單, 雖然被限制了很多, 但你依然能夠感受到Lua的靈活. 這就是__call操作, 當值被調用時觸發. 

      這裡我將table類型的a做了一個函數方式的調用a(), 會觸發__call. 另一個應用樣本可以參見我的另一篇文章Lua中實作類別似C#的事件機制
a = {}
function a:Func()
   print("simonw")
end
c = {}
c.__call = function(t, )
   print("Start")
   t.Func()
   print("End")
end
setmetatable(a, c)
a()
--[[
Start
simonw
End
]]

      這裡的樣本都是以最簡單的方式展現, 以便能更清晰的描述核心, 更多的資料以及具體應用請參考Programming In Lua和Lua參考手冊.