第五章：模块与包

模块和包是组织和管理大型程序的重要工具。

它们允许我们将代码分割成小的、可管理的部分，提高代码的可重用性和可维护性。

5.1 模块的概念

模块是一种将相关函数和变量组织在一起的方式，它提供了一个独立的命名空间，有助于避免全局变量的污染。

模块的优势：

1. 代码组织：相关功能集中在一起。
2. 命名空间管理：避免命名冲突。
3. 可重用性：易于在不同项目中复用代码。

5.2 创建和使用模块

基本模块结构

模块通常是一个Lua文件，包含相关的函数和变量。例如，创建一个简单的数学模块 mymath.lua：

local mymath = {}
function mymath.add(a, b)
    return a + b
end
function mymath.subtract(a, b)
    return a - b
end
return mymath

使用模块

使用 require 函数来加载模块：

local mymath = require("mymath")
print(mymath.add(5, 3))  -- 输出: 8

5.3 require 函数

require 函数是加载模块的标准方式。它的工作原理如下：

1. 搜索模块（使用 package.path）
2. 如果找到，加载并执行模块代码
3. 缓存结果，避免重复加载

避免循环依赖

循环依赖可能导致问题。例如：

-- module1.lua
local module2 = require("module2")
-- module2.lua
local module1 = require("module1")  -- 这会导致问题

解决方法是重构代码或使用延迟加载。

5.4 包的概念和使用

包是模块的集合，通常组织在目录结构中。

创建包结构

例如，创建一个 myapp 包：

myapp/
    init.lua
    utils.lua
    config.lua

init.lua 文件是包的入口点：

-- myapp/init.lua
local myapp = {}
myapp.utils = require("myapp.utils")
myapp.config = require("myapp.config")
return myapp

使用包：

local myapp = require("myapp")
myapp.utils.someFunction()

5.5 模块的加载路径

Lua使用 package.path 和 package.cpath 来搜索模块。

修改搜索路径

package.path = package.path .. ";/path/to/your/modules/?.lua"

也可以使用环境变量 LUA_PATH 和 LUA_CPATH。

5.6 编写可重用的模块

设计模块 API

• 保持简单和一致性
• 提供清晰的文档
• 考虑错误处理

例如，改进我们的数学模块：

local mymath = {}
-- 加法函数
-- @param a 第一个数
-- @param b 第二个数
-- @return 两数之和
function mymath.add(a, b)
    assert(type(a) == "number" and type(b) == "number", "Both arguments must be numbers")
    return a + b
end
-- ... 其他函数 ...
return mymath

5.7 标准库模块介绍

Lua提供了几个有用的标准库模块：

• string: 字符串操作
• table: 表操作
• math: 数学函数
• io: 输入/输出操作
• os: 操作系统设施

例如，使用 string 模块：

local s = "hello world"
print(string.upper(s))  -- 输出: HELLO WORLD

5.8 实践项目：简单的日志系统

让我们创建一个简单的日志模块：

-- logger.lua
local logger = {}
local function formatMessage(level, message)
    return string.format("[%s] %s: %s", os.date("%Y-%m-%d %H:%M:%S"), level, message)
end
function logger.info(message)
    print(formatMessage("INFO", message))
end
function logger.error(message)
    print(formatMessage("ERROR", message))
end
return logger

使用这个日志模块：

local logger = require("logger")
logger.info("Application started")
logger.error("An error occurred")

练习

1. 创建一个配置模块，允许从文件加载配置并提供获取配置值的方法。
2. 扩展日志模块，添加日志级别和文件输出功能。
3. 创建一个简单的测试框架模块，提供断言和测试运行器功能。

通过本章的学习，你应该能够创建和使用模块，理解包的概念，并能够组织大型Lua项目。

模块化编程是构建可维护软件的关键，掌握这些概念将极大提高你的Lua编程技能。