foreach循环中Where查询的异常行为及解决方法

我在foreach循环内创建ToolStripItem时，使用.Where(...)查询为其.Tag属性赋值。第一次循环时第一个项的.Tag属性值正确，但第二次循环时，第一个项的.Tag值却变为第二次循环文本对应的结果，仿佛误用了第二次的文本参数。以下是简化示例代码：

var contextMenu = new ContextMenuStrip(); 
var values = new Dictionary<string,string[]>(); 
values.Add("Item1", new string[] { "Item1: Value1", "Item1: Value2", "Item2: This should not end up in the Tag property" }); 
values.Add("Item2", new string[] { "Item2: Value1", "Item2: Value2" }); 

foreach (var text in values.Keys) 
{ 
    var item = contextMenu.Items.Add(text); 
    item.Tag = values[text].Where(x => x.Contains(text)); 
} 
// Set a break point here

第一次触发断点时，第一个项的.Tag值正确；第二次触发断点时，第一个项的.Tag值异常包含了Item2的内容。

请问为何会出现这种现象？更重要的是，如何在不放弃.Where(...)查询的前提下解决这个问题？

注：这并非生产代码，仅为简化示例。

问题根源：闭包+延迟执行的双重陷阱 #

这其实是C#里一个非常经典的“闭包变量捕获”坑，再加上LINQ的延迟执行特性，才导致了这个诡异的现象：

在C# 5之前的版本中，foreach循环的迭代变量text是在循环体外声明的——也就是说，整个循环过程中，所有lambda表达式（也就是.Where(x => x.Contains(text))里的条件逻辑）捕获的都是同一个text变量。

而.Where()方法返回的是一个延迟执行的查询对象，它并没有立刻遍历集合生成结果，只是把过滤逻辑存了起来。当你在断点处查看Tag的值时，才会真正触发查询的执行，这时候text变量已经被更新为循环的最后一个值（也就是"Item2"），所以第一个项的Tag执行查询时，用的是已经改变后的text，自然就会匹配到包含"Item2"的内容。

哪怕是C# 5及以后的版本，foreach已经改成每次迭代都会创建新的变量，但如果你的代码运行在兼容旧行为的环境，或者写出类似的捕获逻辑，还是可能遇到这个问题。

解决方案（不放弃.Where(...)的前提下） #

有两种靠谱的解决方式，都能保留.Where()的过滤逻辑：

1. 循环内创建局部变量捕获 #

在每次迭代中，把当前的text值复制到一个局部变量里，让lambda捕获这个局部变量。这样每个迭代的lambda都会绑定到各自独立的局部变量，不会被后续循环的变量更新影响：

foreach (var text in values.Keys) 
{ 
    var currentText = text; // 关键：用局部变量保存当前迭代的text值
    var item = contextMenu.Items.Add(text); 
    item.Tag = values[text].Where(x => x.Contains(currentText)); 
}

2. 让查询立即执行（保留.Where()） #

如果你不需要延迟执行的特性，可以在.Where()后面加上.ToList()或.ToArray()，让查询立刻执行并生成结果集合。这样Tag存储的是已经计算好的结果，不会再受后续text变量变化的影响：

foreach (var text in values.Keys) 
{ 
    var item = contextMenu.Items.Add(text); 
    item.Tag = values[text].Where(x => x.Contains(text)).ToList(); // 立即执行查询，生成结果列表
}

内容的提问来源于stack exchange，提问作者Drew Chapin