Lua模块与包学习笔记

 更新时间:2014年12月10日 11:15:36   投稿:junjie  
这篇文章主要介绍了Lua模块与包学习笔记,本文讲解了加载模块、加载机制等内容,需要的朋友可以参考下

从 Lua 5.1 开始,Lua 加入了标准的模块管理机制,可以把一些公用的代码放在一个文件里,以API 接口的形式在其他地方调用,有利于代码的重用和降低代码耦合度。

创建模块

其实 Lua 的模块是由变量、函数等已知元素组成的 table,因此创建一个模块很简单,就是创建一个 table,然后把需要导出的常量、函数放入其中,最后返回这个 table 就行。格式如下:

复制代码 代码如下:

-- 定义一个名为 module 的模块
module = {}
 
-- 定义一个常量
module.constant = "this is a constant"
 
-- 定义一个函数
function module.func1()
    io.write("this is a public function!\n")
end
 
local function func2()
    print("this is a private function!")
end
 
function module.func3()
    func2()
end
 
return module

由上可知,模块的结构就是一个 table 的结构,因此可以像操作调用 table 里的元素那样来操作调用模块里的常量或函数。不过上面的 func2 声明为程序块的局部变量,即表示一个私有函数,因此是不能从外部访问模块里的这个私有函数,必须通过模块里的共有函数来调用。

最后,把上面的模块代码保存为跟模块名一样的 lua 文件里(例如上面是 module.lua),那么一个自定义的模块就创建成功。

加载模块

Lua 提供一个名为 require 的函数来加载模块,使用也很简单,它只有一个参数,这个参数就是要指定加载的模块名,例如:

复制代码 代码如下:

require("<模块名>")
-- 或者是
-- require "<模块名>"

然后会返回一个由模块常量或函数组成的 table,并且还会定义一个包含该 table 的全局变量。

或者给加载的模块定义一个别名变量,方便调用:

复制代码 代码如下:

local m = require("module")
 
print(m.constant)
 
m.func3()

加载机制

对于自定义的模块,模块文件不是放在哪个文件目录都行,函数 require 有它自己的文件路径加载策略,它会尝试从 Lua 文件或 C 程序库中加载模块。

require 用于搜索 Lua 文件的路径是存放在全局变量 package.path 中,当 Lua 启动后,会以环境变量 LUA_PATH 的值来初始这个环境变量。如果没有找到该环境变量,则使用一个编译时定义的默认路径来初始化。

当然,如果没有 LUA_PATH 这个环境变量,也可以自定义设置,在当前用户根目录下打开 .profile 文件(没有则创建,打开 .bashrc 文件也可以),例如把 "~/lua/" 路径加入 LUA_PATH 环境变量里:

复制代码 代码如下:

#LUA_PATH
export LUA_PATH="~/lua/?.lua;;"

文件路径以 ";" 号分隔,最后的 2 个 ";;" 表示新加的路径后面加上原来的默认路径。

接着,更新环境变量参数,使之立即生效:

复制代码 代码如下:

source ~/.profile

这时假设 package.path 的值是:

复制代码 代码如下:

/Users/dengjoe/lua/?.lua;./?.lua;/usr/local/share/lua/5.1/?.lua;/usr/local/share/lua/5.1/?/init.lua;/usr/local/lib/lua/5.1/?.lua;/usr/local/lib/lua/5.1/?/init.lua

那么调用 require("module") 时就会尝试打开以下文件目录去搜索目标

复制代码 代码如下:

/Users/dengjoe/lua/module.lua;
./module.lua
/usr/local/share/lua/5.1/module.lua
/usr/local/share/lua/5.1/module/init.lua
/usr/local/lib/lua/5.1/module.lua
/usr/local/lib/lua/5.1/module/init.lua

如果找过目标文件,则会调用 package.loadfile 来加载模块。否则,就会去找 C 程序库。搜索的文件路径是从全局变量 package.cpath 获取,而这个变量则是通过环境变量 LUA_CPATH 来初始。搜索的策略跟上面的一样,只不过现在换成搜索的是 so 或 dll 类型的文件。如果找得到,那么 require 就会通过 package.loadlib 来加载它。

相关文章

  • Lua教程(四):函数详解

    Lua教程(四):函数详解

    这篇文章主要介绍了Lua教程(四):函数详解,本文讲解了多重返回值、变长参数、具名实参、闭合函数、匿名函数、非全局函数等内容,需要的朋友可以参考下
    2015-04-04
  • Lua教程(三):值与类型介绍

    Lua教程(三):值与类型介绍

    这篇文章主要介绍了Lua教程(三):值与类型介绍,本文起讲解了Lua的八种基本类型、userdata、thread、table等内容,需要的朋友可以参考下
    2015-03-03
  • Lua中的函数相关知识点整理汇总

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

    这篇文章主要介绍了Lua中的函数相关知识点整理汇总,包括函数的参数传递和定义函数等基本知识,需要的朋友可以参考下
    2015-05-05
  • Lua中if语句嵌套的使用教程

    Lua中if语句嵌套的使用教程

    这篇文章主要介绍了Lua中if语句嵌套的使用教程,是Lua入门学习中的基础知识,需要的朋友可以参考下
    2015-05-05
  • Lua之字符串格式化例子和常用格式化参数介绍

    Lua之字符串格式化例子和常用格式化参数介绍

    这篇文章主要介绍了Lua之字符串格式化例子和常用格式化参数介绍,本文着重讲解了格式化参数的作用,需要的朋友可以参考下
    2015-04-04
  • Lua中让回调函数支持回调对象方法的解决方法

    Lua中让回调函数支持回调对象方法的解决方法

    这篇文章主要介绍了Lua中让回调支持对象方法,一般情况下,Lua中只支持回调一个函数,本文方法实现可以回调一个对象的方法,需要的朋友可以参考下
    2014-12-12
  • Lua中模块以及实现方法指南

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

    从Lua 5.1开始,我们可以使用require和module函数来获取和创建Lua中的模块。从使用者的角度来看,一个模块就是一个程序库,可以通过require来加载,之后便得到一个类型为table的全局变量。
    2015-04-04
  • Lua中的基本语法、控制语句总结

    Lua中的基本语法、控制语句总结

    这篇文章主要介绍了Lua中的基本语法、控制语句总结,本文总结了赋值、局部变量与块、控制结构、数字型for、泛型for等内容,需要的朋友可以参考下
    2014-09-09
  • lua开发中实现MVC框架的简单应用

    lua开发中实现MVC框架的简单应用

    最近的游戏项目中使用了lua脚本来开发,项目中用到了MVC框架,最近有朋友问我怎么弄,在这里简单分享一下思路和一些开发中的技巧。有需要的小伙伴可以参考下。
    2015-04-04
  • 实现Lua中数据类型的源码分享

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

    在Lua中有8种基础类型,像其他动态语言一样,在语言中没有类型定义的语法,每个值都携带了它自身的类型信息。下面我们就来尝试通过Lua 5.2.1的源码来看类型的实现
    2015-04-04

最新评论