Lua迭代器如何使用？

在Lua中，迭代器是一种用于遍历集合元素的重要工具。掌握迭代器的使用方法，对于提高Lua编程的效率和代码的可读性具有重要意义。

1.迭代器概述

12.1.1 迭代器介绍

迭代器是一种设计模式，它提供了一种访问集合元素的方法，而不需要暴露其底层结构。在Lua中，迭代器通常以一个函数的形式表示，每次调用该函数时，它会返回集合中的下一个元素。当没有更多元素时，迭代器返回nil。

1.2 泛型for循环

在Lua中，泛型for循环用于遍历一个迭代器函数返回的所有值。泛型for循环的基本语法如下： 

for variable1, variable2, ... in iterator_expression do
  -- 执行代码块
end

这里的iterator_expression通常是一个表达式，它应该返回三个值：迭代器函数、状态变量和初始值。在每一次循环中，Lua会调用迭代器函数，传递状态变量和上一次调用的结果（除了第一次，它会传递初始值）。当迭代器函数返回nil作为第一个值时，循环结束。

1.3 迭代器应用场景

迭代器在Lua中有多种应用场景，例如：

• 遍历数组或表。
• 遍历文件中的每一行。
• 处理数据库查询结果等。

通过使用迭代器，可以更加简洁地处理这些任务，同时保持代码的可读性和可维护性。

2.内置迭代器

Lua提供了两个常用的内置迭代器：

这两个迭代器都是无状态的，意味着它们不保留任何额外的状态信息，只依赖于传递给它们的状态常量和控制变量。

假设有一个包含数字的数组，可以使用ipairs函数来遍历该数组。

-- ipairs_test.lua文件
local numbers = {10, 20, 30}

for index, value in ipairs(numbers) do
  print(index, value)
end

执行以上脚本代码，程序输出结果如下。

1   10
2   20
3   30

根据上面的示例，下面我们来看看泛型for的执行过程：

• 首先，初始化，计算in后面表达式的值，表达式应该返回泛型for需要的三个值：迭代函数、状态常量、控制变量；与多值赋值一样，如果表达式返回的结果个数不足三个会自动用nil补足，多出部分会被忽略；
• 第二，将状态常量和控制变量作为参数调用迭代函数（注意：对于for结构来说，状态常量没有用处，仅仅在初始化时获取它的值并传递给迭代函数）；
• 第三，将迭代函数返回的值赋给变量列表；
• 第四，如果返回的第一个值为nil循环结束，否则执行循环体；
• 第五，回到第二步再次调用迭代函数。

对于一个关联数组（哈希表，key-value键值形式），我们可以用pairs来遍历键值对。

-- pairs_test.lua文件
local person = {
  name = "Alice",
  age = 30,
  city = "Beijing"
}

for key, value in pairs(person) do
  print(key, value)
end

执行以上脚本代码，程序输出结果如下。

name  Alice
age   30
city  Beijing

注意，pairs遍历表元素的顺序不是固定的，如果你想按照特定顺序访问元素，你应该显式地排序或者使用有序的数据结构。

3.自定义迭代器

在Lua编程语言中，迭代器是一种允许程序员遍历数据集合的重要工具。它让开发者可以访问集合中的每一个元素，而无需暴露集合的内部结构。根据是否保存遍历过程的状态，迭代器被分为两种类型：无状态迭代器和多状态迭代器。下面我们将详细介绍这两种迭代器，并提供具体的语法和示例帮助理解。

3.1 无状态迭代器

无状态迭代器是指不保留任何状态信息的迭代器。这意味着，在每次调用迭代函数时，它并不依赖于之前的状态来决定下一个元素的位置。相反，它仅使用两个参数——状态常量（通常是表本身）和控制变量（如索引或键）——来计算并返回下一个元素。例如，ipairs函数就是一个典型的无状态迭代器，它遍历数组的每一个元素，且元素的索引必须是数值。

在Lua中，使用无状态迭代器时，for循环的表达式部分需要提供三个值：

• 迭代函数：用于生成下一个元素。
• 状态常量：在迭代过程中不会改变的值，通常是需要遍历的集合。
• 控制变量：用于控制迭代过程的变量，通常在每次迭代后递增。

