想要实现仅从外部初始化一次且不接受后续同步变化的能力,可以使用@Once装饰器搭配@Param装饰器。
阅读本文档前,请先阅读@Param。
从API version 12开始,在@ComponentV2装饰的自定义组件中支持使用@Once装饰器。
从API version 12开始,该装饰器支持在元服务中使用。
从API version 23开始,该装饰器支持在ArkTS卡片中使用。
@Once装饰器在变量初始化时接受外部传入值进行初始化,后续数据源更改不会同步给子组件:
@Once仅在@ComponentV2装饰的自定义组件中与@Param搭配使用。
@ComponentV2
struct MyComponent {
@Param @Once onceParam: string = 'onceParam'; // 正确用法
// ...
} @Once与@Param的先后顺序无关,可以写成@Param @Once也可以写成@Once @Param。
@ComponentV2
struct MyComponent {
// ···
@Param @Once param1: number = 0;
@Once @Param param2: number = 0;
// ···
} @Once用于期望变量仅初始化同步数据源一次,之后不再继续同步变化的场景。
@ComponentV2
struct ChildComponent {
// @Once装饰的onceParam仅初始化同步一次
@Param @Once onceParam: string = '';
build() {
Column() {
Text(`onceParam: ${this.onceParam}`)
.fontSize(20)
.margin(10)
}
.width('100%')
}
}
@Entry
@ComponentV2
struct MyComponent {
// ...
@Local message: string = 'Hello World';
build() {
Column() {
Text(`Parent message: ${this.message}`)
.fontSize(20)
.margin(10)
Button('change message')
.width(300)
.margin(10)
.onClick(() => {
this.message = 'Hello Tomorrow';
})
ChildComponent({ onceParam: this.message })
}
.width('100%')
}
} 
当@Once与@Param结合使用时,可以解除@Param无法在本地修改的限制,并能够触发UI刷新。此时,使用@Param和@Once的效果类似于@Local,但@Param和@Once还能接收外部传入的初始值。
@ObservedV2
class Info {
@Trace name: string;
constructor(name: string) {
this.name = name;
}
}
@ComponentV2
struct Child {
// @Once与@Param结合使用时,可以在本地修改,并能够触发UI刷新
@Param @Once onceParamNum: number = 0;
@Param @Once @Require onceParamInfo: Info;
build() {
Column() {
Text(`Child onceParamNum: ${this.onceParamNum}`)
.fontSize(20)
.margin(10)
Text(`Child onceParamInfo: ${this.onceParamInfo.name}`)
.fontSize(20)
.margin(10)
Button('changeOnceParamNum')
.width(300)
.margin(10)
.onClick(() => {
this.onceParamNum++;
})
Button('changeParamInfo')
.width(300)
.margin(10)
.onClick(() => {
this.onceParamInfo = new Info('Cindy');
})
}
.width('100%')
}
}
@Entry
@ComponentV2
struct Index {
@Local localNum: number = 10;
@Local localInfo: Info = new Info('Tom');
build() {
Column() {
Text(`Parent localNum: ${this.localNum}`)
.fontSize(20)
.margin(10)
Text(`Parent localInfo: ${this.localInfo.name}`)
.fontSize(20)
.margin(10)
Button('changeLocalNum')
.width(300)
.margin(10)
.onClick(() => {
this.localNum++;
})
Button('changeLocalInfo')
.width(300)
.margin(10)
.onClick(() => {
this.localInfo = new Info('Cindy');
})
Child({
onceParamNum: this.localNum,
onceParamInfo: this.localInfo
})
}
.width('100%')
}
} 