Cocos Creator 3.8.4版本中编辑器环境下事件监听顺序问题解析

问题背景

在Cocos Creator游戏开发中，开发者经常需要在项目初始化阶段执行一些预加载操作。一个常见的做法是通过game.onPostProjectInitDelegate事件监听器来确保资源在脚本onLoad之前完成加载。然而，在3.8.4版本中，开发者发现这种机制在编辑器环境和运行环境之间存在不一致的行为。

问题现象

当开发者使用以下代码模式时：

import { game } from "cc";

class SetupConfig {
    initialize(resolve) {
        console.log("setupConfig initialize");
        resolve();
    }
}

const setupConfig = new SetupConfig();
game.onPostProjectInitDelegate.add(() => 
    new Promise(resolve => setupConfig.initialize(resolve))
);

在浏览器和发布后的环境中能够正常执行，打印出预期的日志信息。但在Cocos Creator编辑器环境下，这段代码却不会执行，导致初始化逻辑失效。

根本原因分析

经过深入分析，这个问题源于Cocos Creator编辑器环境和运行环境在脚本加载时机上的差异：

1. 运行环境(浏览器/发布版本)：

   • 先加载用户脚本
   • 然后触发game的初始化事件
   • 事件监听器能够正常捕获到事件

2. 编辑器环境：

   • 先进行game的初始化
   • 然后才加载用户脚本
   • 当脚本加载时，初始化事件已经触发完毕
   • 导致事件监听器无法捕获到已经触发的事件

这种时序差异使得依赖初始化事件执行的代码在编辑器环境下失效，给开发调试带来了不便。

解决方案

Cocos官方在3.8.6版本中修复了这个问题。修复后的版本确保了无论在编辑器环境还是运行环境，事件触发和脚本加载的顺序都保持一致。

对于仍在使用3.8.4版本的开发者，可以考虑以下临时解决方案：

1. 环境判断法：

if (EDITOR) {
    // 编辑器环境下的特殊处理
    setupConfig.initialize(() => {});
} else {
    // 正常环境下的处理
    game.onPostProjectInitDelegate.add(() => 
        new Promise(resolve => setupConfig.initialize(resolve))
    );
}

2. 延迟检查法：

function tryInitialize() {
    if (game.isInitialized) {
        setupConfig.initialize(() => {});
    } else {
        game.onPostProjectInitDelegate.add(() => 
            new Promise(resolve => setupConfig.initialize(resolve))
        );
    }
}

tryInitialize();

最佳实践建议

1. 对于关键初始化逻辑，建议升级到3.8.6或更高版本
2. 如果必须使用旧版本，建议添加环境检测逻辑
3. 重要的初始化操作最好有备用的触发机制
4. 在编辑器环境下测试时要特别注意这类时序相关问题

总结

这个案例展示了游戏引擎在不同环境下可能存在的微妙差异，特别是在初始化和脚本加载顺序方面。开发者需要意识到这些潜在差异，并在设计初始化流程时考虑环境兼容性。Cocos团队对此问题的快速响应也体现了对开发者体验的重视，建议开发者及时更新到修复版本以获得最佳开发体验。