Lua - 模块：初学者的指南

Hello, 有志於编程的朋友们！今天，我們將踏上一段令人興奮的旅程，探索Lua模塊的世界。別擔心如果你是编程新手——我將成為你的友好導遊，我們將一步步地探索這個主題。那麼，讓我們來看看吧！

Lua - Modules

模塊是什麼？

想像一下你正在建造一座巨大的樂高城堡。一次性創建所有東西會不會很困難？難道分開建造較小的部分然後將它們組合起來會更簡單嗎？這正是编程中模塊的作用！

在Lua中，一個模塊就像是一個包含相關函數、變量和其它代碼的小型程序。這是一種將代碼組織成可管理、可重用的塊的方法。這使得你的程序更易於理解、維護和調試。

示例 1：一個簡單的模塊

讓我們創建一個簡單的模塊，名為 greetings.lua：

local greetings = {}

function greetings.sayHello(name)
return "Hello, " .. name .. "!"
end

function greetings.sayGoodbye(name)
return "Goodbye, " .. name .. ". Have a great day!"
end

return greetings

在這個例子中，我們創建了一個包含兩個函數：sayHello 和 sayGoodbye 的模塊。我們稍後會看到如何使用這個模塊！

Lua模塊的特色

Lua模塊具有一些特別的特徵，這些特徵使它們強大且靈活：

默認為局部變量：除非顯式地指定為全局變量，模塊中的所有東西都是局部的。這可以防止與程序其他部分的命名冲突。
返回值：模塊通常返回一個包含其函數和變量的表，使其能夠被程序的其他部分訪問。
懶加載：模塊只在需要時才被加載，這可以提高程序的性能。

require函數

現在我們有了模塊，我們如何使用它呢？讓我們來認識一下 require 函數——通往模塊奇蹟之地的車票！

示例 2：使用require函數

讓我們在另一個文件中使用我們的 greetings 模塊，比如 main.lua：

local myGreetings = require("greetings")

print(myGreetings.sayHello("Alice"))
print(myGreetings.sayGoodbye("Bob"))

當你運行這段代碼時，你會看到：

Hello, Alice!
Goodbye, Bob. Have a great day!

這裡發生了什麼：

require("greetings") 加載我們的模塊並返回它的表。
我們將這個表存儲在 myGreetings 中。
現在我們可以通過調用 myGreetings.functionName() 使用我們模塊中的函數。

需要記住的事項

當使用Lua模塊時，請記住以下幾點：

文件命名：你的模塊文件名應該與你在 require 中使用的名字匹配。例如，require("greetings") 尋找的是名為 greetings.lua 的文件。
路徑搜索：Lua 在多個地方搜索模塊，包括當前目錄和指定在 LUA_PATH 環境變量中的目錄。
緩存：一旦一個模塊被加載，Lua 會緩存它。對同一模塊的後續 require 調用將返回緩存的版本。

示例 3：模塊緩存

讓我們修改我們的 greetings.lua 來演示緩存：

local greetings = {}
local count = 0

function greetings.sayHello(name)
count = count + 1
return "Hello, " .. name .. "! (Called " .. count .. " times)"
end

return greetings

現在，讓我們多次使用這個模塊：

local myGreetings1 = require("greetings")
local myGreetings2 = require("greetings")

print(myGreetings1.sayHello("Charlie"))
print(myGreetings2.sayHello("David"))
print(myGreetings1.sayHello("Eve"))

輸出：

Hello, Charlie! (Called 1 times)
Hello, David! (Called 2 times)
Hello, Eve! (Called 3 times)

注意計數器在所有調用中增加，即使我們使用了兩次 require。這是因為Lua在第一次 require 後緩存了模塊。

舊的模塊實現方式

在Lua 5.1引入我們討論的模塊系統之前，有一種較老的創建模塊的方式。雖然不建議在新的代碼中使用它，但你可能會在舊的程序中遇到它。

示例 4：舊式模塊

這是我們的 greetings 模塊在舊風格中可能看起來的樣子：

module("greetings", package.seeall)

function sayHello(name)
return "Hello, " .. name .. "!"
end

function sayGoodbye(name)
return "Goodbye, " .. name .. ". Have a great day!"
end

要使用這個模塊：

require("greetings")

print(greetings.sayHello("Frank"))
print(greetings.sayGoodbye("Grace"))

儘管這看起來更簡單，但它有像污染全局命名空間和潛在的命名冲突這樣的缺點。

結論

恭喜你！你剛剛踏入了Lua模塊世界的第一步。我們已經介紹了模塊是什麼，如何創建和使用它們，以及一些重要的記住事項。模塊是你编程工具包中的一個強大工具，幫助你寫出更乾淨、更有組織的代碼。

記住，熟能生巧。試著創建你自己的模塊，嘗試不同的結構，最重要的是，玩得開心！未來的Lua大師，祝你編程愉快！

以下是我們討論過的關鍵函數的總結：

函數	描述
`require(moduleName)`	加載一個模塊並返回其表
`module(name, package.seeall)`	舊方式創建模塊（不建議在新的代碼中使用）

Credits: Image by storyset