鸿蒙HarmonyOS开发框架—ArkTS语言（状态管理 六）

AppStorage：应用全局的UI状态存储

AppStorage是应用全局的UI状态存储，是和应用的进程绑定的，由UI框架在应用程序启动时创建，为应用程序UI状态属性提供中央存储。

和LocalStorage不同的是，LocalStorage是页面级的，通常应用于页面内的数据共享。而对于AppStorage，是应用级的全局状态共享。

概述

AppStorage是在应用启动的时候会被创建的单例。它的目的是为了提供应用状态数据的中心存储，这些状态数据在应用级别都是可访问的。AppStorage将在应用运行过程保留其属性。属性通过唯一的键字符串值访问。

AppStorage可以和UI组件同步，且可以在应用业务逻辑中被访问。

AppStorage中的属性可以被双向同步，数据可以是存在于本地或远程设备上，并具有不同的功能，比如数据持久化。

@StorageProp

在上文中已经提到，如果要建立AppStorage和自定义组件的联系，需要使用@StorageProp和@StorageLink装饰器。使用@StorageProp(key)/@StorageLink(key)装饰组件内的变量，key标识了AppStorage的属性。

当自定义组件初始化的时候，@StorageProp(key)/@StorageLink(key)装饰的变量会通过给定的key，绑定在AppStorage对应的属性，完成初始化。本地初始化是必要的，因为无法保证AppStorage一定存在给定的key，这取决于应用逻辑，是否在组件初始化之前在AppStorage实例中存入对应的属性。

@StorageProp(key)是和AppStorage中key对应的属性建立单向数据同步，我们允许本地改变的发生，但是对于@StorageProp，本地的修改永远不会同步回AppStorage中，相反，如果AppStorage给定key的属性发生改变，改变会被同步给@StorageProp，并覆盖掉本地的修改。

装饰器使用规则说明

@StorageProp变量装饰器

说明

装饰器参数

key：常量字符串，必填（字符串需要有引号）。

允许装饰的变量类型

Object class、string、number、boolean、enum类型，以及这些类型的数组。 类型必须被指定，且必须和LocalStorage中对应属性相同。不支持any，不允许使用undefined和null。

同步类型

单向同步：从AppStorage的对应属性到组件的状态变量。 组件本地的修改是允许的，但是AppStorage中给定的属性一旦发生变化，将覆盖本地的修改。

被装饰变量的初始值

必须指定，如果AppStorage实例中不存在属性，则作为初始化默认值，并存入AppStorage中。

变量的传递/访问规则说明

传递/访问

说明

从父节点初始化和更新

禁止，@StorageProp不支持从父节点初始化，只能AppStorage中key对应的属性初始化，如果没有对应key的话，将使用本地默认值初始化

初始化子节点

支持，可用于初始化@State、@Link、@Prop、@Provide。

是否支持组件外访问

否。

图1 @StorageProp初始化规则图示

观察变化和行为表现

观察变化

  • 当装饰的数据类型为boolean、string、number类型时，可以观察到数值的变化。
  • 当装饰的数据类型为class或者Object时，可以观察到赋值和属性赋值的变化，即Object.keys(observedObject)返回的所有属性。
  • 当装饰的对象是array时，可以观察到数组添加、删除、更新数组单元的变化。

框架行为

  • 当@StorageProp(key)装饰的数值改变被观察到时，修改不会被同步回AppStorage对应属性键值key的属性中。
  • 当前@StorageProp(key)单向绑定的数据会被修改，即仅限于当前组件的私有成员变量改变，其他的绑定该key的数据不会同步改变。
  • 当@StorageProp(key)装饰的数据本身是状态变量，它的改变虽然不会同步回AppStorage中，但是会引起所属的自定义组件的重新渲染。
  • 当AppStorage中key对应的属性发生改变时，会同步给所有@StorageProp(key)装饰的数据，@StorageProp(key)本地的修改将被覆盖。
@StorageLink

@StorageLink(key)是和AppStorage中key对应的属性建立双向数据同步：

  1. 本地修改发生，该修改会被写回AppStorage中；
  2. AppStorage中的修改发生后，该修改会被同步到所有绑定AppStorage对应key的属性上，包括单向（@StorageProp和通过Prop创建的单向绑定变量）、双向（@StorageLink和通过Link创建的双向绑定变量）变量和其他实例（比如PersistentStorage）。
装饰器使用规则说明

