技術備忘 11

重新檢視 Require：Import

此 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 會成功且不會出錯。（範例見下方的說明區段）

import 函式可以使用以下 Lua 5.0 程式碼實作

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

說明

Import 幾乎與 require 向後相容。不過，import 在載入期間不會定義 _REQUIREDNAME 全域變數。不會傳回 PIF 的「舊式」套件仍會載入並執行，但 import 會傳回一個空的公開介面。這不會影響舊式程式碼，因為 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"

缺點

結論