深入Lua包(Package)与依赖管理

一、包的目录结构与require

require 函数天生就能理解目录结构。它通过点(.)来代表目录分隔符。

假设我们有这样一个项目结构:

bash 复制代码
/my_app
├── main.lua
└── /geometry       <-- 这是一个包
    ├── shape.lua
    └── transform.lua

shape.lua:

lua 复制代码
local M = {}
function M.new_circle(radius) return { type = 'circle', r = radius, x = 0, y = 0 } end
return M

transform.lua:

lua 复制代码
local M = {}
function M.move(shape, dx, dy)
    shape.x = shape.x + dx
    shape.y = shape.y + dy
    return shape
end
return M

main.lua 中,我们可以轻松地加载这个包里的模块:

lua 复制代码
-- main.lua

-- 加载 geometry 包中的 shape 模块
local Shape = require("geometry.shape")

-- 加载 geometry 包中的 transform 模块
local Transform = require("geometry.transform")

-- 现在可以使用它们的功能
local circle = Shape.new_circle(10)
local moved_circle = Transform.move(circle, 5, 5)

print("圆形位置:", moved_circle.x, moved_circle.y)

二、包的核心入口:init.lua 文件

当我们无法或者不需要理解包内部结构时,就需要 init.lua 来导出外部需要的接口。require 一个目录时,Lua 会自动寻找并加载该目录下的 init.lua 文件

让我们来改造一下上面的 geometry 包:

目录结构:

bash 复制代码
/my_app
├── main.lua
└── /geometry
    ├── shape.lua
    ├── transform.lua
    └── init.lua      <-- 新增的核心入口文件

init.lua (关键部分):

lua 复制代码
-- geometry/init.lua

-- 1. 创建一个代表整个包的表
local geometry = {}

-- 2. 加载包内部的私有模块
local Shape = require("geometry.shape")
local Transform = require("geometry.transform")

-- 3. 将需要暴露给外部的函数,挂载到 geometry 表上
geometry.create_circle = Shape.new_circle
geometry.move_shape = Transform.move

-- 4. 返回这个整合后的表
return geometry

现在,我们的 main.lua 可以变得更加简洁和高内聚:

lua 复制代码
-- main.lua

-- 只需要加载 geometry 这一个包!
local geometry = require("geometry")

-- 通过包提供的主接口来使用功能
local my_shape = geometry.create_circle(10)
geometry.move_shape(my_shape, 5, 5)

print("形状位置:", my_shape.x, my_shape.y)

三、包的搜索路径:package.path

当你调用 require("geometry") 时,Lua 怎么知道去哪里找这个文件呢?它使用 package.path 这个变量,其中包含一系列搜索路径模板。

你可以查看它:

lua 复制代码
print(package.path)

通常会输出类似这样的内容:

s 复制代码
./?.lua;/usr/local/share/lua/5.4/?.lua;/usr/local/share/lua/5.4/?/init.lua

其中的 ? 会被你传给 require 的模块名替换。

如果需要,你也可以修改它来添加自定义搜索路径:

lua 复制代码
package.path = package.path .. ";/my/custom/path/?.lua"

结语

点个赞,关注我获取更多实用 Lua 技术干货!如果觉得有用,记得收藏本文!

相关推荐
Nan_Shu_6142 分钟前
学习: Threejs (2)
前端·javascript·学习
G_G#10 分钟前
纯前端js插件实现同一浏览器控制只允许打开一个标签,处理session变更问题
前端·javascript·浏览器标签页通信·只允许一个标签页
@大迁世界26 分钟前
TypeScript 的本质并非类型,而是信任
开发语言·前端·javascript·typescript·ecmascript
GIS之路34 分钟前
GDAL 实现矢量裁剪
前端·python·信息可视化
是一个Bug38 分钟前
后端开发者视角的前端开发面试题清单(50道)
前端
Amumu1213840 分钟前
React面向组件编程
开发语言·前端·javascript
持续升级打怪中1 小时前
Vue3 中虚拟滚动与分页加载的实现原理与实践
前端·性能优化
GIS之路1 小时前
GDAL 实现矢量合并
前端
hxjhnct1 小时前
React useContext的缺陷
前端·react.js·前端框架
前端 贾公子2 小时前
从入门到实践:前端 Monorepo 工程化实战(4)
前端