@StorageLink变量装饰器

说明

装饰器参数

key：常量字符串，必填（字符串需要有引号）。

允许装饰的变量类型

Object、class、string、number、boolean、enum类型，以及这些类型的数组。 类型必须被指定，且必须和AppStorage中对应属性相同。不支持any，不允许使用undefined和null。

同步类型

双向同步：从AppStorage的对应属性到自定义组件，从自定义组件到AppStorage对应属性。

被装饰变量的初始值

必须指定，如果AppStorage实例中不存在属性，则作为初始化默认值，并存入AppStorage中。

变量的传递/访问规则说明

传递/访问

说明

从父节点初始化和更新

禁止。

初始化子节点

支持，可用于初始化常规变量、@State、@Link、@Prop、@Provide。

是否支持组件外访问

否。

图2 @StorageLink初始化规则图示

观察变化和行为表现

观察变化

  • 当装饰的数据类型为boolean、string、number类型时，可以观察到数值的变化。
  • 当装饰的数据类型为class或者Object时，可以观察到赋值和属性赋值的变化，即Object.keys(observedObject)返回的所有属性。
  • 当装饰的对象是array时，可以观察到数组添加、删除、更新数组单元的变化。

框架行为

  1. 当@StorageLink(key)装饰的数值改变被观察到时，修改将被同步回AppStorage对应属性键值key的属性中。
  2. AppStorage中属性键值key对应的数据一旦改变，属性键值key绑定的所有的数据（包括双向@StorageLink和单向@StorageProp）都将同步修改；
  3. 当@StorageLink(key)装饰的数据本身是状态变量，它的改变不仅仅会同步回AppStorage中，还会引起所属的自定义组件的重新渲染。
使用场景
从应用逻辑使用AppStorage和LocalStorage

AppStorage是单例，它的所有API都是静态的，使用方法类似于LocalStorage对应的非静态方法。

  1. AppStorage.SetOrCreate('PropA', 47);
  2.  
  3. let storage: LocalStorage = new LocalStorage({ 'PropA': 17 });
  4. let propA: number = AppStorage.Get('PropA') // propA in AppStorage == 47, propA in LocalStorage == 17
  5. var link1: SubscribedAbstractProperty<number> = AppStorage.Link('PropA'); // link1.get() == 47
  6. var link2: SubscribedAbstractProperty<number> = AppStorage.Link('PropA'); // link2.get() == 47
  7. var prop: SubscribedAbstractProperty<number> = AppStorage.Prop('PropA'); // prop.get() = 47
  8.  
  9. link1.set(48); // two-way sync: link1.get() == link2.get() == prop.get() == 48
  10. prop.set(1); // one-way sync: prop.get()=1; but link1.get() == link2.get() == 48
  11. link1.set(49); // two-way sync: link1.get() == link2.get() == prop.get() == 49
  12.  
  13. storage.get('PropA') // == 17 
  14. storage.set('PropA', 101);
  15. storage.get('PropA') // == 101
  16.  
  17. AppStorage.Get('PropA') // == 49
  18. link1.get() // == 49
  19. link2.get() // == 49
  20. prop.get() // == 49

复制

从UI内部使用AppStorage和LocalStorage

@StorageLink变量装饰器与AppStorage配合使用，正如@LocalStorageLink与LocalStorage配合使用一样。此装饰器使用AppStorage中的属性创建双向数据同步。

  1. AppStorage.SetOrCreate('PropA', 47);
  2. let storage = new LocalStorage({ 'PropA': 48 });
  3.  
  4. @Entry(storage)
  5. @Component
  6. struct CompA {
  7.   @StorageLink('PropA') storLink: number = 1;
  8.   @LocalStorageLink('PropA') localStorLink: number = 1;
  9.  
  10.   build() {
  11.     Column({ space: 20 }) {
  12.       Text(`From AppStorage ${this.storLink}`)
  13.         .onClick(() => this.storLink += 1)
  14.  
  15.       Text(`From LocalStorage ${this.localStorLink}`)
  16.         .onClick(() => this.localStorLink += 1)
  17.     }
  18.   }
  19. }

复制

以持久化方式订阅某个事件并接收事件回调

