Lua 迭代器与closure

所谓“迭代器”就是一种可以遍历(iterate over)一种极和中所有元素的机制。在Lua中,通常将迭代其表示为函数。每调用一次函数,即返回集合中的“下一个”元素。

每个迭代器都需要在每次成功调用之间保持一种状态,这样才能知道它所在的位置及如何步进到下一个位置。closure对于这类人无提供了极佳的支持,一个closure就是一种可以访问外部嵌套环境中的局部变量的函数。对于closure而言,这些变量就可用于在成功调用之间保持状态值,从而使closure可以记住它在一次遍历中所在的位置。当然,为了创建一个新的closure,还必须创建它的这些“非局部的变量(non-local variable)”。因此一个closure结构通常涉及到两个函数:closure本身和一个用于创建该closure的工厂(factory)函数。

作为示例,来为列表写一个简单的迭代器。与ipairs不同的是该迭代式并不是返回每个元素的索引,而是返回元素的值(返回什么还不是由自己决定嘛):

function values (t)
    local i = 0
    return function () i = i + 1; return t[i] end
end

在本例中,values就是一个工厂。每当调用这个工厂时,它就创建一个新的closure(即迭代器本身)。这个closure将它的状态保存在其外部变量t和i中。每当调用这个迭代器时,它就从列表t中返回下一个值。知道最后一个元素返回后,迭代其就会返回nil,一次表示迭代的结束。

可以在一个while循环中使用这个迭代器:

t = {10, 20, 30}
iter = values(t)                -- 创建迭代器
while true do
    local element = iter()      -- 调用迭代器
    if element == nil then break end
    print(element)
end

然而使用泛型for则更为简单。接下来会发现,它真实为这种迭代而设计的:

t2 = {40, 50, 60}
for element in values(t2) do
    print(element)
end

泛型for为一次迭代循环做了所有的蒲记工作。它在内部保存了迭代器函数,因此不再需要iter变量。它在每次新迭代时调用迭代器,并在迭代器返回nil时结束循环。

[迭代器示例——遍历文件中所有单词]

下面的示例中展示了一个可以遍历当前输入文件中所有单词的迭代器——allwords。为了完成这样的遍历,需要保持两个值:当前行的内容(变量line)及在该行中所处的位置(变量pos)。

这里用到一个string.find函数,返回当前查找单词位置。

尽管迭代器本身具有复杂性,但allwords的使用还是很简明易懂的:

for word in allwords() do
    print(word)
end

对于迭代器而言,一种常见的情况就是:编写迭代器本身或许不太容易,但使用它们却是很容易的。这也不会称为一个大问题,因为通常使用Lua编成的最终用户不会去定义迭代器,而只是使用那些程序提供的迭代器。

function allwords ()
    local line = io.read()      -- 当前行
    local pos = 1               -- 一行中的当前位置
    return function()           -- 迭代器函数
        while line do           -- 若为有效的行内容就进入循环
            local s, e = string.find(line, "%w+", pos)
            if s then           -- 是否找到一个单词
                pos = e + 1     -- 该单词的下一个位置
                return string.sub(line, s, e)   -- 返回该单词
            else
                line = io.read()    -- 没有找到单词,返回下一行
                pos = 1             -- 在第一个位置重新开始
            end
        end
        return nil              -- 没有其余行了,遍历结束
    end
end