Lua中的模組與module函數詳解_Lua

很快就要開始介紹Lua裡的“物件導向”了，在此之前，我們先來瞭解一下Lua的模組。

1.編寫一個簡單的模組

Lua的模組是什麼東西呢？通常我們可以理解為是一個table，這個table裡有一些變數、一些函數…

等等，這不就是我們所熟悉的類嗎？

沒錯，和類很像（實際上我說不出它們的區別）。
 
我們來看看一個簡單的模組，建立一個檔案，命名為game.lua，代碼如下：

複製代碼 代碼如下:

game = {}
function game.play()
    print("那麼，開始吧");
end
function game.quit()
    print("你走吧，我保證你不會出事的，呵，呵呵");
end
return game;

我們定義了一個table，並且給這個table加了兩個欄位，只不過這兩個欄位的值是函數而已。

至於如何使用模組，那就要用到我們之前介紹過的require了。
 
我們在main函數裡這麼使用：

複製代碼 代碼如下:

local function main()
    cc.FileUtils:getInstance():addSearchPath("src")
    game = require("game");
  
    game.play();
end

注意，我們要require其他檔案的時候，要把檔案路徑給設定好，否則會找不到檔案。
因為我使用的是Cocos Code IDE，直接調用addSearchPath函數就可以了，我的game.lua檔案是在src目錄下的。
 
好了，運行代碼，結果如下：

複製代碼 代碼如下:

[LUA-print] 那麼，開始吧

OK，這就是一個很簡單的模組，如果我們習慣了Java、C++等物件導向語言，那也可以簡單地把模組理解為類。

2.為以後的自己偷懶——避免修改每個函數中的模組名

假設我們想把剛剛的game模組改個名字，改成eatDaddyGame，那麼，我們需要做以下兩件事情：

1).修改game.lua的檔案名稱
2).修改game.lua的內容，把所有的game改成eatDaddyGame
 
目前的game.lua函數還算少，就兩個，實際上一個模組的函數肯定不會少的，那麼，要這麼去改這些函數，太煩了。

如果批量修改，又怕有哪個地方改錯。

於是，我們可以這麼偷懶：

複製代碼 代碼如下:

game = {}
local M = game;
function M.play()
    print("那麼，開始吧");
end
function M.quit()
    print("你走吧，我保證你不會出事的，呵，呵呵");
end
return M;

我們用一個局部變數M來代替了game，於是，以後我們只需要修改前面兩個的game就可以了，函數部分的內容完全不需要去修改。

這個偷懶其實蠻有用的，某些情況下，修改越少，越安全~

3.更進一步的偷懶——模組名參數

實際上，我們可以更加得偷懶，以後修改模組名，只需要修改模組的檔案名稱就可以了，檔案內容可以不管，具體怎麼實現？

看代碼：

複製代碼 代碼如下:

local M = {};
local modelName = ...;
_G[modelName] = M;
function M.play()
    print("那麼，開始吧");
end
function M.quit()
    print("你走吧，我保證你不會出事的，呵，呵呵");
end
return M;

留意一下，這裡有一個 local modelName = …
“…”就是傳遞給模組的模組名，在這裡其實就是“game”這個字串。
 
接著，有點微妙了，還記得之前介紹的全域環境_G嗎？我們以”game”作為欄位名，添加到_G這個table裡。

於是，當我們直接調用game的時候，其實就是在調用_G["game"]的內容了，而這個內容就是這裡的M。
 
能邏輯過來嗎？就是這麼簡單，在你沒有忘記_G的前提下~

4.利用非全域環境製作更簡潔和安全的模組

如果說，剛剛已經達到了我們作為高(ai)智(zhe)商(teng)人群的巔峰，那，你就太天真了。

巔峰就是要拿來超越的，還記得我們的非全域環境嗎？就是那個setfenv函數。
 
我們來看看下面的代碼：

複製代碼 代碼如下:

local M = {};
local modelName = ...;
_G[modelName] = M;
setfenv(1, M);
function play()
    print("那麼，開始吧");
end
function quit()
    print("你走吧，我保證你不會出事的，呵，呵呵");
end
return M;

我們把game.lua這個模組裡的全域環境設定為M，於是，我們直接定義函數的時候，不需要再帶M首碼。