无状态迭代器的语法总结一下就是，当使用无状态迭代器时，泛型for循环会保存三个值：迭代函数、状态常量以及控制变量。这些值是在循环开始前由表达式计算出来的。每次迭代时，迭代函数都会以状态常量和控制变量作为参数被调用，并返回新的控制变量和一个或多个元素值。如果返回的第一个非空值为nil，则循环结束。

如下实现了一个简单的数字平方迭代器的例子。

-- no_state_iterator_test.lua文件
function square(iteratorMaxCount, currentNumber)
  if currentNumber < iteratorMaxCount then
    currentNumber = currentNumber + 1
    return currentNumber, currentNumber * currentNumber
  end
end

for i, n in square, 3, 0 do
  print(i, n) -- 输出结果为: 1 1, 2 4, 3 9
end

在这个例子中，square函数充当了无状态迭代器的角色。它接收最大计数iteratorMaxCount和当前数字currentNumber作为参数，然后根据这两个值计算出下一个要返回的数字及其平方值。

执行以上脚本代码，程序输出结果如下。

1   1
2   4
3   9

另一个常见的无状态迭代器是ipairs，它是用来遍历数组形式的表的。其工作原理如下所示。

function ipairs(t)
  return iter, t, 0
end

function iter(a, i)
  i = i + 1
  local v = a[i]
  if v then
    return i, v
  end
end

这段代码展示了如何创建一个类似于ipairs的迭代器，其中iter函数是一个无状态迭代器，因为它只依赖传入的状态常量a和控制变量i来确定下一个元素的位置。

3.2 多状态迭代器

多状态迭代器会在迭代过程中保存额外的状态信息。这使得每个迭代器实例都可以独立地遍历相同的集合，而不会相互影响。为了实现这一点，通常会使用闭包或者将所有必要的状态封装在一个表内，作为迭代器的一部分。

• 使用闭包：在迭代函数内部定义局部变量来保存状态，这些变量在每次迭代中都会被保留。
• 使用表：将状态信息封装到一个表中，将表作为迭代器的状态常量传递给迭代函数。

使用闭包。下面是一个创建自定义迭代器的例子，该迭代器可以遍历一个表中的所有元素，同时计算并输出它们的长度。

-- multi_state_iterator_test.lua文件
-- 定义一个数组
local array = {"Google", "Baidu", "ByteDance"}

-- 定义一个多状态迭代器
local function elementIterator(collection)
  local index = 0
  local count = #collection
  -- 返回一个闭包作为迭代器
  return function()
    index = index + 1
    if index <= count then
      return collection[index], string.len(tostring(collection[index]))
    end
  end
end

-- 使用迭代器遍历数组
for element, length in elementIterator(array) do
  print(element, length)
end

在这个例子中，elementIterator函数创建了一个闭包，该闭包维护了一个私有的index计数器和count变量。每当迭代器被调用时，它就会递增index并检查是否超过了count的限制。如果没有超过，则返回当前元素及其字符串表示形式的长度。

执行以上脚本代码，程序输出结果如下。

Google    6
Baidu   5
ByteDance   9

此外，还可以使用表来保存状态信息。例如，如果我们想要遍历一个包含文件路径的表，并读取每个文件的内容，我们可以这样做。

local files = {"file1.txt", "file2.txt"}

function fileReader(paths)
  local i = 0
  return function()
    i = i + 1
    local path = paths[i]
    if path then
      local f = io.open(path)
      if f then
        local content = f:read("*all")
        f:close()
        return path, content
      end
    end
  end
end

for path, content in fileReader(files) do
  print("File:", path)
  print("Content:", content)
end

这里，fileReader函数创建了一个闭包，该闭包负责打开指定路径下的文件并读取其内容。由于闭包能够捕获并记住外部作用域中的变量，因此它可以轻松地跟踪正在处理的是哪个文件。

最后对无状态迭代器和多状态迭代器做如下总结：

• 无状态迭代器：不保留任何状态，每次迭代都只依赖于迭代函数、状态常量和控制变量。适用于简单的迭代场景，如遍历数组。
• 多状态迭代器：需要保存多个状态信息，可以通过闭包或表来实现。适用于复杂的迭代场景，如遍历文件中的单词。

综上所述，无论是无状态还是多状态迭代器，它们都提供了灵活且强大的机制来遍历各种类型的集合。选择哪种迭代器取决于具体的应用场景和个人偏好。