Lua模块与require机制的理解

1. 什么是模块

对于用户来说，模块就是一个程序库，可以通过require来加载，然后就得到了一个全局变量，表示一个table。这个table就像一个命名空间，它的内容就是模块中导出的所有东西，如函数和常量。

2. Lua模块的优点

使用table来实现模块，那么我们在使用模块的时候也就可以像使用table那样。

3. Lua模块的使用

require "mod"
mod.foo()

local m =require "mod"
m.foo()

4. require函数

4.1 require函数原型

我们先来看一下require的原型，它会先检测该模块是否加载，如果是就返回相应的值，所以这意味着，如果一个模块已经加载过了，后续的require调用都将返回同一个值，不会再次加载它。下面代码中，讲模块标记为已加载是为了避免重复嵌套加载。因为如果一个模块要求加载另一个模块，后者又递归的加载前者，这就会进行无限循环。

image

4.2 加载器的加载顺序

它会先在table package.preload中查询传入的模块名，如果找不到指定条目，就会尝试从Lua文件或C程序库中加载模块。它们有不同的加载函数，但是这些加载函数都仅仅是加载它们，并没有运行它们。所以后面我们用require传入模块名作为参数来调用这些代码，如果加载器有返回值，我们就讲它存储在table package.loaded里，方便下一次使用模块时直接调用。

image

4.3 require的搜索路径

require搜索路径中的？会被模块名替换。它用于搜索Lua文件的路径存放在变量package.path中

5. module机制

5.1 mouble机制的优点

它将我们的模块表加入到全局变量中，那么模块的主程序块就有一个独占的环境，这样访问同一模块的其他公共实体时，不需要限定它名称。

5.2 mouble机制的使用

module “mymodule” 

上面的代码等于下面的语句

local modname = “mymodule”     -– 定义模块名  
local M = {}                               -- 定义用于返回的模块表  
_G[modname] = M                      -- 将模块表加入到全局变量中  
package.loaded[modname] = M    -- 将模块表加入到package.loaded中，防止多次加载  
setfenv(1,M)  -- 将模块表设置为函数的环境表，这使得模块中的所有操作是以在模块表中的，这样定义函数就直接定义在模块表中  

上面的代码会出现一个问题，就是当创建了一个空tableM作为环境后，就无法访问前一个环境中的全局变量了，因为module指令运行完后，整个环境被压栈，所以前面全局东西再也看不见了。我们可以采用几种不同的方式来重获访问

• 方式1 ：使用setmetatable，模块就可以直接访问任何全局标识

local modname = “mymodule”     -– 定义模块名  
local M = {}                               -- 定义用于返回的模块表  
_G[modname] = M                      -- 将模块表加入到全局变量中  
package.loaded[modname] = M    -- 将模块表加入到package.loaded中，防止多次加载
setmetatable(M,{__index = _G})  
setfenv(1,M)  -- 将模块表设置为函数的环境表，这使得模块中的所有操作是以在模块表中的，这样定义函数就直接定义在模块表中

• 方式2：声明一个局部变量来保存对旧环境的访问，这样所有全局变量的名称前都需要加上"_G"

  image

6. 子模块与包

当要加载有层级性的模块名，可以用一个点来分隔名称中的层级。当搜索一个子模块的时候，require会将点转换成目录分隔符。一个模块名为mod.sub，那么它就是mod的一个子模块，是一个存储在table mod中且key为sub的table。
包其实就是一个完整的模块树

image

转载于：https://www.jianshu.com/p/d727825816ee