因為此時的全域環境就是M，不帶首碼去定義變數，就是全域變數，這時的全域變數是儲存在M裡。

所以，實際上，play和quit函數仍然是在M這個table裡。
 
於是，我們連首碼都不用寫了，這真是懶到了一個極致，簡直就是藝術~

另外，由於當前的全域環境是M，所以， 在這裡不需要擔心重新定義了已存在的函數名，因為外部的全域變數與這裡無關了。
 
當然，如果大家現在就運行代碼，肯定會報錯了。

因為我們的全域環境改變了，所以print函數也找不到了。

為瞭解決這個問題，我們看看第5條內容吧~

5.解決原全域變數的無法找到的問題——方案1

第一個方法，就是我們之前介紹過的，使用繼承，如下代碼：

複製代碼 代碼如下:

local M = {};
local modelName = ...;
_G[modelName] = M;
-- 方法1：使用繼承
setmetatable(M, {__index = _G});
setfenv(1, M);
function play()
    print("那麼，開始吧");
end
function quit()
    print("你走吧，我保證你不會出事的，呵，呵呵");
end
return M;

沒錯，使用__index元方法就能解決這個問題了，當找不到print等函數時，就會去原來的_G裡尋找。

6.解決原全域變數的無法找到的問題——方案2

第二個方法更簡單，使用一個局部變數把原來的_G儲存起來，如下代碼：

複製代碼 代碼如下:

local M = {};
local modelName = ...;
_G[modelName] = M;
-- 方法2：使用局部變數儲存_G
local _G = _G;
setfenv(1, M);
function play()
    _G.print("那麼，開始吧");
end
function quit()
    _G.print("你走吧，我保證你不會出事的，呵，呵呵");
end
return M;

這種方法的缺點比較明顯，那就是，每次調用print等函數時，都要使用_G首碼。

7.解決原全域變數的無法找到的問題——方案3

第三個方法比較繁瑣，使用局部變數把需要用到的其他模組儲存起來，如下代碼：

複製代碼 代碼如下:

local M = {};
local modelName = ...;
_G[modelName] = M;
-- 方法3：儲存需要使用到的模組
local print = print;
setfenv(1, M);
function play()
    print("那麼，開始吧");
end
function quit()
    print("你走吧，我保證你不會出事的，呵，呵呵");
end
return M;

這種方法的缺點更明顯了，所有用到的模組都要用局部變數聲明一次，煩人。
 
但，就速度而言，第三種方案比第二種方案快，第二種方法又比第一種快。
但至於快多少，我也不知道，只是理論上~我也沒測試。

8.你就笑吧，但，我還想更加偷懶——module函數

本以為剛剛介紹的那些技巧已經夠偷懶的吧？
但Lua似乎知道我們有多懶似的，它竟然把我們把這一切都自動完成了。
再來回憶我們剛剛為了偷懶而寫的幾句代碼：

複製代碼 代碼如下:

local M = {};
local modelName = ...;
_G[modelName] = M;
setmetatable(M, {__index = _G});
setfenv(1, M);

就這幾句代碼，其實我們可以忽略不寫，因為，我們有module函數，它的功能就相當於寫了這些代碼。
我們修改一下game.lua的內容，如下代碼：

複製代碼 代碼如下:

module(..., package.seeall);
function play()
    print("那麼，開始吧");
end
function quit()
    print("你走吧，我保證你不會出事的，呵，呵呵");
end

注意，前面的幾行代碼都沒了，只留下了一個module函數的調用。

module函數的調用已經相當於之前的那些代碼了。

而package.seeall參數的作用就是讓原來的_G依然生效，相當於調用了：setmetatable(M, {__index = _G});
 
再次留意一下，代碼末尾的return M也不見了，因為module函數的存在，已經不需要我們主動去返回這個模組的table了。

9.結束

這篇結束的內容似乎有點多，我也寫了一個多小時了。

其實我還省略不少東西，比如package.loaded，lua路徑尋找的規則等等。

因為這些Cocos Code IDE，或者說是Cocos2d-x lua，已經幫我們做了，我們不需要去管這些。

所以我就避重就輕了，啊不，是顧此失彼…不對~！反正，就是那個意思了~！