一、概述
@Track是class对象的属性装饰器。当class对象是状态变量时,@Track装饰的属性发生变化,只会触发该属性关联的UI更新;未被标记的属性不能在UI中使用。从API version 11开始,该装饰器支持在ArkTS卡片中使用。
二、装饰器说明
- 装饰器参数:无。
- 可装饰的变量:class对象的非静态成员属性。
三、观察变化和行为表现
当class对象是状态变量时,@Track装饰的属性变化,该属性关联的UI触发更新。当class对象中没有属性被标记@Track,行为与原先保持不变。@Track没有深度观测功能,使用它可避免冗余刷新。
示例
以下示例展示了@Track装饰器的使用及效果。
class LogTrack {
@Track str1: string;
@Track str2: string;
constructor(str1: string ) {
this.str1 = str1;
this.str2 = 'World';
}
}
class LogNotTrack {
str1: string;
str2: string;
constructor(str1: string ) {
this.str1 = str1;
this.str2 = '世界';
}
}
@Entry
@Component
struct AddLog {
@State logTrack: LogTrack = new LogTrack('Hello');
@State logNotTrack: LogNotTrack = new LogNotTrack('你好');
isRender(index: number) {
console.log(`Text ${index} is rendered`);
return 50;
}
build() {
Row() {
Column() {
Text(this.logTrack.str1) // UINode1
.fontSize(this.isRender(1))
.fontWeight(FontWeight.Bold)
Text(this.logTrack.str2) // UINode2
.fontSize(this.isRender(2))
.fontWeight(FontWeight.Bold)
Button('change logTrack.str1')
.onClick(() => {
this.logTrack.str1 = 'Bye';
})
Text(this.logNotTrack.str1) // UINode3
.fontSize(this.isRender(3))
.fontWeight(FontWeight.Bold)
Text(this.logNotTrack.str2) // UINode4
.fontSize(this.isRender(4))
.fontWeight(FontWeight.Bold)
Button('change logNotTrack.str1')
.onClick(() => {
this.logNotTrack.str1 = '再见';
})
}
.width('100%')
}
.height('100%')
}
}
在上述示例中:
- 类LogTrack中的属性均被@Track装饰。点击按钮“change logTrack.str1”,UINode1刷新,UINode2不刷新,只有一条日志输出,避免了冗余刷新。
- 类LogNotTrack中的属性均未被@Track装饰。点击按钮“change logNotTrack.str1”,UINode3、UINode4均会刷新,有两条日志输出,存在冗余刷新。
四、限制条件
- 不能在UI中使用非@Track装饰的属性,包括不能绑定在组件上、不能用于初始化子组件,错误使用将导致JSCrash;可在非UI中使用,如事件回调函数、生命周期函数中。
- 建议开发者不要混用包含@Track的class对象和不包含@Track的class对象,如联合类型、类继承中等。
五、使用场景
@Track和自定义组件更新
以下示例展示组件更新和@Track的处理步骤。
class Log {
@Track logInfo: string;
owner: string;
id: number;
time: Date;
location: string;
reason: string;
constructor(logInfo: string ) {
this.logInfo = logInfo;
this.owner = 'OH';
this.id = 0;
this.time = new Date();
this.location = 'CN';
this.reason = 'NULL';
}
}
@Entry
@Component
struct AddLog {
@State log: Log = new Log('origin info.');
build() {
Row() {
Column() {
Text(this.log.logInfo)
.fontSize(50)
.fontWeight(FontWeight.Bold)
.onClick(() => {
// 非@Track属性可在事件处理函数中使用
console.log('owner: ' + this.log.owner +
' id: ' + this.log.id +
' time: ' + this.log.time +
' location: ' + this.log.location +
' reason: ' + this.log.reason);
this.log.time = new Date();
this.log.id++;
this.log.logInfo += ' info.';
})
}
.width('100%')
}
.height('100%')
}
}
处理步骤:
- AddLog自定义组件的Text.onClick点击事件自增字符串’ info.’。
- 由于@State log变量的@Track属性logInfo更改,Text重新渲染。