模块

从 Lua 5.1 语言添加了对模块和包的支持。一个 Lua 模块的数据结构是一个 Lua 值(通常是一个 Lua 表或者 Lua 函数)。一个 Lua 模块代码就是一个会返回这个 Lua 值的代码块。 可以使用内建函数 require() 来加载和缓存模块。简单的说,一个代码模块就是一个程序库,可以通过 require() 来加载。模块加载后的结果通常是一个 Lua table,这个表就像是一个命名空间,其内容就是模块中导出的所有东西,比如函数和变量。require() 函数会返回 Lua 模块加载后的结果,即用于表示该 Lua 模块的 Lua 值。

require() 函数

Lua 提供了一个名为 require() 的函数用来加载模块。要加载一个模块,只需要简单地调用 require("file") 就可以了,file 指模块所在的文件名。这个调用会返回一个由模块函数组成的 table,并且还会定义一个包含该 table 的全局变量。

在 Lua 中创建一个模块最简单的方法是:创建一个 table,并将所有需要导出的函数放入其中,最后返回这个 table 就可以了。

相当于将导出的函数作为 table 的一个字段,在 Lua 中函数是第一类值,提供了天然的优势。

把下面的代码保存在文件 my.lua 中

  1. local _M = {}
  2. local function get_name()
  3. return "Lucy"
  4. end
  5. function _M.greeting()
  6. print("hello " .. get_name())
  7. end
  8. return _M

把下面代码保存在文件 main.lua 中,然后执行 main.lua,调用上述模块。

  1. local my_module = require("my")
  2. my_module.greeting() -->output: hello Lucy

注:对于需要导出给外部使用的公共模块,出于安全考虑,要避免全局变量的出现。 我们可以使用 lj-releng 或 luacheck 工具完成全局变量的检测。至于如何做,到后面再讲。

另一个要注意的是,由于在 LuaJIT 中,require() 函数内不能进行上下文切换,所以不能够在模块的顶级上下文中调用 cosocket 一类的 API。 否则会报 attempt to yield across C-call boundary 错误。