解析Lua中的全局环境、包、模块组织结构

模块就是一个程序库,而包是一系列模块。Lua中可以通过require来加载模块,然后得到一个全局变量表示一个table。Lua将其所有的全局变量保存在一个被称为“环境”的常规table中。本文首先介绍环境的一些实用技术,然后介绍如何引用模块及编写模块的基本方法。

1. 环境
Lua将环境table保存在一个全局变量_G中,可以对其访问和设置。有时我们想操作一个全局变量,而它的名称却存储在另一个变量中,或者需要通过运行时的计算才能得到,可以通过value = _G[varname]来获得动态名字的全局变量。

关于“环境”的一大问题是它是全局的,任何对它的修改都会影响程序的所有部分。Lua 5允许每个函数拥有一个子集的环境来查找全局变量,可以通过setfenv来改变一个函数的环境,第一个参数若是1则表示当前函数,2则表示调用当前函数的函数(依次类推),第二个参数是一个新的环境table。

a = 1
setfenv(1, {})
print(a) -- 会报错,print是一个nil。这是因为一旦改变环境,所有的全局访问都会使用新的table

为了避免上述问题,可以使用setfenv(1, {_G = _G})将原来的环境保存起来,然后用_G.print来引用。另一种组装新环境的方法是使用继承,下面的代码新环境从源环境中继承了print和a,任何赋值都发生在新的table中。

a = 1
local newgt = {}
setmetatable(newgt, {__index = _G})
setfenv(1, newgt)
print(a)

2. 模块与包
2.1 调用模块

要调用模块mod中的foo方法,可以用require函数来加载,如:

require "mod"
mod.foo()
-- 或者
local m = require "mod"
m.foo()

require函数的行为: (关于require使用的路径查找策略不赘述)
在package.loaded这个table中检查模块是否已加载
=> 已加载,就返回相应的值(可见一个模块只会加载一次)
=> 未加载,就试着在package.preload中查询传入的模块名
===> 找到一个函数,就以该函数作为模块的加载器
===> 找不到,则尝试从Lua文件或C程序库中加载模块
=====> 找到Lua文件,通过loadfile来加载文件
=====> 找到C程序库,通过loadlib来加载文件

2.2 使用环境

下面的代码说明了如何用环境来创建一个复数(complex)模块:

-- 模块设置
local modname = "complex"
local M = {}
_G[modname] = M
package.loaded[modname] = M

-- 声明模块从外界所需的所有东西
local _G = _G -- 保留旧环境的引用,使用时需要像_G.print这样用
local io = io

-- 运行这句之后环境就变了
setfenv(1, M)

function new(r, i) return {r=r, i=i} end

function add(c1, c2)
  return new(c1.r + c2.r, c1.i + c2.i)
end

这样声明函数add时,就成为了complex.add,调用同一模块的其他函数也不需要加前缀。

2.3 module函数

Lua 5.1提供了一个新函数module,囊括了上面一系列定义环境的功能。在开始编写一个模块时,可以直接用module("modname", package.seeall)来取代前面的设置代码。在一个模块文件开头有这句调用后,后续所有代码都不需要限定模块名和外部名字,同样也不需要返回模块table了。

2.4 子模块与包

Lua支持具有层级的模块名,用一个点来分隔名称中的层级。例如一个模块名为mod.sub,就是mod的一个子模块。一个包(package)就是一个完整的模块树,它是Lua中发型的单位。注意,当搜索一个子模块文件时,require会把点号当做目录分隔符来搜索,也就是说调用require "a.b"会尝试打开./a/b.lua,/usr/local/lua/a/b.lua,/usr/local/lua/a/b/init.lua。通过这种加载策略,可以将包的所有模块组织到一个目录中。

2.5 以自定义方式加载 lua 模块
从 Lua 5.1 以后,Lua 有了标准的模块管理库。所以所有的模块加载都是通过 require 来完成。 require 的设计是颇具扩展性的,它会从若干个定义好的 loader 中逐个尝试加载新的模块。系统库中提供了四个 loader ,分别实现已加载模块,Lua 模块,和 C 扩展模块(用了两个 loader 来实现 C 扩展模块的加载)。这些 loader 以 CFunction 的形式放在 require 的环境中的一个 table 里。

如果我们想改变 lua 模块的加载形式,只需要替换或增加一个新的 loader 就可以了。

要做的只需要模仿 loadlib.c 中的 loader_Lua 函数做一个自己的实现,比如在我们的项目中,就允许从自定义格式数据包中,加载一个被加密过的 Lua 代码文件。然后写几行 C 代码,获得 require 的环境(使用 lua_getfenv ),然后取出其中 "loaders" 这个 table ,把新的自定义 loader 插入到 index 2 的地方。

具体的代码就不详述了,仔细阅读一下 ll_require 的实现(在 loadlib.c 中)就很容易明白。我们的整个工作从分析到实现没有超过两个小时,这真是得益于 Lua 良好的设计啊 :D 甚至如果你想从一个网络连接的数据流中加载 Lua 模块,或是通过 http/ftp 协议下载,也是行的通的吧。

(0)

