@ohos.events.emitter (Emitter)提供同一进程不同线程间或同一线程内发送和处理事件的能力,在.on()方法使用完毕后,需及时调用对应的.off()方法注销监听,避免导致内存泄漏。
调用.on()监听接口后,只要存在对应的.off()调用(即取消全部或部分监听),不产生告警;仅当代码中不存在任何.off()调用时,才产生告警。
// rules.json
{
"rules": {
"arkts": {
"ResourceLeak": [
{
"ruleId": "EmitterListenerNotOff",
"severity": "error",
"skip": false
}
]
}
}
} import { Callback, emitter } from '@kit.BasicServicesKit';
import UIAbility from '@ohos.app.ability.UIAbility';
@Sendable
class Sample {
constructor() {
this.count = 100;
}
printCount() {
console.info('Print count : ' + this.count);
}
count: number;
}
/**
* 正例:正确释放资源
*/
export default class TestRelease extends UIAbility {
private eventIdInstanceField = 'eventIdInstanceField';
private emitterIdCallBack: Callback<emitter.GenericEventData<Sample>> = (eventData: emitter.GenericEventData<Sample>): void => {
console.info(`eventData: ${JSON.stringify(eventData?.data)}`);
if (eventData?.data instanceof Sample) {
eventData?.data?.printCount();
}
}
onCreate(): void {
emitter.on(this.eventIdInstanceField, this.emitterIdCallBack);
emitter.on({ eventId: 2 }, () => {});
this.registerWithId('eventIdParam');
}
onDestroy(): void {
emitter.off(this.eventIdInstanceField, this.emitterIdCallBack);
emitter.off(2);
this.unregisterWithId('eventIdParam');
}
registerWithId(eventId: string) {
emitter.on(eventId, this.emitterIdCallBack);
}
unregisterWithId(eventId: string) {
emitter.off(eventId, this.emitterIdCallBack);
}
} import { Callback, emitter } from '@kit.BasicServicesKit';
import UIAbility from '@ohos.app.ability.UIAbility';
@Sendable
class Sample {
constructor() {
this.count = 100;
}
printCount() {
console.info('Print count : ' + this.count);
}
count: number;
}
/**
* 反例:未释放资源
*/
export class TestNotRelease extends UIAbility {
private eventIdInstanceField = 'eventIdInstanceField';
private emitterIdCallBack: Callback<emitter.GenericEventData<Sample>> = (eventData: emitter.GenericEventData<Sample>): void => {
console.info(`eventData: ${JSON.stringify(eventData?.data)}`);
if (eventData?.data instanceof Sample) {
eventData?.data?.printCount();
}
}
onCreate(): void {
emitter.on(this.eventIdInstanceField, this.emitterIdCallBack); // leak
emitter.on({ eventId: 4 }, () => {}); // leak
this.registerWithId('eventIdParam');
}
registerWithId(eventId: string) {
emitter.on(eventId, this.emitterIdCallBack); // leak
}
unregisterWithId(eventId: string) {
emitter.off(eventId, this.emitterIdCallBack);
}
} Code Scanner代码检查规则的配置指导请参考1.6.3 代码检查工具(codescanner)