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调用都将返回同一个值,不会再次加载它。下面代码中,讲模块标记为已加载是为了避免重复嵌套加载。因为如果一个模块要求加载另一个模块,后者又递归的加载前者,这就会进行无限循环。

require原型

4.2 加载器的加载顺序

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

require顺序
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"


    局部变量local

6. 子模块与包

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


查找
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,298评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,701评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,078评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,687评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,018评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,410评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,729评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,412评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,124评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,379评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,903评论 1 257
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,268评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,894评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,014评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,770评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,435评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,312评论 2 260

推荐阅读更多精彩内容