@Link裝飾器:父子雙向同步

2024-01-25 12:04 更新

子組件中被@Link裝飾的變量與其父組件中對應(yīng)的數(shù)據(jù)源建立雙向數(shù)據(jù)綁定。

說明

從API version 9開始,該裝飾器支持在ArkTS卡片中使用。

概述

@Link裝飾的變量與其父組件中的數(shù)據(jù)源共享相同的值。

限制條件

@Link裝飾器不能在@Entry裝飾的自定義組件中使用。

裝飾器使用規(guī)則說明

@Link變量裝飾器

說明

裝飾器參數(shù)

同步類型

雙向同步。

父組件中@State, @StorageLink和@Link 和子組件@Link可以建立雙向數(shù)據(jù)同步,反之亦然。

允許裝飾的變量類型

Object、class、string、number、boolean、enum類型,以及這些類型的數(shù)組。嵌套類型的場景請參考觀察變化。

類型必須被指定,且和雙向綁定狀態(tài)變量的類型相同。

不支持any,不支持簡單類型和復(fù)雜類型的聯(lián)合類型,不允許使用undefined和null。

說明

不支持Length、ResourceStr、ResourceColor類型,Length、ResourceStr、ResourceColor為簡單類型和復(fù)雜類型的聯(lián)合類型。

被裝飾變量的初始值

無,禁止本地初始化。

變量的傳遞/訪問規(guī)則說明

傳遞/訪問

說明

從父組件初始化和更新

必選。與父組件@State, @StorageLink和@Link 建立雙向綁定。允許父組件中@State、@Link、@Prop、@Provide、@Consume、@ObjectLink、@StorageLink、@StorageProp、@LocalStorageLink和@LocalStorageProp裝飾變量初始化子組件@Link。

從API version 9開始,@Link子組件從父組件初始化@State的語法為Comp({ aLink: this.aState })。同樣Comp({aLink: $aState})也支持。

用于初始化子組件

允許,可用于初始化常規(guī)變量、@State、@Link、@Prop、@Provide。

是否支持組件外訪問

私有,只能在所屬組件內(nèi)訪問。

圖1 初始化規(guī)則圖示

觀察變化和行為表現(xiàn)

觀察變化

  • 當裝飾的數(shù)據(jù)類型為boolean、string、number類型時,可以同步觀察到數(shù)值的變化,示例請參考簡單類型和類對象類型的@Link。
  • 當裝飾的數(shù)據(jù)類型為class或者Object時,可以觀察到賦值和屬性賦值的變化,即Object.keys(observedObject)返回的所有屬性,示例請參考簡單類型和類對象類型的@Link
  • 當裝飾的對象是array時,可以觀察到數(shù)組添加、刪除、更新數(shù)組單元的變化,示例請參考數(shù)組類型的@Link。

框架行為

@Link裝飾的變量和其所屬的自定義組件共享生命周期。

為了了解@Link變量初始化和更新機制,有必要先了解父組件和擁有@Link變量的子組件的關(guān)系,初始渲染和雙向更新的流程(以父組件為@State為例)。

  1. 初始渲染:執(zhí)行父組件的build()函數(shù)后將創(chuàng)建子組件的新實例。初始化過程如下:
    1. 必須指定父組件中的@State變量,用于初始化子組件的@Link變量。子組件的@Link變量值與其父組件的數(shù)據(jù)源變量保持同步(雙向數(shù)據(jù)同步)。
    2. 父組件的@State狀態(tài)變量包裝類通過構(gòu)造函數(shù)傳給子組件,子組件的@Link包裝類拿到父組件的@State的狀態(tài)變量后,將當前@Link包裝類this指針注冊給父組件的@State變量。
  2. @Link的數(shù)據(jù)源的更新:即父組件中狀態(tài)變量更新,引起相關(guān)子組件的@Link的更新。處理步驟:
    1. 通過初始渲染的步驟可知,子組件@Link包裝類把當前this指針注冊給父組件。父組件@State變量變更后,會遍歷更新所有依賴它的系統(tǒng)組件(elementid)和狀態(tài)變量(比如@Link包裝類)。
    2. 通知@Link包裝類更新后,子組件中所有依賴@Link狀態(tài)變量的系統(tǒng)組件(elementId)都會被通知更新。以此實現(xiàn)父組件對子組件的狀態(tài)數(shù)據(jù)同步。
  3. @Link的更新:當子組件中@Link更新后,處理步驟如下(以父組件為@State為例):
    1. @Link更新后,調(diào)用父組件的@State包裝類的set方法,將更新后的數(shù)值同步回父組件。
    2. 子組件@Link和父組件@State分別遍歷依賴的系統(tǒng)組件,進行對應(yīng)的UI的更新。以此實現(xiàn)子組件@Link同步回父組件@State。

使用場景

簡單類型和類對象類型的@Link