推荐使用持久化方式订阅某个事件并接收事件回调，可以减少开销，增强代码的可读性。

  1. // xxx.ets
  2. import emitter from '@ohos.events.emitter';
  3.  
  4. let NextID: number = 0;
  5.  
  6. class ViewData {
  7.   title: string;
  8.   uri: Resource;
  9.   color: Color = Color.Black;
  10.   id: number;
  11.  
  12.   constructor(title: string, uri: Resource) {
  13.     this.title = title;
  14.     this.uri = uri
  15.     this.id = NextID++;
  16.   }
  17. }
  18.  
  19. @Entry
  20. @Component
  21. struct Gallery2 {
  22.   dataList: Array<ViewData> = [new ViewData('flower', $r('app.media.icon')), new ViewData('OMG', $r('app.media.icon')), new ViewData('OMG', $r('app.media.icon'))]
  23.   scroller: Scroller = new Scroller()
  24.   private preIndex: number = -1
  25.  
  26.   build() {
  27.     Column() {
  28.       Grid(this.scroller) {
  29.         ForEach(this.dataList, (item: ViewData) => {
  30.           GridItem() {
  31.             TapImage({
  32.               uri: item.uri,
  33.               index: item.id
  34.             })
  35.           }.aspectRatio(1)
  36.           .onClick(() => {
  37.             if (this.preIndex === item.id) {
  38.               return
  39.             }
  40.             var innerEvent = { eventId: item.id }
  41.             // 选中态：黑变红
  42.             var eventData = {
  43.               data: {
  44.                 "colorTag": 1
  45.               }
  46.             }
  47.             emitter.emit(innerEvent, eventData)
  48.  
  49.             if (this.preIndex != -1) {
  50.               console.info(`preIndex: ${this.preIndex}, index: ${item.id}, black`)
  51.               var innerEvent = { eventId: this.preIndex }
  52.               // 取消选中态：红变黑
  53.               var eventData = {
  54.                 data: {
  55.                   "colorTag": 0
  56.                 }
  57.               }
  58.               emitter.emit(innerEvent, eventData)
  59.             }
  60.             this.preIndex = item.id
  61.           })
  62.  
  63.         }, (item: ViewData) => JSON.stringify(item))
  64.       }.columnsTemplate('1fr 1fr')
  65.     }
  66.  
  67.   }
  68. }
  69.  
  70. @Component
  71. export struct TapImage {
  72.   @State tapColor: Color = Color.Black;
  73.   private index: number;
  74.   private uri: Resource;
  75.  
  76.   onTapIndexChange(colorTag: emitter.EventData) {
  77.     this.tapColor = colorTag.data.colorTag ? Color.Red : Color.Black
  78.   }
  79.  
  80.   aboutToAppear() {
  81.     //定义事件ID
  82.     var innerEvent = { eventId: this.index }
  83.     emitter.on(innerEvent, this.onTapIndexChange.bind(this))
  84.   }
  85.  
  86.   build() {
  87.     Column() {
  88.       Image(this.uri)
  89.         .objectFit(ImageFit.Cover)
  90.         .border({ width: 5, style: BorderStyle.Dotted, color: this.tapColor })
  91.     }
  92.   }
  93. }

复制

以下示例为消息机制方式订阅事件，会导致回调监听的节点数较多，非常耗时，不推荐以此来实现应用代码。

  1. // xxx.ets
  2. class ViewData {
  3.   title: string;
  4.   uri: Resource;
  5.   color: Color = Color.Black;
  6.  
  7.   constructor(title: string, uri: Resource) {
  8.     this.title = title;
  9.     this.uri = uri
  10.   }
  11. }
  12.  
  13. @Entry
  14. @Component
  15. struct Gallery2 {
  16.   dataList: Array<ViewData> = [new ViewData('flower', $r('app.media.icon')), new ViewData('OMG', $r('app.media.icon')), new ViewData('OMG', $r('app.media.icon'))]
  17.   scroller: Scroller = new Scroller()
  18.  
  19.   build() {
  20.     Column() {
  21.       Grid(this.scroller) {
  22.         ForEach(this.dataList, (item: ViewData, index?: number) => {
  23.           GridItem() {
  24.             TapImage({
  25.               uri: item.uri,
  26.               index: index
  27.             })
  28.           }.aspectRatio(1)
  29.  
  30.         }, (item: ViewData, index?: number) => {
  31.           return JSON.stringify(item) + index;
  32.         })
  33.       }.columnsTemplate('1fr 1fr')
  34.     }
  35.  
  36.   }
  37. }
  38.  
  39. @Component
  40. export struct TapImage {
  41.   @StorageLink('tapIndex') @Watch('onTapIndexChange') tapIndex: number = -1;
  42.   @State tapColor: Color = Color.Black;
  43.   private index: number;
  44.   private uri: Resource;
  45.  
  46.   // 判断是否被选中
  47.   onTapIndexChange() {
  48.     if (this.tapIndex >= 0 && this.index === this.tapIndex) {
  49.       console.info(`tapindex: ${this.tapIndex}, index: ${this.index}, red`)
  50.       this.tapColor = Color.Red;
  51.     } else {
  52.       console.info(`tapindex: ${this.tapIndex}, index: ${this.index}, black`)
  53.       this.tapColor = Color.Black;
  54.     }
  55.   }
  56.  
  57.   build() {
  58.     Column() {
  59.       Image(this.uri)
  60.         .objectFit(ImageFit.Cover)
  61.         .onClick(() => {
  62.           this.tapIndex = this.index;
  63.         })
  64.         .border({ width: 5, style: BorderStyle.Dotted, color: this.tapColor })
  65.     }
  66.  
  67.   }
  68. }

