Lua

关注公众号 jb51net

关闭
首页 > 脚本专栏 > Lua > Lua中模块以及实现方法指南

Lua中模块以及实现方法指南

投稿:hebedich

从Lua 5.1开始,我们可以使用require和module函数来获取和创建Lua中的模块。从使用者的角度来看,一个模块就是一个程序库,可以通过require来加载,之后便得到一个类型为table的全局变量。

从使用的角度来看,一个模块就是一个程序库,可以通过Lua自身提供的require来加载。然后便得到一个全局变量,表示一个table。这个table就是像一个名字空间,其内容就是模块导出的所有东西,例如函数和常量。简单的说,Lua中的模块就是一个table,table中可以包括任何东西。本文首先详细介绍模块相关的require函数,包括该函数的执行流程以及查找模块的路径,然后介绍了实现模块的三种方法,并给出相应的优缺点。

 require函数

     该函数用来加载一个模块,即按指定的路径和传入的参数,查找要加载的模块。函数原型如下:

      require (modname)

      该函数的执行流程如下:

      I、查找表package.loaded,看modname是否已经加载过了。若是,则require函数直接返回package.loaded[modname],否则继续执行,寻找模块的加载器(loader)。

      II、为了寻找加载器,require使用了数组package.searchers(Lua 5.2引入的,在之前的版本叫做package.loaders,实质两者只是名字不同而已),数组中每个元素是一个函数。

     第一个函数用来是搜索表package.preload,若存在,则返回相应的加载器。

     第二个函数是用来获取Lua模块的加载器,其搜索路径存储在package.path中,它是一个字符串,比如:

复制代码 代码如下:

/usr/local/share/lua/5.2/?.lua;/usr/local/share/lua/5.2/?/init.lua;/usr/local/lib/lua/5.2/?.lua;/usr/local/lib/lua/5.2/?/init.lua;./?.lua 

会用模块名来替换每个”?”,然后根据替换的结果来检测是否存在这样的一个文件。这个工作是通过函数package.searchpath来做的。package.searchpath函数原型如下:
      package.searchpath (name, path [, sep [, rep]])

参数path是要查找的字符串,用分号隔开;name是要查找的文件;参数sep(默认值是”.”)可用于name中,在查找过程中用rep(默认值是系统目录的分隔符)替换。比如path是

复制代码 代码如下:

"./?.lua;./?.lc;/usr/local/?/init.lua"

要查找foo.a,则会尝试查找文件

复制代码 代码如下:

./foo/a.lua, ./foo/a.lc, 和/usr/local/foo/a/init.lua 

也就是说Lua支持具有层级性的模块名。
      第三个函数是用来获取C模块的加载器,其搜索路径存储在package.cpath中,它也是一个字符串,比如:

复制代码 代码如下:

/usr/local/lib/lua/5.2/?.so;/usr/local/lib/lua/5.2/loadall.so;./?.so 

同样会用模块名来替换每个”?”,然后根据替换的结果来检测是否存在这样的一个文件。这个工作也是通过函数package.searchpath来做的。
     第四个函数是用all-in-one 加载器,使用这个功能,可以使得一个包里面包含多个C子模块。除了第一个外,其他三个除了返回加载器外,还会返回找到的文件名作为额外的值。

      III、找到加载器后,require将用两个参数调用这个加载器,一个是传入的参数modname,另外一个是返回的额外值。如加载器返回一个不是nil的值,则把这个值赋值给package.loaded[modname]。如果加载返回返回一个nil并且加载器执行完后package.loaded[modname]还为空,则把package.loaded[modname]赋值为true。不管那种情况,require都会返回package.loaded[modname]。如果在这个过程有任务错误,require函数就产生一个错误给调用者。

     最后关于require函数,值得注意的几点是:

     I、如果require找到的是一个lua文件,则通过loadfile来加载代码,如果找到的是一个C程序库,就通过loadlib来加载。注意,loadfile和loadlib都实质上加载代码,并没有运行他们。为了运行他们,require会用模块名作为参数来调用这些代码。

     II、若要强制使require对同一库加载两次,可以简单删除package.loaded中的模块条目,即赋值相应的条目为nil。

     III、通过上面的加载过程分析知道,要加载自己的lua文件或C库,可以通过修改package.path或package.cpath的值,把要搜索的路径加载进去。

      IV、也可以定义自己的加载函数(除了已有的loadlib和loadfile等),比如加载ZIP文件,甚至从web上下载一个文件。

