Cocos引擎废弃API管理机制详解

Cocos引擎废弃API管理机制详解

cocos-engine Cocos simplifies game creation and distribution with Cocos Creator, a free, open-source, cross-platform game engine. Empowering millions of developers to create high-performance, engaging 2D/3D games and instant web entertainment. 项目地址: https://gitcode.com/gh_mirrors/co/cocos-engine

前言

在Cocos引擎的迭代过程中，随着功能的优化和架构的调整，部分API会逐渐被新的实现所取代。为了确保开发者能够平滑过渡，引擎提供了一套完善的废弃API管理机制。本文将深入解析这套机制的工作原理和使用方法。

废弃API管理机制概述

Cocos引擎通过三种核心函数来处理废弃API：

1. 标记警告(markAsWarning) - 对仍可使用的API添加警告提示
2. 属性移除(removeProperty) - 对已移除的API添加错误提示
3. 属性替换(replaceProperty) - 将旧API重定向到新API

核心函数详解

1. markAsWarning函数

markAsWarning(owner: object, ownerName: string, properties: IMarkItem[])

适用场景：当某个API仍可使用但即将被废弃时使用。

参数说明：

• owner: 包含该API的对象
• ownerName: 对象名称(用于错误提示)
• properties: 废弃属性配置数组

效果：开发者使用该API时会收到警告提示，但功能仍可正常使用。

2. removeProperty函数

removeProperty(owner: object, ownerName: string, properties: IRemoveItem[])

适用场景：当某个API已被完全移除时使用。

效果：开发者使用该API时会收到错误提示，且功能不可用。

3. replaceProperty函数

replaceProperty(owner: object, ownerName: string, properties: IReplacement[])

适用场景：当某个API已被新API替代时使用。

特殊功能：

• 支持参数适配转换
• 支持自定义getter/setter
• 支持跨对象重定向

配置项说明

三种函数都接收相似的配置项，主要包含以下字段：

| 字段名 | 类型 | 说明 | |-------|------|------| | name | string | 废弃属性名称 | | logTimes | number | 警告/错误显示次数 | | suggest | string | 替代建议文本 | | newName | string | 新属性名称(仅replaceProperty) | | target | object | 新属性所在对象(仅replaceProperty) | | customFunction | Function | 自定义转换函数(仅replaceProperty) |

模块导出名称废弃

自3.6.0版本起，引擎支持对模块导出名称进行废弃标记：

deprecateModuleExportedName({
    OldComponent: {
        newName: 'NewComponent', // 新名称
        since: '1.2.0',         // 废弃起始版本
        removed: false,         // 是否已移除
    },
});

触发场景：

• 直接导入废弃名称
• 通过命名空间访问废弃名称

最佳实践指南

1. 版本过渡策略：

   • 先使用markAsWarning标记为警告
   • 经过1-2个版本后改为replaceProperty
   • 最终版本使用removeProperty

2. 参数适配技巧：

   replaceProperty(MyClass.prototype, 'MyClass.prototype', [
       {
           name: 'oldMethod',
           customFunction: function(...args) {
               // 参数转换逻辑
               const newArgs = convertArgs(args);
               return NewMethod.apply(this, newArgs);
           }
       }
   ]);
   

3. 日志控制建议：

   • 在模块初始化时调用setDefaultLogTimes设置全局默认显示次数
   • 对关键API可单独设置logTimes

常见问题解答

Q: 如何处理类成员函数的废弃？

A: 需要传入类的prototype对象，例如：

markAsWarning(MyClass.prototype, 'MyClass.prototype', [...]);

Q: 如何实现跨对象的API重定向？

A: 使用replaceProperty的target参数：

replaceProperty(obj1, 'obj1', [
    {
        name: 'oldProp',
        target: obj2,
        targetName: 'obj2'
    }
]);

Q: 自定义函数中this指向问题如何解决？

A: 使用Function.prototype.call或apply明确指定this：

customFunction: function() {
    return NewMethod.call(this, ...arguments);
}

结语

Cocos引擎的废弃API管理机制为开发者提供了平滑过渡的保障，合理使用这些工具可以显著提升引擎升级的体验。建议开发者在维护自己的扩展模块时也采用相似的机制，为用户提供更好的兼容性支持。

cocos-engine Cocos simplifies game creation and distribution with Cocos Creator, a free, open-source, cross-platform game engine. Empowering millions of developers to create high-performance, engaging 2D/3D games and instant web entertainment. 项目地址: https://gitcode.com/gh_mirrors/co/cocos-engine