如何创建一个 Lua 模块

如何创建一个 Lua 模块

翻译自: How to Create a Lua Module

• 译者: FreeBlues

正文

Lua编程语言 中的一个 模块(module)是一个包含函数和变量的代码片段: 它是一个用户库. 它是把你的代码切分为多个文件的一种有力方法. 一个 模块 用 Lua 关键字 require 来加载. 模块 被编码到一个以 .lua 作为扩展名的文件中, 并且这个文件必须出现在 Lua 包搜索路径(package.path) 中.

一个 模块 实际上就是一个带有函数的 Lua 表(table)(这里有关于 Lua 的一个快速介绍). 这个表在 模块 文件的最后被返回. 这里有一个叫做 DemoLib.lua 的简单的 Lua 的 模块 的例子:

文件模块: DemoLib.lua

local demo_mod = {} -- The main table
 
function demo_mod.Mult(a, b)
  return a * b
end
 
return demo_mod

现在在 Lua 的 main 代码中, 我们可以加载这个 模块, 并且开始通过下面的代码来使用它:

-- Update the search path
local module_folder = "/home/jegx/my_kool_mods/"
package.path = module_folder .. "?.lua;" .. package.path
 
-- Load the module
demo = require "DemoLib"
 
-- Use it!
local result = demo.Mult(10, 2)

如果 模块 不在 Lua 搜索路径中, 你可以用保存着 模块 文件的路径来更新 package.path.

如果因为某些原因你需要重新加载 模块(例如动态编程), 只要把 package.loaded["DemoLib"] 赋值 nil 就可以了:

...
package.loaded["DemoLib"] = nil
demo = require "DemoLib"
...

我为了给示例创建一个高级而且更简单的接口开始在最近的例程 GLSL Hacker 中使用 Lua 的 模块. Lua 模块 的第一次使用在这篇文章Exploring GLSL – Normal Visualizer with Geometry Shaders (Shader Library)的例程中.

参考

Programming in Lua, 2nd edition, chapter 15