编写模块的方法

     方法一:对于Lua5.0和5.1来说,编写模块最简单的方法是使用Lua自身提供的module函数(注意在Lua 5.2中被删除了),比如要编写一个模块foo,模块文件foo_file.lua如下:

复制代码 代码如下:

module("foo", package.seeall) 
function test() 
end 

则在其他文件要使用这个模块,方式如下:

复制代码 代码如下:

require(“foo_file.lua”) 
foo.test() 

并且执行require后,则会把模块foo就是全局环境的一个变量了,在其他地方也可以使用。module函数原型如下:

复制代码 代码如下:

module (name [, ···]) 

module在创建模块table之前,会先检查package.loaded是否已包括了这个模块,或者是否已存在与模块同名的变量。如果由此找到了这个table,它就会复用这个table做为模块。也就是说,可以用module来打开一个已创建的模块。

对于module函数来说,有以下问题,比如在模块文件module0_test中有:

复制代码 代码如下:

module("mymodule", package.seeall)                                                                      
function foo() 
    print("Hello World!") 
end 

在另外一个文件可以这样使用这个模块:

复制代码 代码如下:

require "module0_test" 
mymodule.foo()             --Hello World! 
mymodule.print("example")  --example 

对于第二个调用不是报错的,并且是非常奇怪的,这时因为module机制是在模块中找不的成员,则去_G全局变量找,实现方式类似如下:

do 
  local globaltbl = _G 
  local newenv = setmetatable({}, { 
    __index = function (t, k) 
      local v = t[k] 
      if v == nil then return globaltbl[k] end 
      return v 
    end, 
    __newindex = M, 
  }) 
  if setfenv then 
    setfenv(1, newenv) -- for 5.1 
  else 
    _ENV = newenv -- for 5.2 
  end 
end 

在模块找不到的成员,则到_G中去查找,并且这样访问也是非常低效的,因为要通过元表来访问成员。

 方法二:该方法的基本思想是让模块的主程序有一个独占的环境,这样所有函数或变量都共享这个table,并且所有的全局变量都记录在这个table中,当然局部变量是不会的。代码片段如下:

local modename = ... 
local M = {} 
_G[modename] = M 
package.loaded[modname] = M 
if setfenv then 
  setfenv(1, newenv) -- for 5.1 
else 
  _ENV = newenv -- for 5.2 
end 

如果这样实现,在模块访问_G中的变量时,需要加上前缀,比如_G.print。为了解决这个问题,有几种方法,各有优缺点:

 I、设置M的元表,即setmetable(M, {__index = _G})这样做后,访问全局变量,都要通过元表,开销比较大。

 II、设置local _G = _G,这样做后,访问全局变量仍然要加上前缀,但速度更快。

 III、把模块需要的全局变量都设置为局部变量,比如local io = io。这样做会比较繁琐,但是速度最快。

方法三:同样是使用环境的概念。比如模块文件如下:

复制代码 代码如下:

function foo()                                                                                          
    print("Hello World!")                                                                               
end 

为了使用它,方法如下:

local function Import(filename)                                     
  f = loadfile(filename)                                        
  local M = {}                                             
  setmetatable(M, {__index = _G})                                   
  setfenv(f,M)() 
  return M 
end 
 
local FOO = Import("module2_test.lua") 
 
FOO.foo() --output “Hello World!” 

用这种方法,只需调用Import方法,其返回值就是模块,该方法把模块相关访问工作,放在使用的模块的地方了。

以上所述就是本文的全部内容了,希望能够对大家学习lua有所帮助。

您可能感兴趣的文章:
阅读全文