模块基础 #

-- mymodule.lua
local M = {}

M.version = "1.0"

function M.hello()
    print("Hello from module!")
end

return M

-- math_utils.lua
local M = {}

M.PI = 3.14159

function M.square(x)
    return x * x
end

function M.cube(x)
    return x * x * x
end

function M.distance(x1, y1, x2, y2)
    local dx = x2 - x1
    local dy = y2 - y1
    return math.sqrt(dx * dx + dy * dy)
end

return M

-- counter.lua
local M = {}

-- 私有变量
local count = 0

-- 私有函数
local function validate(n)
    return type(n) == "number" and n >= 0
end

-- 公共接口
function M.increment(n)
    n = n or 1
    if validate(n) then
        count = count + n
    end
end

function M.get()
    return count
end

function M.reset()
    count = 0
end

return M

-- 方式1：返回表（推荐）
local M = {}
function M.func() end
return M

-- 方式2：直接返回
return {
    func = function() end
}

-- 方式3：使用 module 函数（已弃用）
-- module("mymodule", package.seeall)

-- 加载模块
local math_utils = require("math_utils")

-- 使用模块
print(math_utils.PI)
print(math_utils.square(5))
print(math_utils.distance(0, 0, 3, 4))

-- require 的执行过程：
-- 1. 检查 package.loaded 表，如果已加载则返回缓存
-- 2. 搜索模块文件
-- 3. 编译并执行模块代码
-- 4. 将返回值存入 package.loaded
-- 5. 返回模块

-- 查看已加载的模块
for name, module in pairs(package.loaded) do
    print(name, module)
end

-- 查看搜索路径
print(package.path)   -- Lua 模块路径
print(package.cpath)  -- C 模块路径

-- 修改搜索路径
package.path = package.path .. ";./my_modules/?.lua"

-- 查看搜索器列表
for i, searcher in ipairs(package.searchers) do
    print(i, searcher)
end

-- 搜索器执行顺序：
-- 1. package.preload 预加载表
-- 2. Lua 模块搜索器
-- 3. C 模块搜索器
-- 4. C 根模块搜索器

-- package.path 中的占位符
-- ?  表示模块名
-- ;  分隔多个路径

-- 示例路径
-- ./?.lua
-- /usr/local/share/lua/5.4/?.lua
-- /usr/local/share/lua/5.4/?/init.lua

-- 加载 foo.bar 模块
-- 会搜索：./foo/bar.lua
local foo_bar = require("foo.bar")

-- 方法1：修改 package.path
package.path = "./lib/?.lua;./src/?.lua;" .. package.path

-- 方法2：设置环境变量
-- LUA_PATH="./lib/?.lua;;"
-- LUA_CPATH="./lib/?.so;;"

-- 方法3：在代码中设置
local function add_path(path)
    package.path = path .. "/?.lua;" .. package.path
    package.path = path .. "/?/init.lua;" .. package.path
end

-- singleton.lua
local Singleton = {}

local instance = nil

function Singleton.get_instance()
    if not instance then
        instance = {
            value = 0,
            increment = function(self)
                self.value = self.value + 1
            end
        }
    end
    return instance
end

return Singleton

-- person.lua
local Person = {}
Person.__index = Person

function Person.new(name, age)
    return setmetatable({
        name = name,
        age = age
    }, self)
end

function Person:greet()
    print("Hello, I'm " .. self.name)
end

function Person:get_age()
    return self.age
end

return Person

-- myapp.lua
local MyApp = {}

MyApp.version = "1.0"

-- 子模块
MyApp.utils = require("myapp.utils")
MyApp.config = require("myapp.config")
MyApp.models = require("myapp.models")

return MyApp

-- 清除模块缓存
package.loaded["mymodule"] = nil

-- 重新加载
local mymodule = require("mymodule")

local function reload_module(name)
    package.loaded[name] = nil
    return require(name)
end

-- 开发时使用
local mymodule = reload_module("mymodule")

myproject/
├── main.lua
└── lib/
    ├── myapp/
    │   ├── init.lua      -- myapp 模块入口
    │   ├── utils.lua     -- myapp.utils
    │   ├── config.lua    -- myapp.config
    │   └── models/
    │       ├── init.lua  -- myapp.models
    │       └── user.lua  -- myapp.models.user
    └── thirdparty/
        └── json.lua

-- lib/myapp/init.lua
local M = {}

M.utils = require("myapp.utils")
M.config = require("myapp.config")
M.models = require("myapp.models")

M.version = "1.0"

return M

-- 使用
local myapp = require("myapp")
myapp.utils.helper()

-- 使用小写字母和点分隔
-- myapp.utils.string
-- myapp.models.user

-- 避免使用下划线
-- myapp_utils_string（不推荐）

--[[
    模块名：math_utils
    描述：数学工具函数
    版本：1.0.0
    作者：Your Name
    
    用法：
        local math_utils = require("math_utils")
        print(math_utils.square(5))
]]

local M = {}

M.version = "1.0.0"

return M

local M = {}

function M.divide(a, b)
    if b == 0 then
        return nil, "除数不能为零"
    end
    return a / b
end

-- 使用
local result, err = M.divide(10, 0)
if not result then
    print("错误：" .. err)
end