Unity3D開發入門教程（二）—— Lua入門

五邑隱俠，本名關健昌，12年游戲生涯。 本教程以 Unity 3D + VS Code + C# + xlua 為例。

 

如果你還沒有編程基礎，建議你先學習一些編程基礎。本文不是完全菜鳥教程，主要針對有其他語言經驗的開發者，如果想看菜鳥教程，建議看菜鳥教程的 Lua教程。

先看一個簡單類的代碼

---@class BsnsPack @Base class of business pack
local BsnsPack = {
    -- class fields
    maxSerialNo = 0,
}

BsnsPack.__index = BsnsPack

--- new()
---@return BsnsPack
function BsnsPack.new()
    local o = {}

    -- member fields
    o.serialNo = 0
    o.mod = 0
    o.cmd = 0
    o.payload = nil
    
    -- bind BsnsPack methods
    setmetatable(o, BsnsPack)
    return o
end

--- set serial No.
---@param serialNo number
function BsnsPack:setSerialNo(serialNo)
    self.serialNo = serialNo
end

--- get serial No.
---@return number
function BsnsPack:getSerialNo()
    return self.serialNo
end

--- set mod
---@param mod number
function BsnsPack:setMod(mod)
    self.mod = mod
end

--- get mod
---@return number
function BsnsPack:getMod()
    return self.mod
end

--- set cmd
---@param cmd number
function BsnsPack:setCmd(cmd)
    self.cmd = cmd
end

--- get cmd
---@return number
function BsnsPack:getCmd()
    return self.cmd
end

--- set payload
---@param payload any
function BsnsPack:setPayload(payload)
    self.payload = payload
end

--- get payload
---@return any
function BsnsPack:getPayload()
    return self.payload
end

function BsnsPack.test()
    print(BsnsPack.serialNo)
end

--- testPrivate
---@param self BsnsPack
local function testPrivate(self)
    print(self.serialNo)
end

---@alias Request BsnsPack @Request is BsnsPack
local Request = BsnsPack

---@class Response : BsnsPack @Response class
local Response = {}
setmetatable(Response, BsnsPack) -- bind super methods
Response.__index = Response

--- new()
---@return Response
function Response.new()
    local o = BsnsPack.new()

    -- member fields
    o.code = 0

    setmetatable(o, nil) -- remove original metatable
    setmetatable(o, Response) -- bind Response methods
    return o
end

--- get result code
---@return number
function Response:getCode()
    return self.code
end

local bsnsPack = {}
bsnsPack.BsnsPack = BsnsPack
bsnsPack.Request = Request
bsnsPack.Response = Response

return bsnsPack

 

 

1、第1行：這是一行注釋

Lua的行注釋以兩個減號 -- 開頭，

class注解：---@class TYPE[: PARENT_TYPE {, PARENT_TYPE}]  [@comment]

這樣有利於 VS Code 代碼提示，例如將鼠標放到代碼中出現 BsnsPack 的地方上，會有小彈窗提示這個table的key，以及key的類型。

用得比較多的注解有 ---@class，---@return，---@param

 

2、第2行，定義一個叫 BsnsPack 的class（通過table模擬）。

Lua里沒有類，Lua的結構化數據類型叫table，基於key-value結構。相對於其他語言的 map / dictionary。訪問一個table的key對應的值，可以用點 . 來訪問，也可以用中括號[]來訪問

Lua里沒有單獨的數組結構，也是基於table，數組下標是key，數組元素是value，要注意的是，Lua里數組下標是從1開始的。

創建table的最簡單方式就是花括號 {}，創建一個空table。

Lua是腳本語言，變量不需要指定類型，只需要給它賦值。所以 BsnsPack = {maxSerialNo = 0,} 相當於定義了個變量 BsnsPack，它的值是一個table。

Lua的變量默認是全局的，加載到內存的Lua代碼都可以訪問這個變量。為了避免命名沖突和意外修改，一般建議變量定義為局部變量，限制它的作用域。在變量前面加個 local定義局部變量。

這里定義的 BsnsPack ，作用域只在這個文件里。其他文件不能訪問。也可以在函數、代碼塊里用 local 定義局部變量。

 

3、第7行，給 BsnsPack一個叫 __index 的 key 賦值為 BsnsPack 自己

Lua 的 table 里，__index 是個特殊的key，這是 Lua實現類和繼承的關鍵。

Lua里有個概念叫做元表。Lua定義了一些語言默認key，這些key一般跟 +、-、*、/等操作符、key的訪問、值更新關聯，這些key叫做元方法（Lua里的函數/方法也可以作為值），這些元方法合起來叫元表。

Lua里設置元表的方法是代碼第 21 行的 function setmetatable(t, metatable)，調用這個方法會讓參數 metatable 成為 參數 t 的元表。

設置元表后，在代碼里訪問參數 t 的一個key時會發生以下情況：

1）Lua先在 t 里找，看有沒有這個key，如果有，就返回這個key的值。否則，執行2）

2）Lua看參數 metatable 有沒有 __index 這個key，如果有，就在 __index 對應的值里查找（__index的值如果是表，在這個表里查找；如果是函數，執行這個函數）

BsnsPack.__index = BsnsPack，如果其他的table設置 BsnsPack 為元表，就可以訪問 BsnsPack 所有的key。 這些key的值如果是方法，就可以調用這些方法。

所以 BsnsPack 可以定義方法的模板，這就跟class類似。BsnsPack定義的數據key，相當於靜態字段class field。BsnsPack定義的方法key，可以是成員方法member method，也可以是class method，后面介紹

 

4、第11~23行，定義BsnsPack的一個叫new的key，它的值是一個方法

Lua里一個代碼塊不用花括號{}，通過end作為結束標記。

