Lua require函数

Lua 提供了一个名为 require 的函数用来加载模块。要加载一个模块，只需要简单地调用就可以了。

Lua require函数详解

语法

require("<模块名>")

或者

require "<模块名>"

说明

执行 require 后会返回一个由模块常量或函数组成的 table，并且还会定义一个包含该 table 的全局变量。

加载机制

对于自定义的模块，模块文件不是放在哪个文件目录都行，函数 require 有它自己的文件路径加载策略，它会尝试从 Lua 文件或 C 程序 库中加载模块。

require 用于搜索 Lua 文件的路径是存放在全局变量 package.path 中，当 Lua 启动后，会以环境变量 LUA_PATH 的值来初始这个环境变量。如果没有找到该环境变量，则使用一个编译时定义的默认路径来初始化。

当然，如果没有 LUA_PATH 这个环境变量，也可以自定义设置，在当前用户根目录下打开 .profile 文件（没有则创建，打开 .bashrc 文件也可以），例如把 “~/lua/” 路径加入 LUA_PATH 环境变量里：

#LUA_PATH
export LUA_PATH="~/lua/?.lua;;"

文件路径以 “;” 号分隔，最后的 2 个 “;;” 表示新加的路径后面加上原来的默认路径。接着，更新环境变量参数，使之立即生效。

source ~/.profile

这时假设 package.path 的值是：

/Users/haicoder/lua/?.lua;./?.lua;/usr/local/share/lua/5.1/?.lua;/usr/local/share/lua/5.1/?/init.lua;/usr/local/lib/lua/5.1/?.lua;/usr/local/lib/lua/5.1/?/init.lua

那么调用 require(“module”) 时就会尝试打开以下文件目录去搜索目标。

/Users/haicoder/lua/module.lua;
./module.lua
/usr/local/share/lua/5.1/module.lua
/usr/local/share/lua/5.1/module/init.lua
/usr/local/lib/lua/5.1/module.lua
/usr/local/lib/lua/5.1/module/init.lua

如果找过目标文件，则会调用 package.loadfile 来加载模块。否则，就会去找 C 程序库。

搜索的文件路径是从全局变量 package.cpath 获取，而这个变量则是通过环境变量 LUA_CPATH 来初始。

搜索的策略跟上面的一样，只不过现在换成搜索的是 so 或 dll 类型的文件。如果找得到，那么 require 就会通过 package.loadlib 来加载它。

案例

Lua模块require使用

使用 require 引入自定义模块，首先，我们定义一个 module.lua 文件，具体代码如下：

-- 文件名为 module.lua
-- 定义一个名为 module 的模块
module = {}
-- 定义一个常量
module.constant = "this is constant"
-- 定义一个函数
function module.func1()
    io.write("This is a public function\n")
end
local function func2()
    print("This is a private function")
end
function module.func3()
    func2()
end
return module

接着，我们再次定义个 haicoder.lua 文件，具体代码如下：

#!/usr/bin/lua
print("haicoder(www.haicoder.net)\n")
-- module 模块为上文提到到 module.lua
require("module")
print(module.constant)
module.func3()

程序运行后，控制台输出如下：

首先，我们定义了一个 module.lua 文件，里面定义了一个模块，接着，我们在 haicoder.lua 文件中，使用了 require 引入了 module 模块，并调用了 module 模块里的方法和变量。

我们也可以给加载的模块定义一个别名变量，方便调用：

#!/usr/bin/lua
print("haicoder(www.haicoder.net)\n")
-- 别名变量 m
local m = require("module")
print(m.constant)
m.func3()

程序运行后，控制台输出如下：

我们看到，运行结果与上面相同。

Lua require函数总结

Lua 提供了一个名为 require 的函数用来加载模块。要加载一个模块，只需要简单地调用就可以了。