牛叔的lua研究报告——dofile和require

niubo_
2010-07-07 08:42:43

在lua中写个试验性质的小程序可能只要一个脚本文件就搞定了，不过一旦程序上了一定规模，为了方便阅读和维护，分开多个文件就很有必要了。那么如何才能在一个lua脚本文件中调用另一个文件呢？这个就是今天的研究课题。
首先出场的就是dofile。我们知道一个lua文件是作为一个代码块（chunk）存在的，其实质就是一个函数，那么最简单的，我在一个外部lua文件中写一段代码，然后在主lua文件中用dofile调用，外部文件的代码块就会执行了。[code]
--outter.lua:
print("Hello world!")
--main.lua:
dofile("outer.lua")
[/code]那么执行结果显然就是输出“Hello world!”。
当然有时候我们不想立即执行外部文件，而是想从外部文件中引入一个函数，在某个合适的时候执行。那么可以在外部文件中定义一个函数并返回，然后执行。[code]
--outter.lua:
function sayHello()
print("Hello world!")
end
return sayHello
--main.lua:
func = dofile("outter.lua")
func()
[/code]于是，显然的也输出了想要的内容。啊，不过这样代码也太丑了，实话说这里用dofile纯粹多此一举。完全可以用loadfile改造一下。返回一个函数显然不能满足要求，于是就可以把函数组织到一个table中，然后返回这个table……
这里注意到一件事，就是作用域，或者更专业一点称为“词法域”。试试下面这段代码：[code]
--outer.lua:
print(name .. "，你好！")
--main.lua:
name = "雷叔"
local name = "牛叔"
dofile("outer.lua")
[/code]运行结果是“雷叔，你好！”这里就奇怪了，按理说这里出现了一个局部变量会屏蔽掉全局变量，但是这里输出的却是全局变量的值。外部lua文件在编译时并没有涉及词法域。

前面提到了引入外部lua文件中所定义函数的问题，显然dofile不是一个好的解决方法。是时候请出专业方法require了。关于require的行为和路径搜索这些书上和网上都有很多资料，这里不是研究的重点，下面直接进入试验阶段。[code]
--outer.lua:
function sayHello()
print(name .. "，你好！")
end
--mian.lua:
require("outer")
name = "雷叔"
local name = "牛叔"
sayHello()
[/code]形式上很类似C语言的#include<...>，在其他地方定义的函数，经这么引入文件之后就可以调用了。不过lua并不是定义和实现分离的语言，这样是把整个定义部分都加载进来了哦。加载过程大致上是lua先加载这个外部文件，然后运行它。实际上这段外部代码是可以有返回值的，它的返回值就是require的返回值。这里我们什么返回值都没有，执行这个外部代码的结果就是定义了这么个全局函数。注意是全局函数，虽然通常我们直接定义的函数都是全局函数所以都没怎么注意过，要是非要定义个局部函数在主程序块里可就看不到了。另外和前面的情形一样，外部代码块只认识“雷叔”，“牛叔”是谁它根本不知道。
可以在外部文件里定义一堆函数，然后全都加到全局环境下。不过全局的东西用起来要小心，有一个原则是对全局的“污染”越小越好。那么自然就引入了“模块”的概念。在lua中，模块由万能的table来充当。最自然的想法就是定义一个table，然后把要定义的函数放在这个table里，最后返回这个table就行了。
当然这种没经过精雕细琢的方法还是有问题的，比如模块名应该和文件名一致而不应该和table的名字有什么联系。另外就是把公共函数放在table里，即使同一个模块里的函数相互调用的话也得带上table名的前缀。还有就是公共函数需要加前缀，局部函数不需要，这就导致在模块内部调用两类函数的方式也不一样，这样如果需要改动某个函数的访问类型需要修改的地方可能会很多……这些问题，留着在下次的研究报告里解决吧。