Lua中如何实现字符串键表按代码定义顺序遍历

问题背景 #

原生 Lua 遍历字符串键构成的哈希表时，遍历顺序由表的内部哈希实现决定，无法保证和代码中的键定义顺序一致。示例代码如下：

local exampleTable = {
    ["Key_A"] = {
        
    },
    
    ["Key_B"] = {

    },
    
    ["Key_D"] = {

    },
}

核心需求：实现字符串键表的遍历顺序完全匹配代码中的定义顺序，和键的命名规则无关，同时方案需具备足够灵活性，维护成本低于已尝试的三类方案。

已验证存在缺陷的方案 #

1. 纯数组存储键方案 #

将键作为数组元素存储，天然保留定义顺序，插入新元素时无需调整其他项，自动生成数字索引，示例：

local differentExample = {
    {"Key_A"},
    {"Key_B"},
    {"KEY_D"},
}

插入Key_C到第三位时直接写在对应位置即可，无需修改其他内容：

local differentExample = {
    {"Key_A"},
    {"Key_B"},
    {"Key_C"},
    {"KEY_D"},
}

缺陷：无法直接通过字符串键索引对应值。后续演化出给每个数组项增加ID字段的写法：

local differentExample = {
    {
        ID = "Key_A",
    },
    
    {
        ID = "Key_B",
    },
    
    {
        ID = "Key_D",
    },
}

该写法虽然保留了定义顺序、插入新项方便，但索引值时必须遍历全表匹配ID字段，查询效率低，并非最优方案。

2. 手动添加Order字段标记顺序方案 #

为每个字符串键对应的子表添加Order字段标记顺序，支持直接通过字符串键索引值，示例：

local differentExample = {
    ["Car"] = {
        Order = 1
    },

    ["Train"] = {
        Order = 2
    },

    ["Key_D"] = {
        Order = 3
    },
}

缺陷：插入新元素时必须手动修改后续所有元素的Order值，例如在首位插入新键时，需要依次修改后续所有项的Order序号，维护成本极高，示例：

local DominoStones = {
    ["DominoStone_Special"] = {
        Order = 1
    },
    
    ["DominoStone_A"] = {
        Order = 2 -- 原值为1，需修改
    },

    ["DominoStone_B"] = {
        Order = 3 -- 原值为2，需修改
    },

    ["DominoStone_D"] = {
        Order = 4 -- 原值为3，需修改
    },
}

这是所有已尝试方案中使用体验最差的一种。

3. 单独维护有序键列表方案 #

额外定义orderedKeys数组按顺序存储所有字符串键，遍历表时按该数组的顺序访问，示例：

local orderedKeys = {
    "Key_A",
    "Key_B",
    "Key_D"
}

local exampleTable = {
    ["Key_A"] = {

    },

    ["Key_B"] = {

    },

    ["Key_D"] = {

    },
}

缺陷：虽然可以实现按定义顺序遍历，但新增表元素时必须同步在orderedKeys数组中添加对应键，存在维护冗余，使用体验仍不理想。

无效参考说明 #

Garry's Mod、Roblox等环境自带的自定义表打印函数通过table.sort按键名字母序排序输出，本质是按键名字典序排序而非按代码定义顺序，无法满足需求，不具备参考价值。

最优实现方案：元表自动维护插入顺序 #

通过Lua元表劫持表的读写、遍历操作，自动维护键的插入顺序列表，同时保留原生表O(1)复杂度的字符串键索引能力，插入、删除键时不需要手动修改任何额外字段或列表，维护成本为0。

实现代码 #

local function OrderedTable(init)
    local data = {}
    local keys = {}
    local mt = {
        __index = data,
        __newindex = function(_, k, v)
            -- 新增键时自动记录到顺序列表
            if v ~= nil and data[k] == nil then
                keys[#keys + 1] = k
            end
            -- 删除键时同步从顺序列表移除
            if v == nil and data[k] ~= nil then
                for i = 1, #keys do
                    if keys[i] == k then
                        table.remove(keys, i)
                        break
                    end
                end
            end
            data[k] = v
        end,
        -- 劫持pairs遍历，按插入顺序返回键值对
        __pairs = function()
            local i = 0
            return function()
                i = i + 1
                local k = keys[i]
                if k ~= nil then
                    return k, data[k]
                end
            end
        end,
        -- 支持获取表长度（可选）
        __len = function()
            return #keys
        end
    }
    local t = setmetatable({}, mt)
    -- 支持初始化时直接传入键值对，顺序和书写顺序一致
    if init then
        for k, v in pairs(init) do
            t[k] = v
        end
    end
    return t
end

使用方式 #

和原生表的使用习惯完全一致，零额外学习成本：

-- 初始化时直接书写键值对，顺序即为遍历顺序
local exampleTable = OrderedTable{
    ["Key_A"] = {},
    ["Key_B"] = {},
    ["Key_D"] = {}
}

-- 任意位置插入新键，不需要修改其他任何内容
exampleTable.Key_C = {}

-- 直接通过字符串键索引值，效率和原生表一致
print(exampleTable.Key_B) -- 直接返回对应值，无需全表遍历

-- 遍历输出顺序严格匹配定义顺序：Key_A -> Key_B -> Key_D -> Key_C
for k, v in pairs(exampleTable) do
    print(k)
end

方案优势 #

• 遍历顺序完全和键的定义/插入顺序一致，不受键名命名规则影响
• 保留原生哈希表O(1)复杂度的键索引能力，查询效率高
• 插入、删除键时无需手动维护Order字段或额外键列表，无冗余维护成本
• 兼容原生pairs遍历语法，使用习惯和原生表无差异

内容的提问来源于stack exchange，提问作者karl-police