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

从使用的角度来看,一个模块就是一个程序库,可以通过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有所帮助。

以上是小编为您精心准备的的内容,在的博客、问答、公众号、人物、课程等栏目也有的相关内容,欢迎继续使用右上角搜索按钮进行搜索lua模块
, lua编程指南
, lua模块化
lua模块实现
lua游戏开发实践指南、lua编程指南、lua编程指南 pdf、lua游戏编程实践指南、lua实践指南,以便于您获取更多的相关知识。

时间: 2024-11-03 21:02:19

Lua中模块以及实现方法指南_Lua的相关文章

Lua中类的实现原理探讨(Lua中实现类的方法)_Lua

Lua中没有类的概念,但我们可以利用Lua本身的语言特性来实现类. 下文将详细的解释在Lua中实现类的原理,涉及到的细节点将拆分出来讲,相信对Lua中实现类的理解有困难的同学将会释疑. 类是什么? 想要实现类,就要知道类到底是什么. 在我看来,类,就是一个自己定义的变量类型.它约定了一些它的属性和方法,是属性和方法的一个集合. 所有的方法都需要一个名字,即使是匿名函数实际上也有个名字.这就形成了方法名和方法函数的键值映射关系,即方法名为键,映射的值为方法函数. 比如说有一个类是人,人有一个说话的

Lua中的__index和__newindex实例_Lua

前言 这篇博文将通过几个简单的实例演示,巩固对__index和__newindex的理解,同时加深对Lua中元表和元方法的理解,如果对Lua的元表和元方法还不是很熟悉的话,请参考这篇文章:<Lua中的元表与元方法>. 具有默认值的table 我们都知道,table中的任何字段的默认值都是nil,但是通过元表,我们可以很容易的修改这一规定,代码如下: 复制代码 代码如下: function setDefault(tb, defaultValue)      local mt = {__index

Lua中的面向对象编程详解_Lua

简单说说Lua中的面向对象 Lua中的table就是一种对象,看以下一段简单的代码: 复制代码 代码如下: local tb1 = {a = 1, b = 2} local tb2 = {a = 1, b = 2} local tb3 = tb1   if tb1 == tb2 then      print("tb1 == tb2") else      print("tb1 ~= tb2") end   tb3.a = 3 print(tb1.a) 上述代码会输

Lua中table的遍历详解_Lua

当我在工作中使用lua进行开发时,发现在lua中有4种方式遍历一个table,当然,从本质上来说其实都一样,只是形式不同,这四种方式分别是: 复制代码 代码如下: for key, value in pairs(tbtest) do      XXX  end   for key, value in ipairs(tbtest) do      XXX  end   for i=1, #(tbtest) do      XXX  end   for i=1, table.maxn(tbtest)

Lua中的函数相关知识点整理汇总_Lua

 函数是一组一起执行任务的语句.可以把代码放到独立的函数中.怎么划分代码功能之间的不同,但在逻辑上划分通常是让每个函数执行特定的任务. Lua语言提供了程序可以调用大量的内置方法.例如,方法print()打印作为输入传参数在控制台中. 函数是已知的各种名称,如方法或子程序或程序等.定义一个函数 在Lua编程语言中的方法的定义一般形式如下: 复制代码 代码如下: optional_function_scope function function_name( argument1, argument2

Lua中table的一些辅助函数介绍_Lua

table库是有一些辅助函数构成的,这些函数将table作为数组来操作.其中,有对列表中插入和删除元素的函数,有对数组元素进行排序的函数,还有对链接一个数组中所有字符串的函数. 0.table.getn()Lua 中我们经常假定 array 在最后一个非 nil 元素处结束. 这个传统的约定有一个弊端:我们的 array中不能拥有 nil 元素.对大部分应用来说这个限制不是什么问题,比如当所有的 array 有固定的类型的时候.但有些时候我们的 array 需要拥有 nil 元素,这种情况下,我

Lua中的函数精讲笔记_Lua

函数的用途: 1.完成指定的任务,这种情况下作为调用语句使用. 2.计算并返回值,这种情况下,函数作为赋值语句的表达式使用. 函数的参数为空,必须使用()表示函数调用.例外:当函数只有一个参数,并且这个参数是字符串或表构造时,()是可选的. lua提供了面向对象调用函数的语法 o:foo(x)与o.f(o,x)是等价的. lua函数的实参与形参的匹配与赋值语句类似,多余部分被忽略,缺少部分nil补足. lua函数可以返回多个值,return后列出要返回值的列表即可返回多值 复制代码 代码如下:

实现Lua中数据类型的源码分享_Lua

概述     在Lua中有8种基础类型:nil.boolean.number.string.userdata.function.thread和table.可以使用函数type查看某个变量或值的类型,返回相应的类型名称.像其他动态语言一样,在语言中没有类型定义的语法,每个值都携带了它自身的类型信息.下面将通过Lua 5.2.1的源码来看类型的实现.    源码实现      Lua将值表示成带标志的联合结构,代码如下(lobject.h): 90 /* 91 ** Union of all Lua

Lua中的源代码预编译浅析_Lua

尽管Lua被称为是一种解释型的语言,但Lua确实允许在运行源代码之前,将源代码预编译成一种中间形式(类比Python的.pyc).区别解释型语言的主要特征在于编译器是否是语言运行时库的一部分,即是否有能力执行动态生成的代码(Lua可以通过dofile执行Lua代码).  其实,dofile的核心功能是由loadfile完成的,可以这样来定义dofile: loadfile并不是执行代码,而只是编译,返回一个函数,由dofile执行. 如果多次运行一个文件,可以只调用一次loadfile,重复调用