3.3 插件安装、初始化与注册序
插件多起来之后,顺序成了可预测性的来源。OGRE 的注册时序可以概括为:构造期按序 install → 窗口建好后统一 initialise → 关停时逆序 shutdown+uninstall。每个阶段对应一个 Root 方法。
构造期:loadPlugins 按序 install
Root 构造函数末尾调 loadPlugins(pluginFileName),plugins.cfg 里的插件按文件顺序逐个加载:
// OgreMain/src/OgreRoot.cpp:Root 构造尾部(v14.6.3 源码摘录,已删减)
// Load plugins
if (!pluginFileName.empty())
loadPlugins(pluginFileName);
loadPlugins 对每个库执行 loadPlugin → dllStartPlugin → installPlugin。此时系统未初始化,installPlugin 只调 install(),不调 initialise()。所以构造结束时,所有插件的 install 都执行了,initialise 一个都没跑。
窗口建好后:oneTimePostWindowInit 统一 initialise
initialise 的时机藏在 Root::oneTimePostWindowInit 里,注释点明因果——窗口创建之后渲染系统资源才可用:
// OgreMain/src/OgreRoot.cpp:oneTimePostWindowInit(v14.6.3 源码摘录,已删减)
// Background loader
mWorkQueue->startup();
// Initialise material manager
mMaterialManager->initialise();
// Init particle systems manager
mParticleManager->_initialise();
// Init mesh manager
MeshManager::getSingleton()._initialise();
// Init plugins - after window creation so rsys resources available
initialisePlugins();
mFirstTimePostWindowInit = true;
顺序:后台加载队列启动 → 材质/粒子/网格管理器初始化 → 最后 initialisePlugins。注释「after window creation so rsys resources available」把原因说透了:插件 initialise 可能需要渲染系统创建资源,而渲染系统依赖窗口。
关停:逆序卸载
shutdownPlugins 遍历 mPlugins,逐个 shutdown() 然后 uninstall(),顺序与安装相反。后注册的插件先退出,因为它可能依赖先注册的插件(比如渲染后端)仍存活。
mFirstTimePostWindowInit 标志还承担一个职责:未初始化过的系统不重复卸载插件。Root::shutdown 里:
// OgreMain/src/OgreRoot.cpp:Root::shutdown(v14.6.3 源码摘录,已删减)
if(mFirstTimePostWindowInit)
{
shutdownPlugins();
mParticleManager->removeAllTemplates(true);
mFirstTimePostWindowInit = false;
}
shutdownPlugins() 只在窗口初始化过(mFirstTimePostWindowInit 为真)时执行。这样「构造后直接析构、从未初始化」的程序不会触发插件卸载路径。
完整时序表
以两个插件(渲染后端、场景管理器插件)为例:
| 阶段 | 时机 | 动作 |
|---|---|---|
| 安装 | Root 构造 loadPlugins | backend.install → octree.install |
| 初始化 | 窗口创建 oneTimePostWindowInit | backend.initialise → octree.initialise |
| 关停 | Root::shutdown | octree.shutdown → octree.uninstall → backend.shutdown → backend.uninstall |
关键纪律:install 与 initialise 分离,保证「未初始化也能装、已初始化不重复跑」;卸载逆序,保证依赖方先离开。
插件安装与卸载时序
sequenceDiagram
participant R as Root
participant D as DynLibManager
participant P as 插件实例
R->>D: 加载动态库,解析 dllStartPlugin
D-->>R: 入口函数
R->>P: install,登记渲染后端或工厂
Note over R,P: 首窗完成或引擎已可用
R->>P: initialise
R->>P: shutdown
R->>P: dllStopPlugin 触发 uninstall
R->>D: 释放动态库
工厂登记与运行期初始化
install 适合登记工厂,依赖实际渲染系统的初始化应检查首窗是否已经完成。若在首窗之后动态安装,Root 可在安装路径上立即调用 initialise。插件要持有工厂直到最后一个由它创建的对象销毁。
用原生插件循环确认 Root 找得到工厂、SceneManager 能创建对象、销毁后撤销登记,并可再次加载同一个库。
源码定位
OgreMain/src/OgreRoot.cpp:loadPlugins(构造期)、oneTimePostWindowInit(initialisePlugins)、shutdownPlugins、Root::shutdown(mFirstTimePostWindowInit守卫)OgreMain/include/OgreRoot.h:initialisePlugins/shutdownPlugins声明
上游引用固定到 OGRE v14.6.3 源码 。
可运行产物:C++ 最小验证
下面复现两个插件的注册时序。它与 src/03-3-registration-order.cpp 逐字节一致:
// file: src/03-3-registration-order.cpp
// tier: L1
// verify: clang++ -std=c++20 -I. src/03-3-registration-order.cpp -o bin/03-3-registration-order && ./bin/03-3-registration-order
//
// 复现插件注册序:loadPlugins 按序 install;
// 窗口创建后 oneTimePostWindowInit 才 initialisePlugins;
// 卸载按安装的逆序 shutdown+uninstall。独立最小验证,非 OGRE 源码。
#include "verify.h"
#include <string>
#include <vector>
namespace ogre_repro {
struct PluginRepro {
std::string name;
std::vector<std::string>& log;
PluginRepro(const std::string& n, std::vector<std::string>& l)
: name(n), log(l) {}
void install() { log.push_back("install:" + name); }
void initialise() { log.push_back("initialise:" + name); }
void shutdown() { log.push_back("shutdown:" + name); }
void uninstall() { log.push_back("uninstall:" + name); }
};
class RootRepro {
public:
std::vector<PluginRepro*> plugins;
std::vector<std::string> log;
bool initialised = false;
void installPlugin(PluginRepro& p) {
p.install();
if (initialised) p.initialise();
}
void uninstallPlugin(PluginRepro& p) {
if (initialised) p.shutdown();
p.uninstall();
}
// 对应 Root 构造末尾:loadPlugins(pluginFileName)
void loadPlugins() {
for (auto p : plugins) installPlugin(*p);
}
// 对应 Root::oneTimePostWindowInit:窗口建好后 initialisePlugins
void oneTimePostWindowInit() {
initialised = true;
for (auto p : plugins) p->initialise();
}
// 对应 Root::shutdownPlugins:按安装逆序卸载
void shutdownPlugins() {
for (auto it = plugins.rbegin(); it != plugins.rend(); ++it)
uninstallPlugin(**it);
}
};
} // namespace ogre_repro
int main() {
using namespace ogre_repro;
RootRepro root;
PluginRepro rsys("RenderSystem", root.log);
PluginRepro octree("OctreeSceneManager", root.log);
root.plugins = {&rsys, &octree};
root.loadPlugins();
CHECK(root.log[0] == "install:RenderSystem");
CHECK(root.log[1] == "install:OctreeSceneManager");
// 窗口未建之前不会 initialise 任何插件
for (const auto& s : root.log)
CHECK(s.find("initialise:") == std::string::npos);
root.oneTimePostWindowInit();
CHECK(root.log[2] == "initialise:RenderSystem");
CHECK(root.log[3] == "initialise:OctreeSceneManager");
root.shutdownPlugins();
// 逆序:先 Octree 后 RenderSystem
CHECK(root.log[4] == "shutdown:OctreeSceneManager");
CHECK(root.log[5] == "uninstall:OctreeSceneManager");
CHECK(root.log[6] == "shutdown:RenderSystem");
CHECK(root.log[7] == "uninstall:RenderSystem");
return lab::report("03-3 插件系统:注册序");
}
本机实测(Apple clang 16,clang++ -std=c++20):编译通过,断言 10/10 通过。
小结
- 三段式注册序:构造期 install → 窗口建好后 initialise → 关停逆序 uninstall。
mIsInitialised/mFirstTimePostWindowInit两个标志保证「未初始化不重复跑」。- 卸载逆序,依赖方先离开,被依赖方后走。
- 插件时序是引擎可预测性的来源,晚注册插件由守卫自动补 initialise。
阅读导航:上一节:3.2 OgreDynLib 动态加载与解析 · 下一节:4.1 Vector 与 Quaternion 。
继续阅读
探索更多技术文章
浏览归档,发现更多关于系统设计、工具链和工程实践的内容。