C# 循环中捕获的变量

Question

我遇到了一个关于 C# 的有趣问题。 我有如下代码。

List<Func<int>> actions = new List<Func<int>>();

int variable = 0;
while (variable < 5)
{
    actions.Add(() => variable * 2);
    ++ variable;
}

foreach (var act in actions)
{
    Console.WriteLine(act.Invoke());
}

我期望它输出 0、2、4、6、8。然而，它实际上输出了 5 个 10。

看来这是由于所有操作都引用了一个捕获的变量。 因此，当它们被调用时，它们都有相同的输出。

有没有办法解决这个限制，让每个操作实例都有自己的捕获变量？

Answer 1

正如其他人所说，它与循环无关。这是C#中匿名函数体中变量捕获机制的作用。
当您定义 lambda 作为示例时；

actions.Add(() => variable * 2);

编译器为 lambda 函数生成一个容器类，如 <>c__DisplayClass0_0
() =>; ()=> 变量 * 2。

在生成的类（容器）内部，它生成一个名为 variable 的字段，其中包含一个具有相同名称的捕获变量和包含 lambda 主体的方法 b__0() 。

[CompilerGenerated]
private sealed class <>c__DisplayClass0_0
{
public int variable;

internal int <Main>b__0()
{
    return variable * 2;
}
}

而名为 variable 的局部变量则成为容器类的一个字段 (<>c__DisplayClass0_0)，

<>c__DisplayClass0_.variable = 0;
while (<>c__DisplayClass0_.variable < 5)
{
    list.Add(new Func<int>(<>c__DisplayClass0_.<Main>b__0));
    <>c__DisplayClass0_.variable++;
}

因此递增变量会依次递增容器类的字段，并且因为我们获得了容器类的一个实例while 循环的所有迭代，我们得到相同的输出，即 10。

您可以通过将循环体内捕获的变量重新分配给新的局部变量来防止

while (variable < 5)
{
    var index = variable; // <= this line
    actions.Add(() => index * 2);
    ++ variable;
}

这种行为顺便说一句，这种行为仍然有效在 .Net 8 Preview 中，我发现这种行为非常错误且具有欺骗性。

Answer 2

for (int n=0; n < 10; n++) //forloop syntax
foreach (string item in foo) foreach syntax

Answer 3

这称为闭包问题，
只需使用复制变量即可。

List<Func<int>> actions = new List<Func<int>>();

int variable = 0;
while (variable < 5)
{
    int i = variable;
    actions.Add(() => i * 2);
    ++ variable;
}

foreach (var act in actions)
{
    Console.WriteLine(act.Invoke());
}

Answer 4

由于这里没有人直接引用 ECMA-334：

10.4.4.10 对于语句

对以下形式的 for 语句进行明确赋值检查：

for (for-initializer; for-condition; for-iterator) embedded-statement

就像编写语句一样完成：

{
    for-initializer;
    while (for-condition) {
        embedded-statement;
    LLoop: for-iterator;
    }
}

进一步在规范中，

12.16.6.3 局部变量的实例化

当执行进入变量的作用域时，局部变量被视为被实例化。

[示例：例如，当调用以下方法时，局部变量 x 会被实例化并初始化三次 - 每次循环迭代一次。

static void F() {
  for (int i = 0; i < 3; i++) {
    int x = i * 2 + 1;
    ...
  }
}

但是，将 x 的声明移出循环会导致 x 的单个实例化：

static void F() {
  int x;
  for (int i = 0; i < 3; i++) {
    x = i * 2 + 1;
    ...
  }
}

示例结束]

如果不捕获，则无法准确观察局部变量实例化的频率 - 因为实例化的生命周期是不相交的，每个实例化可能只使用相同的存储位置。 然而，当匿名函数捕获局部变量时，实例化的效果就变得显而易见。

