抵制使用 module() 定义模块

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

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

  • 1、 package.seeall 这种方式 破坏了模块的高内聚。 比如，原本引入 “filename” 模块只是想调用它的 foobar() 函数，但是它却可以读写全局属性，例如 "filename.os"。
  • 2、 module 函数 压栈操作引发的副作用，污染了全局环境变量。 例如， module("filename") 会创建一个 filename 的 table，并将这个 table 注入全局环境变量中，这样使得没有引用它的文件也能调用 filename 模块的方法。

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

  1. -- square.lua 长方形模块
  2. local _M = {}           -- 局部的变量
  3. _M._VERSION = '1.0'     -- 模块版本
  5. local mt = { __index = _M }
  7. function _M.new(self, width, height)
  8.     return setmetatable({ width=width, height=height }, mt)
  9. end
  11. function _M.get_square(self)
  12.     return self.width * self.height
  13. end
  15. function _M.get_circumference(self)
  16.     return (self.width + self.height) * 2
  17. end
  19. return _M

引用示例代码：

  1. local square = require("square")
  3. local s1 = square:new(1, 2)
  4. print(s1:get_square())          --output: 2
  5. print(s1:get_circumference())   --output: 6

另一个跟 Lua 的 module 模块相关，需要注意的点是，当 lua_code_cache on 开启时，require 加载的模块是 会被缓存下来的，这样我们的模块就会以最高效的方式运行，直到被显式地调用如下语句（这里有点像模块卸载）：

  1. package.loaded["square"] = nil

我们可以利用这个特性代码来做一些高阶玩法，比如代码热更新等。