环境与全局变量管理

概述

Lua 5.2+ 使用 _ENV 替代了 Lua 5.1 的 setfenv/getfenv 机制。_ENV 是一个特殊的局部变量，控制全局变量的查找范围。通过操作 _ENV，可以实现沙盒环境、模块隔离和全局变量保护等高级功能。

基础概念

_ENV 的工作原理

-- 所有全局变量访问实际上是在 _ENV 表中查找
-- 以下两行等价
print("hello")
_ENV.print("hello")

-- 全局变量赋值也是在 _ENV 中操作
x = 10          -- 等价于 _ENV.x = 10
print(x)        -- 等价于 print(_ENV.x)

_ENV 与 _G 的关系

-- _G 是全局环境表的引用，默认 _ENV == _G
print(_ENV == _G) -- true（在主代码块中）

-- _ENV 是局部变量，可以被子作用域覆盖
-- _G 是全局变量，始终指向最初的全局环境

快速上手

沙盒环境

-- 创建受限的沙盒环境
local sandbox = {
    print = print,
    math = math,
    string = string,
    tonumber = tonumber,
    tostring = tostring,
    type = type,
    ipairs = ipairs,
    pairs = pairs,
}

-- 在沙盒中执行代码
local code = "print(math.sqrt(16))"
local fn = load("local _ENV = ...; " .. code, "sandbox", "t", sandbox)
fn(sandbox)  -- 输出 4

-- 沙盒中无法访问未授权的功能
local badCode = "os.execute('rm -rf /')"
local badFn = load("local _ENV = ...; " .. badCode, "sandbox", "t", sandbox)
-- badFn(sandbox) 会报错：attempt to index nil value (字段 'os')

环境继承

-- 创建继承自全局环境的子环境
local function createEnv(parent)
    return setmetatable({}, { __index = parent or _G })
end

-- 模块专用环境
local moduleEnv = createEnv()
moduleEnv.config = { debug = true }

-- 在模块环境中执行代码
local code = [[
    if config.debug then
        print("调试模式已开启")
    end
]]

local fn = load("local _ENV = ...; " .. code, nil, "t", moduleEnv)
fn(moduleEnv)

详细用法

全局变量保护

-- 检测未定义的全局变量读取
setmetatable(_G, {
    __newindex = function(t, k, v)
        if v == nil then
            error("尝试将全局变量设为 nil: " .. k, 2)
        end
        rawset(t, k, v)
    end,
    __index = function(t, k)
        error("尝试访问未定义的全局变量: " .. k, 2)
    end
})

-- 需要先声明全局变量
rawset(_G, "MY_CONFIG", {})

-- 使用 rawget 绕过保护
local value = rawget(_G, "MY_CONFIG")

严格模式实现

-- 严格模式：必须先声明才能使用全局变量
local declared = {}

setmetatable(_G, {
    __newindex = function(t, k, v)
        if not declared[k] then
            declared[k] = true
        end
        rawset(t, k, v)
    end,
    __index = function(t, k)
        if not declared[k] then
            error("未定义的全局变量: " .. k, 2)
        end
        return rawget(t, k)
    end
})

-- 声明全局变量
MY_CONST = 42       -- 通过 __newindex 声明
print(MY_CONST)      -- 正常访问
-- print(UNDEFINED)  -- 报错

模块环境隔离

-- 为每个模块创建独立环境
local function loadModule(name)
    local env = setmetatable({}, { __index = _G })
    local path = name:gsub("%.", "/") .. ".lua"
    local file = io.open(path, "r")
    if not file then return nil end
    local code = file:read("*a")
    file:close()

    -- 在独立环境中加载模块
    local fn = load(code, name, "t", env)
    if not fn then return nil end
    fn()

    -- 返回模块的导出表
    return env
end

-- 使用
local myModule = loadModule("mymodule")

常见场景

插件沙盒

-- 为插件创建安全沙盒
local function createPluginSandbox(pluginName)
    local sandbox = {
        print = function(...) print("[" .. pluginName .. "]", ...) end,
        type = type,
        tostring = tostring,
        tonumber = tonumber,
        pairs = pairs,
        ipairs = ipairs,
        table = table,
        string = string,
        math = math,
        -- 提供受限的 API
        registerCommand = function(name, fn)
            registerPluginCommand(pluginName, name, fn)
        end,
    }
    return sandbox
end

-- 加载插件
local function loadPlugin(name, code)
    local sandbox = createPluginSandbox(name)
    local fn = load("local _ENV = ...; " .. code, name, "t", sandbox)
    if fn then fn(sandbox) end
end

配置文件加载

-- 安全加载配置文件
local function loadConfig(filename)
    local env = {}  -- 空环境，只能设置值
    local code = io.open(filename):read("*a")
    local fn = load("local _ENV = ...; " .. code, filename, "t", env)
    if fn then fn(env) end
    return env
end

-- config.lua 内容：
-- host = "localhost"
-- port = 8080
-- debug = true

local config = loadConfig("config.lua")
print(config.host)  -- "localhost"
print(config.port)  -- 8080

注意事项

• _ENV 是局部变量，每个代码块可以有不同的 _ENV
• load 函数的第四个参数可以直接设置 _ENV
• 在沙盒中务必过滤掉 os.execute、io.open 等危险函数
• setmetatable(_G, …) 会影响所有全局变量访问，谨慎使用
• Lua 5.1 使用 setfenv/getfenv，5.2+ 使用 _ENV，两者不兼容
• rawget 和 rawset 可以绕过元方法，用于在受保护的环境中操作

进阶用法

环境链

-- 创建多层环境链
local function chainEnv(...)
    local envs = { ... }
    return setmetatable({}, {
        __index = function(t, k)
            for i = #envs, 1, -1 do
                local v = envs[i][k]
                if v ~= nil then return v end
            end
            return nil
        end
    })
end

-- 使用：本地覆盖 > 模块 > 全局
local localEnv = { debug = true }
local moduleEnv = { version = "1.0" }
local env = chainEnv(localEnv, moduleEnv, _G)

print(env.debug)   -- true（来自 localEnv）
print(env.version) -- "1.0"（来自 moduleEnv）
print(env.print)   -- function（来自 _G）