HOWTO · Ruby

在 Ruby 中使用注入方法

本文演示了 Ruby 中注入方法的不同用途。

本页内容

Ruby 的 inject 方法会逐个处理集合中的元素,并通过累加器将它们合并为一个结果。它适用于求总和、分组数据和自定义聚合等操作;如果 join 或 select 更直接地表达了任务,就优先使用这些方法。

Ruby 中的 inject 有什么作用

inject 是 Enumerable 方法,数组和其他可枚举集合都可以使用。reduce 是它在 Ruby 中的别名;两种名称的行为相同。该方法会返回代码块生成的最终累加器。

inject 如何累积值

代码块会收到当前累加器和当前元素。代码块的返回值会成为处理下一个元素时的累加器。提供明确的初始值时,Ruby 会从该值开始处理集合中的每个元素。未提供初始值时,第一个元素会成为初始累加器,代码块从第二个元素开始执行。

运行下面的示例:

本节中的代码以及显示的标签或输出仍为英文。

numbers = [1, 2, 3, 4, 5]
total = numbers.inject(0) { |sum, number| sum + number }
puts total
15

此示例将 sum 初始设为 0,把每个数字加进去,并打印累积后的总和。

使用 inject 对数字求和

求和时,将 0 设为初始值,这样即使集合为空,计算也有明确的起点。每次执行代码块时,它都会返回更新后的总和。

本节中的代码以及显示的标签或输出仍为英文。

prices = [10, 20, 30]
total = prices.inject(0) { |sum, price| sum + price }
puts total
60

对于数字数组,如果不需要自定义累积逻辑,使用 sum 会更直接。当操作需要额外规则,或要将值合并成不同类型的结果时,inject 就很有用。

使用 inject 构建哈希

累加器可以是哈希这样的可变对象。此示例会统计每个单词出现的次数;代码块中的最后一个表达式会返回哈希,供下一次迭代继续使用。

本节中的代码以及显示的标签或输出仍为英文。

words = ["apple", "banana", "apple"]
counts = words.inject(Hash.new(0)) do |result, word|
  result[word] += 1
  result
end
puts counts.inspect
{"apple"=>2, "banana"=>1}

Hash.new(0) 会为哈希中尚未出现的单词提供 0。返回 result 很重要:返回的对象会传递给下一次代码块调用,最终完成的哈希也就是该方法的结果。

使用 inject 转换字符串和自定义对象

处理字符串时,可以用 inject 将每一部分追加到累加器中。对于简单拼接,数组的 join 通常更清楚,因为它可以直接处理分隔符。

本节中的代码以及显示的标签或输出仍为英文。

words = ["Ruby", "makes", "sense"]
sentence = words.inject("") do |result, word|
  result.empty? ? word : "#{result} #{word}"
end
puts sentence
Ruby makes sense

累加器也可以根据自定义对象计算出一个值。每个对象提供计算所需的属性,而累加器本身仍是一个数字。

Product = Struct.new(:name, :price)
products = [Product.new("Book", 12), Product.new("Pen", 3)]
total_price = products.inject(0) { |sum, product| sum + product.price }
puts total_price
15

当聚合结果取决于对象的属性时,这种写法很有用。如果对象已经提供了直接的聚合方法,为了让代码更清晰,应优先使用该方法。

使用 inject 筛选值

可以通过将符合条件的值追加到数组累加器中来构建新数组。对于常规筛选,select 更直接地表达了意图。

本节中的代码以及显示的标签或输出仍为英文。

numbers = [1, 2, 3, 4, 5, 6]
evens = numbers.inject([]) do |result, number|
  result << number if number.even?
  result
end
puts evens.inspect
[2, 4, 6]

每次检查后,代码块都会返回同一个数组。如果目标只是保留符合条件的元素,通常使用 select 会更清楚。

选择初始值并处理空集合

明确的初始值会决定累加器的类型和起始状态。求总和时使用 0,处理文本时使用空字符串,统计数量时使用新的哈希,收集值时使用空数组。即使没有元素要处理,这也能明确规定操作的返回值。

未提供初始值时,第一个元素会成为累加器,而不会作为代码块的当前元素传入。因此,对空集合调用 inject 且不提供初始值时会返回 nil。如果集合可能为空,或需要特定的结果类型,请提供初始值。初始值还应与代码块执行的操作兼容,以便每一步都能产生有效的下一个累加器。

何时使用 inject 或 reduce

当需要用 reduce 将集合累积成一个结果,并且代码块能清楚地表达这一转换时,可以选择 inject。reduce 是它的别名,可以互换使用;选定一个名称后,保持用法一致即可。如果 sum、join 或 select 能更清楚地表达操作,就优先使用它们。对于复杂的累积操作,应清楚命名代码块变量,并确保每条执行路径都返回预期的下一个累加器。