技术说明 11

重新审视 Require：导入

此 LTN 依赖于 Lua 5.0 中引入的“loadfile”

摘要

Lua 4.1 引入了“require”函数，该函数加载并运行文件，除非已加载该文件。Lua 5.0 在其基本库中提供 require 作为内置函数。require 命令与 LTN 7“模块和包”一起为 Lua 中的简单模块支持提供了基础。此技术说明提出了一个改进版的 require，称为“import”。提议的 import 方案避免直接访问全局变量，纠正与全局变量相关的安全漏洞，并妥善处理循环模块依赖项。

问题

• 包使用的全局名称可能已保存数据（名称冲突）。
• 包的用户必须知道包将接口分配给哪个全局名称。
• 在全局变量表上设置的元方法可能会干扰模块的加载。

• Require 依赖于上述 LTN 7 全局公共接口系统，并且不提供进一步的包管理。
• Lua 5.0 中的 require 调用将它自己的全局变量表传递给所需包，从而为该包提供严重的安全性漏洞。由于 require 是内置 C 函数，因此“setglobals”调用不适用于 require 以防止这种情况发生。
• 如果模块相互需要（即循环依赖），则 require 调用将无限递归，从而导致堆栈溢出。

解决方案

• 包返回“包安装”函数 (PIF)，该函数反过来由 import 调用。
• 将一个表传递给 PIF，包的公共接口应插入其中。然后，此表作为 import 调用的结果返回。包不再应安装全局接口。
• 包名称和完整包路径作为第二个和第三个参数传递给 PIF。
• Import 将其调用者的全局变量强加于导入的包。
• 如果在完全导入包之前使用该包，Import 将报告错误。这可能发生在循环依赖包的导入期间。（如果访问了包的公共接口，则“使用”该包。）包可以循环依赖而不在导入期间相互使用。在这种情况下，import 将成功，不会出现错误。（说明部分中给出了一个示例。）

可以使用以下 Lua 5.0 代码实现 import 函数。

local imported = {}

local function package_stub(name)
  local stub = {}
  local stub_meta = {
    __index = function(_, index)
      error(string.format("member `%s' is accessed before package `%s' is fully imported", index, name))
    end,
    __newindex = function(_, index, _)
      error(string.format("member `%s' is assigned a value before package `%s' is fully imported", index, name))
    end,
  }
  setmetatable(stub, stub_meta)
  return stub
end

local function locate(name)
  local path = LUA_PATH
  if type(path) ~= "string" then
    path = os.getenv "LUA_PATH" or "./?.lua"
  end
  for path in string.gfind(path, "[^;]+") do
    path = string.gsub(path, "?", name)
    local chunk = loadfile(path)
    if chunk then return chunk, path end
  end
  return nil, path
end

function import(name)
  local package = imported[name]
  if package then return package end
  local chunk, path = locate(name)
  if not chunk then
    error(string.format("could not locate package `%s' in `%s'", name, path))
  end
  package = package_stub(name)
  imported[name] = package
  setglobals(chunk, getglobals(2))
  chunk = chunk()
  setmetatable(package, nil)
  if type(chunk) == "function" then
    chunk(package, name, path)
  end
  return package
end

import 的典型用法如下

-- import the complex package
local complex = import "complex"

-- complex now holds the public interface
local x = 5 + 3*complex.I

一个包的结构应如下所示

-- first import all other required packages.
local a = import "a"
local b = import "b"

-- then define the package install function.
-- the PIF more or less contains the code of a
-- LTN 7 package.
local function pif(Public, path)

local Private = {}

function Public.fun()
  -- public function
end

-- etc.
end

-- return the package install function
return pif

说明

导入几乎与 require 向后兼容。但是，导入不会在加载期间定义 _REQUIREDNAME 全局变量。一个不返回 PIF 的“旧式”包仍然会被加载并运行，但导入返回一个空的公共接口。这不会影响旧式代码，因为 require 没有返回值。

以下是两个包相互导入的示例。因为在导入期间没有一个包实际使用另一个包，所以这不会成为问题。

包“a.lua”

local b = import "b"

local function pif(pub, name, path)

function pub.show()
  -- use a message from package b
  print("in " .. name .. ": " .. b.message)
end

pub.message = "this is package " .. name .. " at " .. path

end

return pif

包“b.lua”

local a = import "a"

local function pif(pub, name, path)

function pub.show()
  -- use a message from package a
  print("in " .. name .. ": " .. a.message)
end

pub.message = "this is package " .. name .. " at " .. path

end

return pif

一些导入和运行两者的代码

local a = import "a"
local b = import "b"

a.show() -- prints "in a: this is package b at ./b.lua"
b.show() -- prints "in b: this is package a at ./a.lua"

弱点

结论