迭代器是 Lua 中遍歷集合(表、數組、自定義數據結構)的核心抽象。不同於 C++/Java 的迭代器對象,Lua 以函數閉包實現迭代器,輕量、靈活、極具表達力。本文系統講解無狀態迭代器、有狀態迭代器(閉包迭代器)、標準庫迭代器(pairs/ipairs)及自定義迭代器模式,配合完整代碼示例。
Lua 的 for var_1, ..., var_n in explist do block end 語法糖背後協議:
explist 求值結果為三值:迭代器函數 iter、不變狀態 state、控制變量初值 control。iter(state, control)。nil,循環結束;否則將返回值賦給循環變量,執行循環體,control 更新為第一個返回值,繼續下一輪。迭代器函數不保留任何狀態,完全依賴 state 和 control 參數計算下一個元素。典型代表:ipairs、pairs 內部實現。
-- 迭代器函數:接收不變狀態 max、控制變量 current
local function square_iter(max, current)
current = current + 1
if current <= max then
return current, current * current -- 返回新 control、值
end
return nil -- 結束
end
-- 工廠函數:返回 iter, state, initial_control
local function squares(max)
return square_iter, max, 0
end
-- 使用
for i, n in squares(3) do
print(i, n) -- 1 1 2 4 3 9
end
關鍵點:square_iter 內部無局部變量保存狀態,所有狀態由 for 機制通過參數傳遞。這意味著同一迭代器可並發用於多個循環(線程安全),但無法實現需要內部記憶的複雜遍歷(如樹的深度優先)。
利用 Lua 閉包捕獲外部局部變量(upvalue)保存狀態。工廠函數創建閉包並返回,每次調用閉包即推進狀態。
local function elementIterator(collection)
local index = 0 -- upvalue:當前索引
local count = #collection -- upvalue:總數
return function() -- 閉包迭代器函數
index = index + 1
if index <= count then
return collection[index] -- 返回單個值
end
return nil
end
end
local array = {"Lua", "Tutorial"}
for element in elementIterator(array) do
print(element) -- Lua Tutorial
end
進階:返回多值的閉包迭代器
local function kvIterator(t)
local keys = {}
for k in pairs(t) do keys[#keys+1] = k end
local i = 0
return function()
i = i + 1
if keys[i] then
return keys[i], t[keys[i]] -- 返回 key, value
end
end
end
for k, v in kvIterator({a=1, b=2}) do print(k, v) end
ipairs(t) —— 數組部分有序遍歷nil 停止。index, value。適合列表類表。luaB_ipairs)。pairs(t) —— 全表無序遍歷__pairs 元方法,調用該方法返回自定義迭代器(支援代理表、只讀表等)。next(t, k) —— 底層原語pairs 本質返回 next, t, nil。next(t, k) 返回 t 中「下一個」鍵值對(相對於 k)。k=nil 返回第一對。local k, v = next(t, nil); while k do ... k, v = next(t, k) end。-- 可配置步長、篩選條件的通用數組迭代器
local function arrayIter(arr, step, filter)
step = step or 1
local i = 1 - step
return function()
i = i + step
while arr[i] ~= nil do
if not filter or filter(arr[i], i) then
return i, arr[i]
end
i = i + step
end
end
end
-- 僅遍歷偶數索引且值>10的元素
for i, v in arrayIter(data, 2, function(v) return v > 10 end) do ... end
複雜遍歷(如樹的深度優先、組合生成)用協程實現更清晰:
local function treeIter(root)
local co = coroutine.create(function(node)
local function traverse(n)
if not n then return end
coroutine.yield(n.value)
for _, child in ipairs(n.children) do traverse(child) end
end
traverse(node)
end)
return function()
local ok, val = coroutine.resume(co)
return ok and val or nil
end
end
pairs 行為未定義,ipairs 可能漏項/重複)。需先收集鍵再操作。ipairs 經 JIT 編譯極快。Lua 迭代器以函數+閉包極簡實現了強大的遍歷抽象:
pairs/ipairs:覆蓋 90% 場景,__pairs 元方法支援擴展。掌握迭代器編寫,是編寫地道、高效、可擴展 Lua 代碼的關鍵技能之一。