Cocos2d+Lua 游戏开发中的奇技淫巧系列之一 Lua require的语法糖

  妈蛋，感觉写的博客，又要烂尾了,我有罪，我的定力太差了，这就是我这么聪明，这么多年却只能混成个穷逼的根本原因吗？赶紧趁今天在公司暂时没有事情做，先发一篇文章.....

---------------------------------------------------------------------------------------------------------------------------------

   作为一个中级即将要成为高级的游戏开发程序员，用Lua写了一二年游戏的你，require这个有什么好提的，天天在用，使用中还有什么技巧可言？

  这个require在使用过程中，真的还有一些技巧，当然，这个技巧并不是说在游戏运行效率上有惊天的变化，而仅仅是一个语法糖，不用对游戏性能也没有半毛钱的影响，但是用了，可能对游戏开发效率和阅读效率都有些帮助。

    先分享一下require在Lua源代码中的实现...嗯，算了，这一步跳过吧，require加载一个lua的过程很多博客已经说了，我也说得并不比别人好，还是直接进入主题吧。

通常，很多游戏的reuire是这样子用的：比如，某游戏的包背管理器的是在PackageMgr.lua里面实现的，这个文件在游戏的Res\script\lua\mgr\PackageMgr.lua里面。假如PackageMgr.lua里面是这样子写的,即这个PackageMgr.lua是直接返回的一个单例。

local PackageMgr={}

--这里面是游戏逻辑

return PackageMgr

那么，在其它地方引用这个单例时，最常见的一种代码的写法是这样子：

方法1

local packet = require("script.lua.mgr.PackageMgr")

将Res设置成lua的搜索根路径，在引用时，使用全路径，这样子的用法是比较经典的，它的问题唯一在：写的代码太多了，你要引用别人写的一个模块，还要知道它所在的路径，假如这个路径很长，码起来很累的，copy也会出错，而且加载出错，要到运行时才能知道没有这个路径。

为了解决拼写过长的问题，我们可以考虑另外一种解决方案:

方法2

我们将Res\script\lua\mgr\添加到游戏的搜索路径，这样，在使用时就可以

local packet = require("PackageMgr")

只需要一个PackageMgr模块名就能将它引用进来了，是不是省了很多字？嗯，这种写法也有一个问题：就是假如游戏的文件夹太多，这样子就要添加很多的搜索路径，搜索路径太多的话，搜索的效率自然会降低了，而且，太多的文件路径，怎么添加？手工添加还是脚本添加？新增的和删除的文件夹怎么维护也是个问题。

好了，我们既想获得方法2的简洁，又想获得方法1 的高效率，自然的就出现了第三种方法

方法3

我们定义一个新的require,为了区别require，我们就叫做GameRequire吧。

function GameRequire(luaFileName)
    local fullLuaFilePath = FullPath[luaFileName]
    if fullLuaFilePath then
        return require(fullLuaFilePath)
    else
        return require(luaFileName)
    end
end

阅读上面GameRequire的实现代码，首先，通过一个全局的FullPath表，将luaFileName转换成FullLuaFilePath，假如存在FullLuaFilePath，我们就用FullLuaFilePath 进行require，假如不存在，我们就用luaFileName进行require。这样，我们在使用时只要输入一个lua文件名，就能自动实现全路径的搜索加载啦。相信大家都已经看出这里面实现文件名转换成长路径逻辑的关键是FullPath这个表了，这个表具体是长这样子的：

FullPath ={

Package="script.lua.mgr.PackageMgr",
MainUI ="script.lua.ui.MainUI",
....


} 

可以看出这个FullPath是一个全局的变量表，这个表里面的内容非常简单，就是将所有的lua文件都转换成了长路径保存，通常这个FullPath.lua是用脚本来实现和维护的，哪个同学新增了一个lua文件，就跑一下维护脚本，更新一下这个FullPath.lua，这样子大家都可以用GameRequire("文件名")就可以引用新增的模块了。

写到这里，相信很多写了几年lua的同学都想喷我了，什么辣鸡啊，这些东西也有什么好写的，不是很常见的吗？没有什么好说的。好吧，好吧，很显然，写GameRequire还是太累了，虽然我们可以把GameRequire简写成GR之类的，但还要写引号，括号。下面的方法就是解决这个懒人问题的奇淫技巧。这种方法是我自己原创出来的(虽然技术含量基本没有，可能也有很多大佬不宵，不过我觉得还是很意思的)。

方法4

我们知道lua里面有元表这个东西，元表里面的__index方法相信很多同学都知道了，这里面我们要用__index方法来实现lua文件的加载，使得我们可以少写点代码

 

local GameRequire= GameRequire
_GModel ={}
_GModelMeta={
__index =function(t,key)
    local modelFile = GameRequire(key)
    --t[key] = modelFile --这里是开启缓存功能
    return modelFile

end

}

我们定义了一个全局的变量_GModel,这个变量有一个元表_GModelMeta,里面有一个元方法。使用时是这样子使用的：

local packet = _GModel.PackageMgr

这样子就实现require的调用了。原理听我慢慢分析一下：

首先： _GModel.PackageMgr和 _GModel["PackageMgr"]是等价的对吧？（这是lua的语法，如果你不知道的，那么这篇文章对你来说真的是白看了）。

其次：lua先在_GModel表里面查找“PackageMgr”成员，查不到，就在元表_GModelMeta里面查找，_GModelMeta里面也找不到啊，没关系，_GModelMeta有一个__index元方法，那就调用 __index方法来查找吧，这样子__index里面的GameRequire函数就被调用 了，然后返回GameRequire的结果。上面__index函数被调用里，里面的参数t就是_GModel,key就是“PackageMgr”，为什么这二个参数值是这样子？你得回去查查元表的调用过程了。

上面的代码还有一句注释掉了的，这个注释掉的是一个缓存代码，假如将它打开，第一次调用时_GModel找不到成员，会触发GameRequire，同时，将GameRequire的返回值存在了_GModel里面了，第二次调用时，因为_GModel已经有模块的数据，将会直接返回，不再调用GameRequire，也就是也不会调用到require了，省了lua内部的查找过程，在这个角度看，开了缓存的_GModel的效率比require还要高一点。写的代码比require少，效率还要比require高那么一点点的方法，是不是个奇技淫巧？

好了，到这里，我们就完成了require的奇技介绍了。如果你愿意你可以将_GModel简单写成_M

local packet = _M.PackageMgr

这样子，require是不是就可以码很少字啦？哈哈，不过千万不要将_GModel简单写成_G,因为_G是lua的保留变量。