相关推荐

  • Lua极简入门指南(六):模块

    从用户的角度来看,一个模块能够通过 require 加载并返回一个 table,模块导出的接口都被定义在此 table 中(此 table 被作为一个 namespace).所有的标准库都是模块.标准库被预先加载了,就像这样: 复制代码 代码如下: math = require 'math' string = require 'string' require 函数 使用 require 函数加载模块能够避免多次重复加载模块.加载一个模块: 复制代码 代码如下: require 'modulena

  • Lua的函数环境、包实例讲解

    复制代码 代码如下: function foo()    print(g or "No g defined!") end foo() setfenv(foo, { g = 100, print = print }) --设置foo的环境为表{ g=100, ...} foo() print(g or "No g defined!") --No g defined! --100 --No g defined! 定义:函数环境就是函数在执行时所见的全局变量的集合,以一个

  • Lua教程(十一):模块与包详解

    从Lua 5.1开始,我们可以使用require和module函数来获取和创建Lua中的模块.从使用者的角度来看,一个模块就是一个程序库,可以通过require来加载,之后便得到一个类型为table的全局变量.此时的table就像名字空间一样,可以访问其中的函数和常量,如: 复制代码 代码如下: require "mod" mod.foo() local m2 = require "mod2" local f = mod2.foo f() 1. require函数:

  • Lua模块和模块载入浅析

    在lua中,我们可以直接使用requeire("model_name")来载入别的文件,文件的后缀名是.lua,载入的时候直接执行那个文件了. 比如:my.lua 文件中 复制代码 代码如下: print("hello world!") 当我require("my")时,那么会直接输出hello world! 特别注意: 1.用require载入相同的文件时,只有第一次执行,以后都不执行. 2.如果你想让每次载入都执行文件,那么可以使用dofil

  • Lua中使用模块的一些基础知识

    --两个横线开始单行的注释,--[[加上两个[和]表示多行的注释--]]. 复制代码 代码如下: -- 假设文件mod.lua的内容是: local M = {} local function sayMyName()   print('Hrunkner') end function M.sayHello()   print('Why hello there')   sayMyName() end return M 复制代码 代码如下: -- 另一个文件也可以使用mod.lua的函数: local

  • Lua中的模块(module)和包(package)详解

    前言 从Lua5.1版本开始,就对模块和包添加了新的支持,可是使用require和module来定义和使用模块和包.require用于使用模块,module用于创建模块.简单的说,一个模块就是一个程序库,可以通过require来加载.然后便得到了一个全局变量,表示一个table.这个table就像是一个命名空间,其内容就是模块中导出的所有东西,比如函数和常量,一个符合规范的模块还应使require返回这个table.现在就来具体的总结一下require和module这两个函数. require函

  • 使用Lua编写Nginx服务器的认证模块的方法

    过去两天里,我解决了一个非常有趣的问题.我用一个nginx服务器作为代理,需要能够向其中添加一个认证层,使其能够使用外部的认证源(比如某个web应用)来进行验证,如果用户在外部认证源有账号,就可以在代理里认证通过. 需求一览 我考虑了几种解决方案,罗列如下: 用一个简单的Python/Flask模块来做代理和验证. 一个使用subrequests做验证的nginx模块(nginx目前可以做到这一点) 使用Lua编写一个nginxren认证模块 很显然,给整个系统添加额外请求将执行的不是很好,因为

  • Lua中的模块与module函数详解

    很快就要开始介绍Lua里的"面向对象"了,在此之前,我们先来了解一下Lua的模块. 1.编写一个简单的模块 Lua的模块是什么东西呢?通常我们可以理解为是一个table,这个table里有一些变量.一些函数- 等等,这不就是我们所熟悉的类吗? 没错,和类很像(实际上我说不出它们的区别).   我们来看看一个简单的模块,新建一个文件,命名为game.lua,代码如下: 复制代码 代码如下: game = {} function game.play()     print("那么

  • Lua调用自定义C模块

    这是<Lua程序设计>中提到的,但是想成功执行,对于初学Lua的确没那么简单.这里涉及如何如何生成一个动态链接库so文件:Lua5.2中导出函数从LuaL_register变成了LuaL_newlib.对于具体的细节有待深入.这里的模块名是hello_lib, Lua解释器会根据名字找到对应的模块,而后执行其中的 luaopen_XXX方法. 代码: #include <math.h> #include <lua5.2/lua.h> #include <lua5.

  • Lua模块与包学习笔记

    从 Lua 5.1 开始,Lua 加入了标准的模块管理机制,可以把一些公用的代码放在一个文件里,以API 接口的形式在其他地方调用,有利于代码的重用和降低代码耦合度. 创建模块 其实 Lua 的模块是由变量.函数等已知元素组成的 table,因此创建一个模块很简单,就是创建一个 table,然后把需要导出的常量.函数放入其中,最后返回这个 table 就行.格式如下: 复制代码 代码如下: -- 定义一个名为 module 的模块 module = {}   -- 定义一个常量 module.c

  • 在Lua中使用模块的基础教程

     什么是模块? 模块是一个像,可以使用需要加载并有包含表中的单个全局命名的库.该模块可包含若干函数和变量.所有这些函数和变量被包裹在以它作为一个命名空间的表.也是一个很乖的模块有必要的规定,返回此表上所需要的. Lua模块 表中的模块的使用可以帮助我们以多种方式,使我们能够操纵模块中我们操纵任何其他lua的表相同的方式.作为操纵模块的能力的结果,它提供了额外的功能的量等语言需要特殊的机制.由于lua模块,这个免费的方式下,用户可以调用Lua函数以多种方式.如下面几个: 复制代码 代码如下: --

随机推荐