抵制使用module()函数来定义Lua模块
最后更新于:2022-04-01 02:17:59
# 抵制使用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"_。
1.
_module_ 函数压栈操作引发的副作用,污染了全局环境变量。例如 _module("filename")_ 会创建一个 _filename_ 的 _table_ ,并将这个 _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
~~~
我们可以利用这个特性代码来做一些进阶玩法。