通过commonEventManager.subscribe()方法注册的CommonEventSubscriber对象,需要在取消订阅后将其置为null或undefined进行释放,避免导致内存泄漏。
// rules.json
{
"rules": {
"arkts": {
"ResourceLeak": [
{
"ruleId": "CommonEventSubscriberNotSetNull",
"severity": "error",
"skip": false
}
]
}
}
} import { BusinessError } from '@kit.BasicServicesKit';
import { commonEventManager } from '@kit.BasicServicesKit';
import UIAbility from '@ohos.app.ability.UIAbility';
import { window } from '@kit.ArkUI';
/**
* 正例:正确置空
*/
export default class TestRelease extends UIAbility {
private subscriber: commonEventManager.CommonEventSubscriber | null = null;
private subscribeInfo: commonEventManager.CommonEventSubscribeInfo = { events: ['event'] };
onWindowStageCreate(windowStage: window.WindowStage): void {
try {
commonEventManager.createSubscriber(this.subscribeInfo,
(err: BusinessError, commonEventSubscriber: commonEventManager.CommonEventSubscriber) => {
if(!err) {
console.info(`Succeeded in creating subscriber.`);
this.subscriber = commonEventSubscriber;
try {
commonEventManager.subscribe(commonEventSubscriber, (err: BusinessError, data: commonEventManager.CommonEventData) => {
if (err) {
console.error(`Failed to subscribe. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info(`Succeeded in subscribing, data is ${JSON.stringify(data)}`);
});
} catch (error) {
let err: BusinessError = error as BusinessError;
console.error(`Failed to subscribe. Code is ${err.code}, message is ${err.message}`);
}
return;
}
console.error(`Failed to create subscriber. Code is ${err.code}, message is ${err.message}`);
});
} catch (error) {
let err: BusinessError = error as BusinessError;
console.error(`Failed to create subscriber. Code is ${err.code}, message is ${err.message}`);
}
}
onWindowStageDestroy(): void {
setTimeout(() => {
try {
commonEventManager.unsubscribe(this.subscriber, (err: BusinessError) => {
if (err) {
console.error(`Failed to unsubscribe. Code is ${err.code}, message is ${err.message}`);
return;
}
// subscriber不再使用时需要将其置为null,避免内存泄露
this.subscriber = null;
console.info(`Succeeded in unsubscribing.`);
});
} catch (error) {
let err: BusinessError = error as BusinessError;
console.error(`Failed to unsubscribe. Code is ${err.code}, message is ${err.message}`);
}
}, 500);
}
} import { BusinessError } from '@kit.BasicServicesKit';
import { commonEventManager } from '@kit.BasicServicesKit';
import UIAbility from '@ohos.app.ability.UIAbility';
import { window } from '@kit.ArkUI';
/**
* 反例:释放资源后未置空
*/
export class TestNotSetNull extends UIAbility {
private subscriber: commonEventManager.CommonEventSubscriber | null = null;
private subscribeInfo: commonEventManager.CommonEventSubscribeInfo = { events: ['event'] };
onWindowStageCreate(windowStage: window.WindowStage): void {
try {
commonEventManager.createSubscriber(this.subscribeInfo,
(err: BusinessError, commonEventSubscriber: commonEventManager.CommonEventSubscriber) => {
if(!err) {
console.info(`Succeeded in creating subscriber.`);
this.subscriber = commonEventSubscriber;
try {
commonEventManager.subscribe(commonEventSubscriber, (err: BusinessError, data: commonEventManager.CommonEventData) => {
if (err) {
console.error(`Failed to subscribe. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info(`Succeeded in subscribing, data is ${JSON.stringify(data)}`);
});
} catch (error) {
let err: BusinessError = error as BusinessError;
console.error(`Failed to subscribe. Code is ${err.code}, message is ${err.message}`);
}
return;
}
console.error(`Failed to create subscriber. Code is ${err.code}, message is ${err.message}`);
});
} catch (error) {
let err: BusinessError = error as BusinessError;
console.error(`Failed to create subscriber. Code is ${err.code}, message is ${err.message}`);
}
}
onWindowStageDestroy(): void {
setTimeout(() => {
try {
commonEventManager.unsubscribe(this.subscriber, (err: BusinessError) => {
if (err) {
console.error(`Failed to unsubscribe. Code is ${err.code}, message is ${err.message}`);
return;
}
console.info(`Succeeded in unsubscribing.`);
});
} catch (error) {
let err: BusinessError = error as BusinessError;
console.error(`Failed to unsubscribe. Code is ${err.code}, message is ${err.message}`);
}
}, 500);
}
} Code Scanner代码检查规则的配置指导请参考1.6.3 代码检查工具(codescanner)