Lua基础之模块与require

模块

Lua可以利用table实现模块加载

方法：

1. 从require传入的参数中获取模块名或直接自定义变量名；
2. 初始化一个空table；
3. 在全局环境_G中添加模块名对应的字段，将空table赋值给这个字段；
4. 在package.loaded中设置该模块；
5. 设置环境变量。

例如：

local moduleName = ...     -- 模块名，可以在这里直接指定
 
local M = {}               -- 初始化table
_G[moduleName] = M         -- 将这个局部变量最终赋值给模块名
package.loaded[moduleName] = M    -- 赋值给已经加载的table
 
setmetatable(M, {__index = _G})   
--[[
元表会有一定的性能开销，也可以用local _G = _G保存全局的环境变量

或者将需要用到的库先赋值
local math= math            -- 在我们自己的模块中需要用到math库，所以就先保存下来
local io = io               -- 需要用到io库，也保存下来
--]]

setfenv(1, M)               -- 设置环境变量

 

利用module函数实现模块加载

Lua5.1提供了module函数，直接利用该函数就可以实现模块加载

module(name, cb1, cb2, ...)

module运行时：

     1. 如果package.loaded[name]是一个table，那么就把这个table作为一个module返回 

     2. 如果全局变量name是一个table，就把这个全局变量作为一个module返回

     3. 创建一个新的table： 

t = 
{
    [name]=package.loaded[name],
    ["_NAME"]=name,
    ["_M"]=t,
    ["_PACKAGE"]=*name*  -- 删除了最后的".XXXX"部分
}

-- 例如
"hello.world"
t =
{
    ["hello"]=
    {
        ["world"]=
            {XXXXXXX}
    }
}

     4. 依次调用cbs：cb1(mod), cb2(mod),...将当前模块的环境设置为module，同时把package.loaded[name] = module

 

module 指令运行完后，整个环境被压栈，所以前面全局的东西无法访问，这种情况可以这样解决的：

    a. 使用module(..., package.seeall)加载模块，这句话的功能就好比之前的功能再加上了setmetatable(M, {__index = _G})
    b. 在module前local _G=_G
    c. 将需要用到的库先赋值 如：local print= print

 

require

require的加载路径

?;?.lua;c:\windows\?;/usr/local/lua/?/?.lua

搜索一个文件时，在windows上，很多都是根据windows的环境变量path来搜索，而require所使用的路径与传统的路径不同，require采用的路径是一连串的模式，其中每项都是一种将模块名转换为文件名的方式。require会用模块名来替换每个“？”，然后根据替换的结果来检查是否存在这样一个文件，如果不存在，就会尝试下一项。
假如尝试搜索Test.lua时，require就会依次搜索下面的路径，直至搜索到该lua文件，

Test
Test.lua
c:\windows\Test
/usr/local/lua/mod/Test.lua

 

require加载过程

用法：

require(name)

加载顺序：

       1. 首先在package.loaded查找name，如果该模块已经存在，就直接返回它的值；

       2. 在package.preload查找name, 如果preload存在，那么就把它作为loader，调用loader(L)；

       3. 根据package.path的模式查找lua库name，这个库是通过module函数定义的，对于顶层的lua库，文件名和库名是一样的而且不需要调用显式地在lua文件中调用module函数，也就是说lua会根据lua文件直接完成一个loader的初始化过程；

       4. 根据package.cpath查找c库，这个库是符合lua的一些规范的(export具有一定特征的函数接口)，lua先已动态的方式加载该c库，然后在库中查找并调用相应名字的接口，例如:luaopen_hello_world；

       5. 以第一个"."为分割，将模块名划分为：(main, sub)的形式，根据package.cpath查找main，如果存在，就加载该库并查询相应的接口:luaopen_main_sub，例如：先查找hello库，并查询luaopen_hello_world接口

       6. 得到loader后，用name作为唯一的参数调用该loader函数。当然参数是通过lua的栈传递的，所以loader的原型必须符合lua的规范：int LUA_FUNC(lua_State *L)。

       如果找到的是一个C程序库，就通过loadlib来加载。loadfile和loadlib都只是加载了代码，并没有运行它们，为了运行代码，require会以模块名作为参数来调用这些代码

       require会将这个loader的返回值赋给package.loaded[modelname]，如果loader不返回值同时package.loaded[modelname]不存在时，require就会把package.loaded[modelname]设为true。最后reuqire把package.loaded[modelname]返回给调用者。

 

注：

package.path：保存加载外部模块的搜索路径，用于搜索自己写的库文件或者第三方的库文件

package.cpath：作用和packag.path一样,但它是用于加载第三方c库的。初始值可以通过环境变量LUA_CPATH来设置，用于搜索自己写的so库文件或者第三方的so库文件

 

参考链接：

https://blog.codingnow.com/2006/02/lua_51_module.html

https://www.jb51.net/article/55818.htm

https://www.cnblogs.com/yyxt/p/3870236.html

https://blog.csdn.net/xiejunna/article/details/72874981