模块声明
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 的全局变量。
– module 模块为上文提到到 module.lua
require(“module”)
print(module.constant)
module.func3()
module.func2() --报错
或者给加载的模块定义一个别名变量,方便调用:
local m = require(“module”)
print(m.constant)
m.func3()
加载机制
对于自定义的模块,模块文件不是放在哪个文件目录都行,函数 require 有它自己的文件路径加载策略,它会尝试从 Lua 文件或 C 程序库中加载模块。
require 用于搜索 Lua 文件的路径是存放在全局变量 package.path 中,当 Lua 启动后,会以环境变量 LUA_PATH 的值来初始这个环境变量。如果没有找到该环境变量,则使用一个编译时定义的默认路径来初始化。
万能的路径
前面我们已经说过lua加载机制,模块文件不是放在哪个目录下都行的。每次我们配置环境变量有点麻烦,在此为大家献上万能的路径。
我当前有个路径:C:\Users\Administrator\Desktop\LuaCode
在此文件中有一个Main.lua作为启动文件,我们在Main.lua中加载Student.lua
如果我们直接加载会有意料之中的错误。
配置环境变量的方式我们不在讲解,在这里我猜测你估计也不会每次去添加相关路径(当然你也可能这么做)接下来我们在代码中添加如下代码:
local p = "C:\\Users\\Administrator\\Desktop\\LuaCode\\"
local m_package_path = package.path;
package.path = string.format("%s?.lua;%s?\\init.lua;%s",p,p,m_package_path)
local Student = require("Student")
print(Student.type)
这里面是Student.lua中的type的内容,这里不在公示其代码
大家还可能看到有一个xxx的目录,此目录中有一个Animal.lua文件
如果我们要架在你此文件那么我们修改相关代码
local p = "C:\\Users\\Administrator\\Desktop\\LuaCode\\"
local m_package_path = package.path;
package.path = string.format("%s?.lua;%s?\\init.lua;%s",p,p,m_package_path)
package.path = package.path ..';..\\?.lua';
local Student = require("Student")
print(Student.type)
local Animal = require("xxx/Animal")
print(Animal.Age)