离线下载
PDF版 ePub版

WenMing · 更新于 2017-10-22 19:00:25

抵制使用 module()函数来定义 Lua 模块

旧式的模块定义方式是通过 *module("filename"[,package.seeall])*来显示声明一个包,现在官方不推荐再使用这种方式。这种方式将会返回一个由 filename 模块函数组成的 table,并且还会定义一个包含该 table 的全局变量。

如果只给 module 函数一个参数(也就是文件名)的话,前面定义的全局变量就都不可用了,包括 print 函数等,如果要让之前的全局变量可见,必须在定义 module 的时候加上参数 package.seeall 。调用完 module 函数之后, print 这些系统函数不可使用的原因,是当前的整个环境被压入栈,不再可达。

module("filename", package.seeall) 这种写法仍然是不提倡的,官方给出了两点原因:

  1. package.seeall 这种方式破坏了模块的高内聚,原本引入"filename"模块只想调用它的 foobar() 函数,但是它却可以读写全局属性,例如 "filename.os"

  2. module 函数压栈操作引发的副作用,污染了全局环境变量。例如 module("filename") 会创建一个 filenametable ,并将这个 table 注入全局环境变量中,这样使得没有引用它的文件也能调用 filename 模块的方法。

比较推荐的模块定义方法是:

-- square.lua 长方形模块
local _M = {}           -- 局部的变量
_M._VERSION = '1.0'     -- 模块版本

local mt = { __index = _M }

function _M.new(self, width, height)
    return setmetatable({ width=width, height=height }, mt)
end

function _M.get_square(self)
    return self.width * self.height
end

function _M.get_circumference(self)
    return (self.width + self.height) * 2
end

return _M

引用示例代码:

local square = require "square" 

local s1 = square:new(1, 2)
print(s1:get_square())          --output: 2
print(s1:get_circumference())   --output: 6
  • 另一个跟 lua 的 module 模块相关需要注意的点是,当 lua_code_cache on 开启时, require 加载的模块是会被缓存下来的,这样我们的模块就会以最高效的方式运行,直到被显式地调用如下语句:
package.loaded["square"] = nil

我们可以利用这个特性代码来做一些进阶玩法。