以下示例中,點擊父組件ShufflingContainer中的“Parent View: Set yellowButton”和“Parent View: Set GreenButton”,可以從父組件將變化同步給子組件。

1.點擊子組件GreenButton和YellowButton中的Button,子組件會發(fā)生相應(yīng)變化,將變化同步給父組件。因為@Link是雙向同步,會將變化同步給@State。

2.當點擊父組件ShufflingContainer中的Button時,@State變化,也會同步給@Link,子組件也會發(fā)生對應(yīng)的刷新。

  1. class GreenButtonState {
  2. width: number = 0;
  3. constructor(width: number) {
  4. this.width = width;
  5. }
  6. }
  7. @Component
  8. struct GreenButton {
  9. @Link greenButtonState: GreenButtonState;
  10. build() {
  11. Button('Green Button')
  12. .width(this.greenButtonState.width)
  13. .height(40)
  14. .backgroundColor('#64bb5c')
  15. .fontColor('#FFFFFF,90%')
  16. .onClick(() => {
  17. if (this.greenButtonState.width < 700) {
  18. // 更新class的屬性,變化可以被觀察到同步回父組件
  19. this.greenButtonState.width += 60;
  20. } else {
  21. // 更新class,變化可以被觀察到同步回父組件
  22. this.greenButtonState = new GreenButtonState(180);
  23. }
  24. })
  25. }
  26. }
  27. @Component
  28. struct YellowButton {
  29. @Link yellowButtonState: number;
  30. build() {
  31. Button('Yellow Button')
  32. .width(this.yellowButtonState)
  33. .height(40)
  34. .backgroundColor('#f7ce00')
  35. .fontColor('#FFFFFF,90%')
  36. .onClick(() => {
  37. // 子組件的簡單類型可以同步回父組件
  38. this.yellowButtonState += 40.0;
  39. })
  40. }
  41. }
  42. @Entry
  43. @Component
  44. struct ShufflingContainer {
  45. @State greenButtonState: GreenButtonState = new GreenButtonState(180);
  46. @State yellowButtonProp: number = 180;
  47. build() {
  48. Column() {
  49. Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center }) {
  50. // 簡單類型從父組件@State向子組件@Link數(shù)據(jù)同步
  51. Button('Parent View: Set yellowButton')
  52. .width(312)
  53. .height(40)
  54. .margin(12)
  55. .fontColor('#FFFFFF,90%')
  56. .onClick(() => {
  57. this.yellowButtonProp = (this.yellowButtonProp < 700) ? this.yellowButtonProp + 40 : 100;
  58. })
  59. // class類型從父組件@State向子組件@Link數(shù)據(jù)同步
  60. Button('Parent View: Set GreenButton')
  61. .width(312)
  62. .height(40)
  63. .margin(12)
  64. .fontColor('#FFFFFF,90%')
  65. .onClick(() => {
  66. this.greenButtonState.width = (this.greenButtonState.width < 700) ? this.greenButtonState.width + 100 : 100;
  67. })
  68. // class類型初始化@Link
  69. GreenButton({ greenButtonState: $greenButtonState }).margin(12)
  70. // 簡單類型初始化@Link
  71. YellowButton({ yellowButtonState: $yellowButtonProp }).margin(12)
  72. }
  73. }
  74. }
  75. }

數(shù)組類型的@Link

  1. @Component
  2. struct Child {
  3. @Link items: number[];
  4. build() {
  5. Column() {
  6. Button(`Button1: push`)
  7. .margin(12)
  8. .width(312)
  9. .height(40)
  10. .fontColor('#FFFFFF,90%')
  11. .onClick(() => {
  12. this.items.push(this.items.length + 1);
  13. })
  14. Button(`Button2: replace whole item`)
  15. .margin(12)
  16. .width(312)
  17. .height(40)
  18. .fontColor('#FFFFFF,90%')
  19. .onClick(() => {
  20. this.items = [100, 200, 300];
  21. })
  22. }
  23. }
  24. }
  25. @Entry
  26. @Component
  27. struct Parent {
  28. @State arr: number[] = [1, 2, 3];
  29. build() {
  30. Column() {
  31. Child({ items: $arr })
  32. .margin(12)
  33. ForEach(this.arr,
  34. (item: void) => {
  35. Button(`${item}`)
  36. .margin(12)
  37. .width(312)
  38. .height(40)
  39. .backgroundColor('#11a2a2a2')
  40. .fontColor('#e6000000')
  41. },
  42. (item: ForEachInterface) => item.toString()
  43. )
  44. }
  45. }
  46. }

上文所述,ArkUI框架可以觀察到數(shù)組元素的添加,刪除和替換。在該示例中@State和@Link的類型是相同的number[],不允許將@Link定義成number類型(@Link item : number),并在父組件中用@State數(shù)組中每個數(shù)據(jù)項創(chuàng)建子組件。如果要使用這個場景,可以參考@Prop和@Observed。

以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號