Lua 模块与包

模块类似于一个封装库,从 Lua 5.1 开始,Lua 加入了标准的模块管理机制,可以把一些公用的代码放在一个文件里,以 API 接口的形式在其他地方调用,有利于代码的重用和降低代码耦合度。

Lua 的模块是由变量、函数等已知元素组成的 table,因此创建一个模块很简单,就是创建一个 table,然后把需要导出的常量、函数放入其中,最后返回这个 table 就行。以下为创建自定义模块 module.lua,文件代码格式如下:

-- 文件名为 module.lua
-- 定义一个名为 module 的模块
module = {}

-- 定义一个常量
module.constant = "这是一个常量"

-- 定义一个函数
function module.func1()
    io.write("这是一个公有函数!\n")
end

local function func2()
    print("这是一个私有函数!")
end

function module.func3()
    func2()
end

return module

由上可知,模块的结构就是一个 table 的结构,因此可以像操作调用 table 里的元素那样来操作调用模块里的常量或函数。
上面的 func2 声明为程序块的局部变量,即表示一个私有函数,因此是不能从外部访问模块里的这个私有函数,必须通过模块里的公有函数来调用.

require 函数

Lua提供了一个名为require的函数用来加载模块。要加载一个模块,只需要简单地调用就可以了。例如:
require(“<模块名>”)
或者
require “<模块名>”
执行 require 后会返回一个由模块常量或函数组成的 table,并且还会定义一个包含该 table 的全局变量。

-- test_module.lua 文件
-- module 模块为上文提到到 module.lua
require("module")

print(module.constant)

module.func3()

以上代码执行结果为:
这是一个常量
这是一个私有函数!

或者给加载的模块定义一个别名变量,方便调用:
– test_module2.lua 文件
– module 模块为上文提到到 module.lua
– 别名变量 m
local m = require(“module”)

print(m.constant)

m.func3()
以上代码执行结果为:
这是一个常量
这是一个私有函数!

加载机制

我们要研究lua的加载机制其实也是很简单的

require("haha");

我们加载一个不存在的模块

报错:
no field package.preload[‘haha’]
no file ‘.\haha.lua’
no file ‘C:\Program Files (x86)\Lua\5.1\lua\haha.lua’
no file ‘C:\Program Files (x86)\Lua\5.1\lua\haha\init.lua’
no file ‘C:\Program Files (x86)\Lua\5.1\haha.lua’
no file ‘C:\Program Files (x86)\Lua\5.1\haha\init.lua’
no file ‘C:\Program Files (x86)\Lua\5.1\lua\haha.luac’
no file ‘.\haha.dll’
no file ‘.\haha51.dll’
no file ‘C:\Program Files (x86)\Lua\5.1\haha.dll’
no file ‘C:\Program Files (x86)\Lua\5.1\haha51.dll’
no file ‘C:\Program Files (x86)\Lua\5.1\clibs\haha.dll’
no file ‘C:\Program Files (x86)\Lua\5.1\clibs\haha51.dll’
no file ‘C:\Program Files (x86)\Lua\5.1\loadall.dll’
no file ‘C:\Program Files (x86)\Lua\5.1\clibs\loadall.dll’

print("require查找的路径")
print(package.path)
print("------------------")
print("require找不到的,就来c路径下找")
print(package.cpath)

--当找到了这个文件以后,如果这个文件是一个Lua文件,
--它就通过loadfile来加载该文件;
--如果找到的是一个C程序库,就通过loadlib来加载?
--loadfile和loadlib都只是加载了代码,
--并没有运行它们,为了运行代码,
--require会以模块名作为参数来调用这些代码