【Unity开发总结】C# 闭包陷阱

0 问题

在项目中动态地监听一组按钮，要求为按钮 i 注册函数 ActiveBlueprint(i) （带一个 int 参数的函数），初始代码如下：

private void Awake()
{
    // 初始化所有界面和对应按钮，监听按钮
    blueprints = new List<GameObject>();
    blueprintButtons = new List<Button>();
    for (int i = 0; i < panelNumber; ++i)
    {
        //Debug.Log("Blueprint" + i.ToString().PadLeft(2, '0'));
        blueprints.Add(transform.Find("Blueprint" + i.ToString().PadLeft(2, '0')).gameObject);
        blueprintButtons.Add(transform.Find("MainPanel/Button" + i.ToString().PadLeft(2, '0')).GetComponent<Button>());
        blueprintButtons[i].onClick.AddListener(() =>
        {
            ActiveBlueprint(i);
        });
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

1 闭包陷阱¹

由于使用了 lambda 表达式作为 AddListener 的参数，变量 i 成为了被 lambda 表达式捕获的外部变量，所以变量 i 将不会被作为垃圾回收，直至引用变量的委托符合垃圾回收的条件²。

i 的最终取值是 panelNumber，这导致所有按钮都被注册了 ActiveBlueprint(panelNumber)，和需求不符，解决方法是在每一轮循环中都定义新的变量，这样每一次 lambda 表达式都捕获了不同的变量，避免闭包陷阱。

2 解决

private void Awake()
{
    // 初始化所有界面和对应按钮，监听按钮
    blueprints = new List<GameObject>();
    blueprintButtons = new List<Button>();
    for (int i = 0; i < panelNumber; ++i)
    {
        //Debug.Log("Blueprint" + i.ToString().PadLeft(2, '0'));
        blueprints.Add(transform.Find("Blueprint" + i.ToString().PadLeft(2, '0')).gameObject);
        blueprintButtons.Add(transform.Find("MainPanel/Button" + i.ToString().PadLeft(2, '0')).GetComponent<Button>());
        // 避免闭包陷阱
        int j = i;
        blueprintButtons[j].onClick.AddListener(() =>
        {
            ActiveBlueprint(j);
        });
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

---

1. https://www.cnblogs.com/pangjianxin/p/8400155.html ↩︎

2. https://docs.microsoft.com/zh-cn/dotnet/csharp/language-reference/operators/lambda-expressions ↩︎