C++提醒：函数局部静态变量仅初始化一次，即使看起来像是多次初始化

# C++ 提醒：函数内的静态变量只初始化一次，即使看起来会被多次初始化 来源：https://devblogs.microsoft.com/oldnewthing/20260928-00/?p=112738/ 当你在函数内部编写一个静态变量时，它只会被初始化一次——具体来说，是在执行流首次到达该变量的声明处时（https://devblogs.microsoft.com/oldnewthing/20260916-00/?p=112703）。如果之后执行流再次到达该变量，不会再进行初始化，它只是保留旧值。 前段时间，我注意到有人尝试通过将变量设为静态来修复一个生命周期问题。原始代码使用了来自外部控件库的这个头文件： ```cpp // widget.h struct WidgetController { virtual WidgetKind GetKind() = 0; virtual WidgetFlags GetFlags() = 0; virtual void OnOpening() = 0; // 其他内容... }; std::shared_ptr<Widget> MakeWidget(std::shared_ptr<WidgetController> const& controller); ``` 其思路是，你提供一个 `WidgetController` 对象，控件会在各个时机咨询它，从而允许你定制控件行为。应用代码的调用方式如下： ```cpp // 基础控件控制器提供信息但不覆盖任何默认行为。 struct BasicWidgetInfo { WidgetKind kind; WidgetFlags flags; // 其他内容... }; struct BasicWidgetController : WidgetController { BasicWidgetController(BasicWidgetInfo const& info) : m_info(info) {} WidgetKind GetKind() override { return m_info.kind; } WidgetFlags GetFlags() override { return m_info.flags; } // 不定制任何动态操作。 void OnOpening() override { } // 其他内容... private: BasicWidgetInfo const& m_info; }; struct Gadget { std::shared_ptr<Widget> m_widget; void CreateWidget(GadgetFlags flags) { BasicWidgetInfo info = { WidgetKind::Vanilla, WidgetFlags::Openable | (flags & GadgetFlags::ClosableWidget ? WidgetFlags::Closable : WidgetFlags::None) }; auto controller = std::make_shared<BasicWidgetController>(info); m_widget = MakeWidget(controller); } // 其他小工具内容... }; ``` 问题在于，`BasicWidgetController` 构造函数接受一个对 `BasicWidgetInfo` 的引用并保存它。后来，当控件向控制器请求标志时，控制器会在 `BasicWidgetInfo` 结构体中查找答案，但那个 `BasicWidgetInfo` 在 `CreateWidget` 返回时就已析构，因此它返回的是垃圾数据（甚至可能崩溃）。这是一个**释放后使用**的 bug。 为了解决这个问题，他们将 `info` 设为了静态。静态对象即使在函数返回后也会持续存在。 ```cpp void CreateWidget(GadgetFlags flags) { static BasicWidgetInfo info = { WidgetKind::Vanilla, WidgetFlags::Openable | (flags & GadgetFlags::ClosableWidget ? WidgetFlags::Closable : WidgetFlags::None) }; auto controller = std::make_shared<BasicWidgetController>(info); m_widget = MakeWidget(controller); } ``` 现在程序不再崩溃了。太棒了！ 然而，这里有个陷阱：如果两个 `Gadget` 都尝试创建控件，它们都会拥有与第一个相同的选项，因为**函数内的静态变量在类的所有实例间共享，且只在执行流首次到达该变量时初始化**。第一次调用时传入的标志被锁定到了 `info` 中，之后无论你传入什么标志都无关紧要，因为 `info` 已经初始化过了，不会再次初始化。 如果你想每次都重新初始化，那么你必须每次都修改它。 ```cpp void CreateWidget(GadgetFlags flags) { static BasicWidgetInfo info; info = { WidgetKind::Vanilla, WidgetFlags::Openable | (flags & GadgetFlags::ClosableWidget ? WidgetFlags::Closable : WidgetFlags::None) }; auto controller = std::make_shared<BasicWidgetController>(info); m_widget = MakeWidget(controller); } ``` 这一次，我们将赋值作为一个独立于构造的步骤，这意味着它每次都会执行，`info` 会用最新的标志进行更新。当然，如果两个 `Gadget` 创建的控件生命周期有重叠，这仍然是一个问题，因为两个 `BasicWidgetController` 共享同一个 `info`。在第二次调用 `CreateWidget` 时，它对 `info` 的更新会暗中改变第一个控制器正在使用的值。另外，当然，如果 `CreateWidget` 被两个线程同时调用，那么对 `info` 变量的写操作会发生数据竞争，结果将不可预测。 根本问题在于，`BasicWidgetController` 希望延长其 `info` 的生命周期，但引用无法做到这一点，因此它只能依赖陌生人的善意。 一个想法是把 `info` 放在其他地方，以便能用其他方式延长其生命周期。或许可以把它放在 `Gadget` 中： ```cpp struct Gadget { std::shared_ptr<Widget> m_widget; BasicWidgetInfo m_info; void CreateWidget(GadgetFlags flags) { m_info = { WidgetKind::Vanilla, WidgetFlags::Openable | (flags & GadgetFlags::ClosableWidget ? WidgetFlags::Closable : WidgetFlags::None) }; auto controller = std::make_shared<BasicWidgetController>(m_info); m_widget = MakeWidget(controller); } // 其他小工具内容... }; ``` 现在你的任务是确保 `m_info` 不会在指向 `BasicWidgetController` 的最后一个共享指针之前析构。这很棘手，因为你并不真正知道 `BasicWidgetController` 的最后一个共享指针何时会析构，尽管你可能有一些启发式方法，因为它的生命周期很可能与 `Widget` 绑定。 有没有办法钩入最后一个 `shared_ptr` 的析构？实际上有，而且我们已经在无意中使用过这个特性。你可以使用一个**别名共享指针**（aliasing shared pointer），它指向一个 `BasicWidgetController`，但其生命周期同时控制一个 `BasicWidgetController` 和其关联的 `BasicWidgetInfo`。 ```cpp struct BasicWidgetControllerWithInfo { BasicWidgetControllerWithInfo(BasicWidgetInfo const& info) : m_info(info), m_controller(m_info) {} // m_info 必须在 m_controller 之前，因为 // m_controller 的初始化器依赖于 m_info。 BasicWidgetInfo m_info; BasicWidgetController m_controller; }; void CreateWidget(GadgetFlags flags) { BasicWidgetInfo info = { WidgetKind::Vanilla, WidgetFlags::Openable | (flags & GadgetFlags::ClosableWidget ? WidgetFlags::Closable : WidgetFlags::None) }; auto controllerAndInfo = std::make_shared<BasicWidgetControllerWithInfo>(info); auto controller = std::shared_ptr<WidgetController>( controllerAndInfo, &controllerAndInfo->m_controller); m_widget = MakeWidget(controller); } ``` 我们使用了指向控制器的别名构造函数，但告诉它控制 `BasicWidgetControllerWithInfo` 的生命周期。 当然，所有这一切都是应用程序自己造成的问题。他们应该直接修复 `BasicWidgetController`，使其**拷贝** `BasicWidgetInfo` 而不是接受引用。 ```cpp struct BasicWidgetController : WidgetController { BasicWidgetController(BasicWidgetInfo const& info) : m_info(info) {} WidgetKind GetKind() override { return m_info.kind; } WidgetFlags GetFlags() override { return m_info.flags; } // 不定制任何动态操作。 void OnOpening() override { } // 其他内容... private: BasicWidgetInfo /* const& */ m_info; }; ``` 现在原始代码又能正常工作了。 ```cpp void CreateWidget(GadgetFlags flags) { BasicWidgetInfo info = { WidgetKind::Vanilla, WidgetFlags::Openable | (flags & GadgetFlags::ClosableWidget ? WidgetFlags::Closable : WidgetFlags::None) }; auto controller = std::make_shared<BasicWidgetController>(info); m_widget = MakeWidget(controller); } ``` ### 分类 ### 主题 ## 作者 Raymond Chen Raymond 参与 Windows 的演进已超过 30 年。2003 年，他建立了一个名为 The Old New Thing 的网站，其受欢迎程度远超他最疯狂的想象，这一发展至今仍让他感到鸡皮疙瘩。该网站催生了一本书，书名也恰巧是 The Old New Thing（Addison Wesley 2007）。他偶尔会出现在 Windows Dev Docs 的 Twitter 账号上，讲些毫无实用信息的故事。