# \@Once：初始化同步一次


为了实现仅从外部初始化一次、不接受后续同步变化的能力，开发者可以使用\@Once装饰器搭配\@Param装饰器使用。


在阅读本文档前，建议提前阅读：[\@Param](./arkts-new-param.md)。

> **说明：**
>
> 从API version 12开始，在\@ComponentV2装饰的自定义组件中支持使用\@Once装饰器。
>

## 概述

\@Once装饰器仅在变量初始化时接受外部传入值进行初始化，当后续数据源更改时，不会将修改同步给子组件：

- \@Once必须搭配\@Param使用，单独使用或搭配其他装饰器使用都是不允许的。
- \@Once不影响\@Param的观测能力，仅针对数据源的变化做拦截。
- \@Once与\@Param装饰变量的先后顺序不影响实际功能。
- \@Once与\@Param搭配使用时，可以在本地修改\@Param变量的值。

## 装饰器使用规则说明

\@Once装饰器作为辅助装饰器，本身没有对装饰类型的要求以及对变量的观察能力。

| \@Once变量装饰器 | 说明                                      |
| ---------------- | ----------------------------------------- |
| 装饰器参数       | 无。                                      |
| 使用条件         | 无法单独使用，必须配合\@Param装饰器使用。 |


## 限制条件

- \@Once只能用在\@ComponentV2装饰的自定义组件中且仅能与\@Param搭配使用。

  ```ts
  @ComponentV2
  struct MyComponent {
    @Param @Once onceParam: string = "onceParam"; // 正确用法
    @Once onceStr: string = "Once"; // 错误用法，@Once无法单独使用
    @Local @Once onceLocal: string = "onceLocal"; // 错误用法，@Once不能与@Local一起使用
  }
  @Component
  struct Index {
    @Once @Param onceParam: string = "onceParam"; // 错误用法
  }
  ```

- \@Once与\@Param的先后顺序无关，可以写成\@Param \@Once也可以写成\@Once \@Param。

  ```ts
  @ComponentV2
  struct MyComponent {
    @Param @Once param1: number;
    @Once @Param param2: number;
  }
  ```

## 使用场景

### 变量仅初始化同步一次

\@Once使用在期望变量仅初始化时同步数据源一次，之后不再继续同步变化的场景。

```ts
@ComponentV2
struct ChildComponent {
  @Param @Once onceParam: string = "";
  build() {
  	Column() {
  	  Text(`onceParam: ${this.onceParam}`)
  	}
  }
}
@Entry
@ComponentV2
struct MyComponent {
  @Local message: string = "Hello World";
  build() {
  	Column() {
      Text(`Parent message: ${this.message}`)
      Button("change message")
        .onClick(() => {
          this.message = "Hello Tomorrow";
        })
      ChildComponent({ onceParam: this.message })
  	}
  }
}
```

### 本地修改\@Param变量

当\@Once搭配\@Param使用时，可以解除\@Param无法在本地修改的限制，且修改能够触发UI刷新。此时，使用\@Param \@Once相当于使用\@Local，区别在于\@Param \@Once能够接受外部传入初始化。

```ts
@ObservedV2
class Info {
  @Trace name: string;
  constructor(name: string) {
    this.name = name;
  }
}
@ComponentV2
struct Child {
  @Param @Once onceParamNum: number = 0;
  @Param @Once @Require onceParamInfo: Info;

  build() {
    Column() {
      Text(`Child onceParamNum: ${this.onceParamNum}`)
      Text(`Child onceParamInfo: ${this.onceParamInfo.name}`)
      Button("changeOnceParamNum")
        .onClick(() => {
          this.onceParamNum++;
        })
      Button("changeParamInfo")
        .onClick(() => {
          this.onceParamInfo = new Info("Cindy");
        })
    }
  }
}
@Entry
@ComponentV2
struct Index {
  @Local localNum: number = 10;
  @Local localInfo: Info = new Info("Tom");

  build() {
    Column() {
      Text(`Parent localNum: ${this.localNum}`)
      Text(`Parent localInfo: ${this.localInfo.name}`)
      Button("changeLocalNum")
        .onClick(() => {
          this.localNum++;
        })
      Button("changeLocalInfo")
        .onClick(() => {
          this.localInfo = new Info("Cindy");
        })
      Child({
        onceParamNum: this.localNum,
        onceParamInfo: this.localInfo
      })
    }
  }
}
```