[示例：示例

using System;

delegate void D();

class Test{
  static D[] F() {
    D[] result = new D[3];
    for (int i = 0; i < 3; i++) {
      int x = i * 2 + 1;
      result[i] = () => { Console.WriteLine(x); };
    }
  return result;
  }
  static void Main() {
    foreach (D d in F()) d();
  }
}

产生输出：

1
3
5

但是，当x的声明移出循环时：

static D[] F() {
  D[] result = new D[3];
  int x;
  for (int i = 0; i < 3; i++) {
    x = i * 2 + 1;
    result[i] = () => { Console.WriteLine(x); };
  }
  return result;
}

输出是：

5
5
5

请注意，编译器被允许（但不要求）将三个实例化优化为单个委托实例（第 11.7.2 节）。

如果 for 循环声明迭代变量，则该变量本身被视为在循环外部声明。
[示例：因此，如果更改示例以捕获迭代变量本身：

static D[] F() {
  D[] result = new D[3];
  for (int i = 0; i < 3; i++) {
    result[i] = () => { Console.WriteLine(i); };
  }
  return result;
}

仅捕获迭代变量的一个实例，该实例会产生输出：

3
3
3

示例结束]

哦，是的，我想应该提到的是，在 C++ 中不会出现此问题，因为您可以选择是否通过值或引用捕获变量（请参阅： Lambda 捕获）。

Answer 5

是的 - 在循环内获取变量的副本：

while (variable < 5)
{
    int copy = variable;
    actions.Add(() => copy * 2);
    ++ variable;
}

您可以将其视为 C# 编译器每次命中变量声明时都会创建一个“新”局部变量。 事实上，它会创建适当的新闭包对象，如果您引用多个作用域中的变量，它会变得复杂（就实现而言），但它可以工作:)

请注意，此问题更常见的情况是使用 for 或 foreach：

for (int i=0; i < 10; i++) // Just one variable
foreach (string x in foo) // And again, despite how it reads out loud

有关此内容的更多详细信息，请参阅 C# 3.0 规范的第 7.14.4.2 节，以及我的 关于闭包的文章也有更多示例。

请注意，从 C# 5 编译器及更高版本开始（即使指定早期版本的 C#），foreach 的行为发生了变化，因此您不再需要进行本地复制。 请参阅此回答以获取更多详细信息。

Answer 6

我相信您正在经历的是所谓的闭包 http://en.wikipedia.org/wiki /Closure_(计算机科学)。 你的lambda有一个对作用域在函数本身之外的变量的引用。 你的amba在你调用它之前不会被解释，一旦它被解释，它将获得变量在执行时的值。

Answer 7

在幕后，编译器正在生成一个类来表示方法调用的闭包。 它为循环的每次迭代使用闭包类的单个实例。 代码看起来像这样，这使得更容易理解错误发生的原因：

void Main()
{
    List<Func<int>> actions = new List<Func<int>>();

    int variable = 0;

    var closure = new CompilerGeneratedClosure();

    Func<int> anonymousMethodAction = null;

    while (closure.variable < 5)
    {
        if(anonymousMethodAction == null)
            anonymousMethodAction = new Func<int>(closure.YourAnonymousMethod);

        //we're re-adding the same function 
        actions.Add(anonymousMethodAction);

        ++closure.variable;
    }

    foreach (var act in actions)
    {
        Console.WriteLine(act.Invoke());
    }
}

class CompilerGeneratedClosure
{
    public int variable;

    public int YourAnonymousMethod()
    {
        return this.variable * 2;
    }
}

这实际上不是示例中编译的代码，但我检查了我自己的代码，这看起来非常像编译器实际生成的代码。

Answer 8

这与循环无关。

触发此行为是因为您使用 lambda 表达式 () => 变量 * 2 其中外部作用域变量 实际上并未在 lambda 的内部作用域中定义。

Lambda 表达式（在 C#3+ 中，以及 C#2 中的匿名方法）仍然创建实际方法。 将变量传递给这些方法会遇到一些困境（按值传递？按引用传递？C# 采用引用 - 但这会带来另一个问题，即引用可能比实际变量更长寿）。 C# 解决所有这些困境的方法是创建一个新的辅助类（“闭包”），其中的字段对应于 lambda 表达式中使用的局部变量，方法对应于实际的 lambda 方法。 代码中对 variable 的任何更改实际上都会转换为 ClosureClass.variable 中的更改，

因此您的 while 循环会不断更新 ClosureClass.variable 直到它达到 10，然后 for 循环执行操作，这些操作都在同一个 ClosureClass.variable 上运行。

为了获得预期的结果，您需要在循环变量和正在关闭的变量之间创建分隔。 您可以通过引入另一个变量来做到这一点，即：

List<Func<int>> actions = new List<Func<int>>();
int variable = 0;
while (variable < 5)
{
    var t = variable; // now t will be closured (i.e. replaced by a field in the new class)
    actions.Add(() => t * 2);
    ++variable; // changing variable won't affect the closured variable t
}
foreach (var act in actions)
{
    Console.WriteLine(act.Invoke());
}

您还可以将闭包移动到另一个方法来创建这种分离：

List<Func<int>> actions = new List<Func<int>>();

int variable = 0;
while (variable < 5)
{
    actions.Add(Mult(variable));
    ++variable;
}

foreach (var act in actions)
{
    Console.WriteLine(act.Invoke());
}

您可以将 Mult 实现为 lambda 表达式（隐式闭包）

static Func<int> Mult(int i)
{
    return () => i * 2;
}

或使用实际的辅助类：

public class Helper
{
    public int _i;
    public Helper(int i)
    {
        _i = i;
    }
    public int Method()
    {
        return _i * 2;
    }
}

static Func<int> Mult(int i)
{
    Helper help = new Helper(i);
    return help.Method;
}

在任何情况下，“闭包”不是与循环相关的概念，而是与使用局部作用域变量的匿名方法/lambda 表达式相关 - 尽管一些不谨慎的循环使用表明了闭包陷阱。

Answer 9

解决这个问题的方法是将您需要的值存储在代理变量中，并捕获该变量。

IE

while( variable < 5 )
{
    int copy = variable;
    actions.Add( () => copy * 2 );
    ++variable;
}

Answer 10

是的，您需要在循环内确定变量的作用域并以这种方式将其传递给 lambda：

List<Func<int>> actions = new List<Func<int>>();

int variable = 0;
while (variable < 5)
{
    int variable1 = variable;
    actions.Add(() => variable1 * 2);
    ++variable;
}

foreach (var act in actions)
{
    Console.WriteLine(act.Invoke());
}

Console.ReadLine();

Answer 11

同样的情况也发生在多线程（C#，.NET 4.0]中。

请参阅以下内容code:

目的是按顺序打印 1,2,3,4,5

for (int counter = 1; counter <= 5; counter++)
{
    new Thread (() => Console.Write (counter)).Start();
}

输出很有趣（可能像 21334...）

唯一的解决方案是使用局部变量。

for (int counter = 1; counter <= 5; counter++)
{
    int localVar= counter;
    new Thread (() => Console.Write (localVar)).Start();
}