定義方法用 function 開頭，用點.或者冒號:分割talbe名和方法名，

用冒號:定義的方法，會有個默認參數self，相當於調用者，如果外部用 BsnsPack:new() 這樣調用，則self == BsnsPack，如果用a:new()這樣調用，self==a。

用點.定義的方法，沒有默認參數，只能顯式寫參數self。

一般地，用冒號:定義成員方法member method（例如第23行的 function BsnsPack:setSerialNo(serialNo) ）

1）調用 o:setSerialNo(serialNo) 時，這里的self是對象o，只改對象o的serialNo，其他對象的serialNo不受影響。

用點.定義構造對象的方法（例如第11行的 function BsnsPack.new()），以及靜態方法class method（例如第69行的 function BsnsPack.test() ）

1）在其他地方通過 BsnsPack.new()構造BsnsPack對象

1）在其他地方通過 BsnsPack.test()調用類方法

建議，方法定義的時候是冒號:，調用的時候用冒號:，定義的時候是點.，調用的時候也用點.

構造方法不一定叫new，只是為了統一，建議都用new，與其他語言一致。

方法new里面的 local o = {}，定義的key都是成員字段member field（每次調用方法 BsnsPack.new() 都創建一個新的 table並對其字段初始化后返回）

Lua沒有私有的成員方法，可以定義文件的 local 方法，把對象作為參數self顯式的傳進去（例如第79行 local function testPrivate(self)）

 

5、第84行，給類BsnsPack定義一個別名 Request，其實就是把一個table賦值給另外一個變量

 

6、第87~102行，定義一個類Response，繼承基類BsnsPack

第87行，定義子類Response

第88行，設置元表，使得Response可以訪問BsnsPack所有的key（繼承BsnsPack所有的方法）

第89行，所有對象可以訪問Response所有的key（通過遞歸，包括BsnsPack所有的key）

第94行，通過調用BsnsPack構造方法初始化o，o是BsnsPack的對象，擁有基類所有的member field

第97行，定義Response相對於基類新增的字段code

第99、100行，修改o的元表為Response，這樣o可以訪問Response所有的成員方法 member method（通過遞歸，包括BsnsPack所有的成員方法）

Response可以重寫BsnsPack的方法

function Response:getPayload()
    return self.payload
end

由於Lua里訪問key，先在table本身查找，如果沒有才在元表查找，所以會調用重寫的方法，實現多態。

 

7、第110~115行，導出本文件定義的類。

由於class的定義都是以 local 方式定義的局部變量，外部不能訪問，所以要把它當作文件的返回值 return

如果該文件只導出一個class，直接return這個局部變量就可以，（例如，如果只導出BsnsPack，return BsnsPack 就可以）

由於本文件需要導出3個class，這里把他們放到一個table里導出

其他文件需要訪問這個文件的class，需要調用require方法導入進來，該方法的參數是路徑（不含后綴.lua），返回值是這個lua文件的return值

local bsnsPack = require("Assets.Lua.bsns.bsns_pack")
local Request = bsnsPack.Request
local Response = bsnsPack.Response

 

8、如果想模塊化管理，把一個模塊所有的類通過一個文件暴露給其他模塊，可以在這個文件定義一個局部變量，把這個模塊所有的文件的類，都通過require導入進來，並賦值給跟類同名的key，最后返回這個局部變量

文件bsns.lua

local bsns = {}

local bsnsPack = require("Assets.Lua.bsns.bsns_pack")
bsns.Request = bsnsPack.Request
bsns.Response = bsnsPack.Response

bsns.BsnsMod = require("Assets.Lua.bsns.bsns_mod")
bsns.BsnsCenter = require("Assets.Lua.bsns.bsns_center")

return bsns

 

9、可以實現一個通用的類定義函數

--- define a class
--- t._className, a string array, define class name
--- t._super, a table, define super class
--- t.__ctor, a function(self, ...), define member fields
--- @param t any
function class(t)
    -- extends super
    if t._super ~= nil then
        -- static fields and methods
        local superStaticClone = {}
        for k, v in pairs(t._super) do
            if k == "_ctor" then
                goto continue
            end

            superStaticClone[k] = v

            ::continue::
        end

        setmetatable(t, superStaticClone)
    end
    
    t.__index = t
    -- new method
    t.new = function(...)
        local o = {}
        invokeCtor(o, t, ...)

        setmetatable(o, t) -- bind class
        return o
    end

    function invokeCtor(o, cls, ...)
        if cls._super ~= nil then
            invokeCtor(o, cls._super, ...)
        end

        if cls._ctor ~= nil then
            setmetatable(o, cls)
            o:_ctor(...)
            setmetatable(o, nil)
        end
    end

    return t
end

 

有了這個函數可以這樣定義類

local TestClass = class({
    -- class name
    _className = "TestClass",

    -- static fields:
    size = 2,
    count = 0,

    -- member:
    _ctor = function(self, ...)
        local params = {...}
        self.count = params[1]
        self.age = params[2]
    end
})

local TestClass2 = class({
    _className = "TestClass2",
    ---@class TestClass
    _super = TestClass,

    _ctor = function(self, ...)
        self.fdsl = 3256
    end
})

 

10、簡單語法介紹

1）Lua里的語句不需要分號;結尾

2）Lua常用的基本數據類型有nil、boolean、number、string、function、table

3）獲取數組長度用 #數組變量，例如

local array = {"Lua", "Tutorial"}
local len = #array
print(len)

4）遍歷數組用 

for i, v in ipairs(table) do

end

5）遍歷對象用

for k, v in pairs(obj) do

end

6）其他語法請查閱菜鳥教程

 

11、Lua代碼規范可參考 https://lua.ren/topic/172/