复制

限制条件

AppStorage与PersistentStorage以及Environment配合使用时，需要注意以下几点：

  • 在AppStorage中创建属性后，调用PersistentStorage.PersistProp()接口时，会使用在AppStorage中已经存在的值，并覆盖PersistentStorage中的同名属性，所以建议要使用相反的调用顺序；
  • 如果在AppStorage中已经创建属性后，再调用Environment.EnvProp()创建同名的属性，会调用失败。因为AppStorage已经有同名属性，Environment环境变量不会再写入AppStorage中，所以建议AppStorage中属性不要使用Environment预置环境变量名。

最后，为了能让大家更好的去学习提升鸿蒙 (Harmony OS) 开发技术，小编连夜整理了一份30个G纯血版学习资料（含视频、电子书、学习文档等）以及一份在Github上持续爆火霸榜的《纯血版华为鸿蒙 (Harmony OS)开发手册》（共计890页），希望对大家有所帮助。

纯血版鸿蒙 HarmonyOS 4.0 视频学习资料

 需要以上视频学习资料小伙伴

请点击→纯血版全套鸿蒙HarmonyOS学习资料

《纯血版华为鸿蒙 (Harmony OS)开发手册》

这份手册涵盖了当前鸿蒙 (Harmony OS) 开发技术必掌握的核心知识点

纯血版鸿蒙 (Harmony OS)开发手册部分精彩内容

HarmonyOS 概念：

  • 系统定义
  • 技术架构
  • 技术特性
  • 系统安全

如何快速入门？

  • 基本概念
  • 构建第一个ArkTS应用
  • 构建第一个JS应用
  • ……


开发基础知识： 

  • 应用基础知识
  • 配置文件
  • 应用数据管理
  • 应用安全管理
  • 应用隐私保护
  • 三方应用调用管控机制
  • 资源分类与访问
  • 学习ArkTS语言
  • ……

基于ArkTS 开发：

  • Ability开发
  • UI开发
  • 公共事件与通知
  • 窗口管理
  • 媒体
  • 安全
  • 网络与链接
  • 电话服务
  • 数据管理
  • 后台任务(Background Task)管理
  • 设备管理
  • 设备使用信息统计
  • DFX
  • 国际化开发
  • 折叠屏系列
  • .……

获取以上文中提到的这份纯血版鸿蒙 (Harmony OS) 开发资料的小伙伴 

请点击→纯血版全套鸿蒙HarmonyOS学习资料

?写在最后

  • 如果你觉得这篇内容对你还蛮有帮助，我想邀请你帮我三个小忙：
  • 点赞，转发，有你们的 『点赞和评论』，才是我创造的动力。
  • 关注小编，同时可以期待后续文章ing?，不定期分享原创知识。
  • 想要获取更多完整鸿蒙最新VIP学习资料，请点击→纯血版全套鸿蒙HarmonyOS学习资料

最新鸿蒙Next全套学习资料请扫码
微信名片
注：本文转载自blog.csdn.net的蜀道山QAQ的文章"https://blog.csdn.net/shudaoshanQAQ/article/details/135637455"。版权归原作者所有，此博客不拥有其著作权，亦不承担相应法律责任。如有侵权，请联系我们删除。
复制链接
相关推荐
发表评论

评论记录：

未查询到任何数据！