13.lua学习笔记:模块与包

 从Lua 5.1开始,我们可以使用require和module函数来获取和创建Lua中的模块。从使用者的角度来看,一个模块就是一个程序库,可以通过require来加载,之后便得到一个类型为table的全局变量。此时的table就像名字空间一样,可以访问其中的函数和常量,如:

1 require "mod"
2 mod.foo()
3 local m2 = require "mod2"
4 local f = mod2.foo
5 f()   

    1. require函数:
    require函数的调用形式为require "模块名"。该调用会返回一个由模块函数组成的table,并且还会定义一个包含该table的全局变量。在使用Lua中的标准库时可以不用显示的调用require,因为Lua已经预先加载了他们。
    require函数在搜素加载模块时,有一套自定义的模式,如:
    ?;?.lua;c:/windows/?;/usr/local/lua/?/?.lua
    在上面的模式中,只有问号(?)和分号(;)是模式字符,分别表示require函数的参数(模块名)和模式间的分隔符。如:调用require "sql",将会打开以下的文件:
    sql
    sql.lua
    c:/windows/sql
    /usr/local/lua/sql/sql.lua
    Lua将require搜索的模式字符串放在变量package.path中。当Lua启动后,便以环境变量LUA_PATH的值来初始化这个变量。如果没有找到该环境变量,则使用一个编译时定义的默认路径来初始化。如果require无法找到与模块名相符的Lua文件,就会找C程序库。C程序库的搜索模式存放在变量package.cpath中。而这个变量则是通过环境变量LUA_CPATH来初始化的。
   
    2. 编写模块的基本方法:
    见如下代码和关键性注释:

复制代码
 1 --将模块名设置为require的参数,这样今后重命名模块时,只需重命名文件名即可。
 2 local modname = ...
 3 local M = {}
 4 _G[modname] = M
 5 
 6 M.i = {r = 0, i = 1}  --定义一个模块内的常量。
 7 function M.new(r,i) return {r = r, i = i} end
 8 function M.add(c1,c2) 
 9     return M.new(c1.r + c2.r,c1.i + c2.i)
10 end
11 
12 function M.sub(c1,c2)
13     return M.new(c1.r - c2.r,c1.i - c2.i)
14 end
15 --返回和模块对应的table。
16 return M
复制代码

  
    3. 使用环境:
    仔细阅读上例中的代码,我们可以发现一些细节上问题。比如模块内函数之间的调用仍然要保留模块名的限定符,如果是私有变量还需要加local关键字,同时不能加模块名限定符。如果需要将私有改为公有,或者反之,都需要一定的修改。那又该如何规避这些问题呢?我们可以通过Lua的函数“全局环境”来有效的解决这些问题。见如下修改的代码和关键性注释:

复制代码
 1 --模块设置和初始化。这一点和上例一致。
 2 local modname = ...
 3 local M = {}
 4 _G[modname] = M
 5 
 6 --声明这个模块将会用到的全局函数,因为在setfenv之后将无法再访问他们,
 7 --因此需要在设置之前先用本地变量获取。
 8 local sqrt = mat.sqrt
 9 local io = io
10 
11 --在这句话之后就不再需要外部访问了。
12 setfenv(1,M)
13 
14 --后面的函数和常量定义都无需模块限定符了。
15 i = {r = 0, i = 1}
16 function new(r,i) return {r = r, i = i} end
17 function add(c1,c2) 
18     return new(c1.r + c2.r,c1.i + c2.i)
19 end
20  
21 function sub(c1,c2)
22     return new(c1.r - c2.r,c1.i - c2.i)
23 end
24 --返回和模块对应的table。
25 return M
复制代码


    4. module函数:
    在Lua 5.1中,我们可以用module(...)函数来代替以下代码,如:

复制代码
1 local modname = ...
2 local M = {}
3 _G[modname] = M
4 package.loaded[modname] = M
5     --[[
6     和普通Lua程序块一样声明外部函数。
7     --]]
8 setfenv(1,M)
复制代码

    由于在默认情况下,module不提供外部访问,必须在调用它之前,为需要访问的外部函数或模块声明适当的局部变量。然后Lua提供了一种更为方便的实现方式,即在调用module函数时,多传入一个package.seeall的参数,如:
    module(...,package.seeall)

转自:http://www.cnblogs.com/stephen-liu74/archive/2012/07/04/2421283.html

备注:

以上是lua5.1版本的,lua5.2去掉了setfenv / getfenv / module函数,所以,除了第一种方法,其他在lua5.2中行不通;

 1 --模块设置和初始化。这一点和上例一致。
 2 local M = {}
 3 
 4 --声明这个模块将会用到的全局函数,因为在设置本地环境后将无法再访问他们,
 5 --因此需要在设置之前先用本地变量获取。
 6 local sqrt = mat.sqrt
 7 local io = io
 8 
 9 --设置环境,在这句话之后就不再需要外部访问了。
10 _ENV = M
11 
12 --设置环境后面的函数和常量定义都无需模块限定符了,不用定义时加local了,也不用顾虑会覆盖全局变量或者函数了。
13 i = {r = 0, i = 1}
14 function new(r,i) return {r = r, i = i} end
15 function add(c1,c2) 
16     return new(c1.r + c2.r,c1.i + c2.i)
17 end
18  
19 function sub(c1,c2)
20     return new(c1.r - c2.r,c1.i - c2.i)
21 end
22 --返回和模块对应的table。
23 return M

 
 
   
   
   
   
#_ENV是lua5.2新加的,用于替代_G,为了兼容旧程序,_ENV和_G一样
最简单的模块定义方法:
1 local function say()
2
print("Hello world")
3 end
4 return {say = say} --package.loaded[modname] = {say=say}


你可能感兴趣的:(lua,lua模块与包,module,package)