lywsvip/oops-plugin-framework
1
0
Fork 0
mirror of https://gitee.com/dgflash/oops-plugin-framework.git synced 2026-05-09 22:02:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix(GameComponent): 修复资源加载相关的安全问题和内存泄漏

Browse Source 
## 问题修复
- setButton: 修复组件名不匹配格式时正则匹配崩溃
- createPrefabNode: 修复预制体加载失败时崩溃，返回类型改为 Promise<Node | null>
- load: 修复资源加载失败时引用计数未移除
- loadAny: 修复加载失败时引用计数未移除
- loadDir: 修复加载失败时引用计数未移除
- playEffect: 修复返回值 null! 非空断言，改为 Promise<AudioEffect | null>
- setSprite: 优化失败处理逻辑，返回 boolean

## 新增功能
- loadDirAsync: Promise 模式的文件夹资源加载
- removePathFromRecord: 私有方法，用于加载失败时回滚引用计数

## 代码优化
- loadAny/loadDir: 使用强类型回调参数
- loadAny: 使用对象数组替代字符串拼接解析
This commit is contained in:
dgflash
2026-04-05 12:22:28 +08:00
parent 5a43c3d08e
commit 0746948455
1 changed files with 103 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

136
assets/module/common/GameComponent.ts
View File

