Lua Packages

keep-learner2024-02-13 9:31

Lua 并没有提供明确的机制来实现 packages。然而，我们通过语言提供的基本的机制很容易实现他。主要的思想是：像标准库一样，使用表来描述 package。

基本示例

package的简单方法就是对包内的每一个对象都加包名作为前缀。官方示例代码用complex复数表作为例子来阐述package的基本语法：

Lua 复制代码

complex = {}
function complex.new (r, i) return {r=r, i=i} end

complex.i = complex.new(0, 1)

function complex.add (c1, c2)
    return complex.new(c1.r + c2.r, c1.i + c2.i)
end

function complex.sub (c1, c2)
    return complex.new(c1.r - c2.r, c1.i - c2.i)
end

local c1 = complex.add(complex.new(1,2),complex.new(2,-2))
print(c1.r,c1.i) --3       0
return complex

私有成员local

在成员前添加local修饰符即可实现对这个成员的访问空间仅在这个package内部，并且内部可以不需要再重复写上package名。比如以上例子中的add函数，前面加一个local修饰后的代码结构：

Lua 复制代码

local function add (c1, c2)
    return complex.new(c1.r + c2.r, c1.i + c2.i)
end

local c1 = add(complex.new(1,2),complex.new(2,-2))
print(c1.r,c1.i) --3       0

如若既希望其是公有函数（在package外面可被访问）又不希望其在package内部通过package.的冗余前缀方式访问，则可以直接结合两种方案，在声明时为local，在最后显式链接即可，比如上面的add函数，在最后一行写complex.add = add即可。我们需要注意的是这个定义不能放在函数的定义local function add之前，因为lua是顺序读取文件的，在函数定义之前则会意味着complex.add = nil.

使用全局表

如若不想用local也期望达到以上直接访问的效果（不需要冗余前缀访问），则可以利用setfenv(1,complex)来设置当前环境。此句话的目的就是当前的默认Global环境是complex，如果定义了complex.a = 1，则设置此环境之后的print(a)就是1。由此可在调用函数的时候就不需要package前缀了。当然这里需要注意的是Lua5.4已经不再支持setfenv了。