@@ -182,14 +182,16 @@ export class GameComponent extends Component {
/**
* 从资源缓存中找到预制资源名并创建一个显示对象
* @param path 资源路径
* @param bundleName 资源包名
* @returns 预制节点，加载失败返回 null
*/
createPrefabNode(path: string, bundleName: string = oops.res.defaultBundleName): Promise<Node> {
return new Promise((resolve) => {
this.load(bundleName, path, Prefab).then((prefab) => {
const node = instantiate(prefab);
resolve(node);
});
});
async createPrefabNode(path: string, bundleName: string = oops.res.defaultBundleName): Promise<Node | null> {
const prefab = await this.load(bundleName, path, Prefab);
if (!prefab) {
console.warn('[OopsFramework]', `预制体加载失败: ${path}`);
return null;
}
return instantiate(prefab);
}
//#endregion
@@ -257,6 +259,28 @@ export class GameComponent extends Component {
return key;
}
/**
* 移除资源使用记录（用于加载失败时回滚）
* @param type 资源类型
* @param bundleName 资源包名
* @param paths 资源路径
*/
private removePathFromRecord(type: ResType, bundleName: string, path: string): void {
if (!this.resPaths) return;
const rps = this.resPaths.get(type);
if (!rps) return;
const key = this.getResKey(bundleName, path);
const record = rps.get(key);
if (record) {
record.refCount--;
if (record.refCount <= 0) {
rps.delete(key);
}
}
}
/**
* 加载一个资源
* @param bundleName 远程包名
@@ -264,38 +288,71 @@ export class GameComponent extends Component {
* @param type 资源类型
* @param onProgress 加载进度回调
*/
load<T extends Asset>(bundleName: string, paths: Paths | AssetType<T>, type?: AssetType<T>): Promise<T> {
async load<T extends Asset>(bundleName: string, paths: Paths | AssetType<T>, type?: AssetType<T>): Promise<T> {
let realBundle: string;
let realPath: string;
if (typeof paths === 'string') {
realBundle = bundleName;
realPath = paths;
}
else {
realBundle = oops.res.defaultBundleName;
realPath = bundleName;
}
this.addPathToRecord(ResType.Load, bundleName, paths);
return oops.res.load(bundleName, paths, type);
try {
const result = await oops.res.load(bundleName, paths, type);
if (!result) {
this.removePathFromRecord(ResType.Load, realBundle, realPath);
}
return result;
}
catch (error) {
this.removePathFromRecord(ResType.Load, realBundle, realPath);
throw error;
}
}
/**
* 加载指定资源包中的多个任意类型资源
* 加载指定资源包中的多个任意类型资源（回调模式）
* @param bundleName 远程包名或资源路径数组
* @param paths 资源路径数组或进度回调
* @param onProgress 加载进度回调
* @param onComplete 加载完成回调
*/
loadAny(bundleName: string | string[], paths: string[] | ProgressCallback, onProgress?: ProgressCallback | CompleteCallback, onComplete?: CompleteCallback): void {
// 处理资源记录
const originalComplete = onComplete as ((err: Error | null, data: Asset[]) => void) | undefined;
const pathsToTrack: { bundle: string; path: string }[] = [];
if (typeof bundleName === 'string' && Array.isArray(paths)) {
// 标准调用：loadAny(bundleName, paths, ...)
this.addPathToRecord(ResType.Load, bundleName, paths);
pathsToTrack.push(...paths.map(p => ({ bundle: bundleName, path: p })));
}
else if (Array.isArray(bundleName)) {
// bundleName 是路径数组：loadAny(paths, onProgress, onComplete)
this.addPathToRecord(ResType.Load, resLoader.defaultBundleName, bundleName);
pathsToTrack.push(...bundleName.map(p => ({ bundle: resLoader.defaultBundleName, path: p })));
}
else if (typeof bundleName === 'string' && typeof paths === 'function') {
// 单个路径：loadAny(path, onProgress, onComplete)
this.addPathToRecord(ResType.Load, resLoader.defaultBundleName, bundleName);
pathsToTrack.push({ bundle: resLoader.defaultBundleName, path: bundleName });
}
oops.res.loadAny(bundleName, paths, onProgress, onComplete);
const wrappedComplete = (err: Error | null, data: Asset[]) => {
if (err || !data) {
pathsToTrack.forEach(({ bundle, path }) => {
this.removePathFromRecord(ResType.Load, bundle, path);
});
}
originalComplete?.(err, data);
};
oops.res.loadAny(bundleName, paths, onProgress, wrappedComplete);
}
/**
* 加载文件夹中的资源
* 加载文件夹中的资源（回调模式）
* @param bundleName 远程包名
* @param dir 文件夹名
* @param type 资源类型
@@ -329,7 +386,16 @@ export class GameComponent extends Component {
}
this.addPathToRecord(ResType.LoadDir, realBundle, realDir);
oops.res.loadDir(bundleName, dir, type, onProgress, onComplete);
const originalComplete = onComplete as ((err: Error | null, data: T[]) => void) | undefined;
const wrappedComplete = (err: Error | null, data: T[]) => {
if (err || !data) {
this.removePathFromRecord(ResType.LoadDir, realBundle, realDir);
}
originalComplete?.(err, data);
};
oops.res.loadDir(bundleName, dir, type, onProgress, wrappedComplete);
}
/**
@@ -471,20 +537,20 @@ export class GameComponent extends Component {
* @param target 目标精灵对象
* @param path 图片资源地址
* @param bundle 资源包名
* @remarks 资源引用计数由 load 方法自动管理，组件销毁时会自动释放
* @returns 是否设置成功
* @remarks 资源引用计数由 load 方法自动管理，加载失败时会自动回滚
*/
async setSprite(target: Sprite, path: string, bundle: string = resLoader.defaultBundleName) {
async setSprite(target: Sprite, path: string, bundle: string = resLoader.defaultBundleName): Promise<boolean> {
const spriteFrame = await this.load(bundle, path, SpriteFrame);
if (!spriteFrame || !isValid(target)) {
// 使用 releaseRes 正确处理引用计数，避免直接操作 resPaths
this.releaseRes(path, bundle);
return;
if (!spriteFrame) {
return false;
}
if (!isValid(target)) {
this.releaseRes(path, bundle);
return false;
}
// 直接设置 spriteFrame，不需要手动 addRef
// load 方法已经通过 addPathToRecord 管理了引用计数
// 手动 addRef 会导致双重引用，造成内存泄漏
target.spriteFrame = spriteFrame;
return true;
}
//#endregion
@@ -502,11 +568,11 @@ export class GameComponent extends Component {
* 播放音效
* @param url 资源地址
* @param params 音效播放参数
* @returns 音效实例，播放失败返回 null
* @remarks 注意：音效资源由 AudioEffectPool 自动管理，不需要在此组件中记录
*/
playEffect(url: string, params?: IAudioParams): Promise<AudioEffect> {
playEffect(url: string, params?: IAudioParams): Promise<AudioEffect | null> {
return new Promise((resolve) => {
// 确保参数中有 bundle 信息
if (params == null) {
params = { bundle: resLoader.defaultBundleName };
}
@@ -514,10 +580,8 @@ export class GameComponent extends Component {
params.bundle = resLoader.defaultBundleName;
}
// AudioEffectPool 已经管理了音效资源的加载和释放
// 不需要在此处通过 addPathToRecord 记录，避免双重管理导致过度释放
oops.audio.playEffect(url, params).then((ae) => {
resolve(ae || null!);
resolve(ae ?? null);
});
});
}
@@ -554,6 +618,12 @@ export class GameComponent extends Component {
// Cocos Creator Button组件批量绑定触摸事件（使用UIButton支持放连点功能）
const regex = /<([^>]+)>/;
const match = this.name.match(regex);
if (!match || !match[1]) {
console.warn('[OopsFramework]', `组件名 "${this.name}" 不符合 "<组件名>" 格式，跳过按钮事件绑定`);
return;
}
const componentName = match[1];
const buttons = this.node.getComponentsInChildren<Button>(Button);
buttons.forEach((b: Button) => {
const node = b.node;
@@ -563,7 +633,7 @@ export class GameComponent extends Component {
const event = new EventHandler();
event.target = this.node;
event.handler = b.node.name;
event.component = this.name.match(regex)![1];
event.component = componentName;
b.clickEvents.push(event);
}
// else {