玩转HarmonyOS NEXT之AppStorage应用全局UI状态存储

概述

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

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

本文仅介绍AppStorage使用场景和相关的装饰器:@StorageProp@StorageLink

@StorageProp

如果要建立AppStorage和自定义组件的联系,需要使用@StorageProp@StorageLink装饰器。使用@StorageProp(key)/@StorageLink(key)装饰组件内的变量,key标识了AppStorage的属性。

装饰器使用规则说明

@StorageProp变量装饰器 说明
装饰器参数 key:常量字符串,必填(字符串需要有引号)。
允许装饰的变量类型 Objectclassstringnumberbooleanenum类型,以及这些类型的数组。
同步类型 单向同步:从AppStorage的对应属性到组件的状态变量。
组件本地的修改是允许的,但是AppStorage中给定的属性一旦发生变化,将覆盖本地的修改。
被装饰变量的初始值 必须指定,如果AppStorage实例中不存在属性,则用该初始值初始化该属性,并存入AppStorage中。

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

传递/访问 说明
从父节点初始化和更新 禁止@StorageProp不支持从父节点初始化,只能AppStoragekey对应的属性初始化,如果没有对应key的话,将使用本地默认值初始化
初始化子节点 支持,可用于初始化@State@Link@Prop@Provide
是否支持组件外访问

@StorageProp初始化规则

监听变化和行为表现

监听变化

  • 当装饰的数据类型为booleanstringnumber类型时,可以监听到数值的变化。
  • 当装饰的数据类型为class或者Object时,可以监听到对象整体赋值对象属性变化。
  • 当装饰的对象是array时,可以监听到数组添加、删除、更新数组单元的变化。
  • 当装饰的对象是Date时,可以监听到Date整体的赋值,同时可通过调用Date的接口setFullYear, setMonth, setDate, setHours, setMinutes, setSeconds, setMilliseconds, setTime, setUTCFullYear, setUTCMonth, setUTCDate, setUTCHours, setUTCMinutes, setUTCSeconds, setUTCMilliseconds更新Date的属性。
  • 当装饰的变量是Map时,可以监听到Map整体的赋值,同时可通过调用Map的接口set, clear, delete 更新Map的值。
  • 当装饰的变量是Set时,可以观察到Set整体的赋值,同时可通过调用Set的接口add, clear, delete 更新Set的值。

框架行为

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

@StorageLink

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

  • 本地修改发生,该修改会被写回AppStorage中;
  • AppStorage中的修改发生后,该修改会被同步到所有绑定AppStorage对应key的属性上,包括单向(@StorageProp和通过Prop创建的单向绑定变量)、双向(@StorageLink和通过Link创建的双向绑定变量)变量和其他实例(比如PersistentStorage)。

装饰器使用规则说明

@StorageLink变量装饰器 说明
装饰器参数 key:常量字符串,必填(字符串需要有引号)。
允许装饰的变量类型 Objectclassstringnumberbooleanenum类型,以及这些类型的数组。
同步类型 双向同步:从AppStorage的对应属性到自定义组件,从自定义组件到AppStorage对应属性。
被装饰变量的初始值 必须指定,如果AppStorage实例中不存在属性,则用该初始值初始化该属性,并存入AppStorage中。

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

传递/访问 说明
从父节点初始化和更新 禁止。
初始化子节点 支持,可用于初始化常规变量、@State@Link@Prop@Provide
是否支持组件外访问

@StorageLink初始化规则

监听变化和行为表现

监听变化

  • 当装饰的数据类型为booleanstringnumber类型时,可以监听到数值的变化。
  • 当装饰的数据类型为class或者Object时,可以监听到对象整体赋值对象属性变化。
  • 当装饰的对象是array时,可以监听到数组添加、删除、更新数组单元的变化。
  • 当装饰的对象是Date时,可以监听到Date整体的赋值,同时可通过调用Date的接口setFullYear, setMonth, setDate, setHours, setMinutes, setSeconds, setMilliseconds, setTime, setUTCFullYear, setUTCMonth, setUTCDate, setUTCHours, setUTCMinutes, setUTCSeconds, setUTCMilliseconds更新Date的属性。
  • 当装饰的变量是Map时,可以监听到Map整体的赋值,同时可通过调用Map的接口set, clear, delete 更新Map的值。
  • 当装饰的变量是Set时,可以观察到Set整体的赋值,同时可通过调用Set的接口add, clear, delete 更新Set的值。

框架行为

  • @StorageProp(key)装饰的数值改变被监听到时,修改将被同步回·AppStorage`对应属性键值key的属性中。
  • AppStorage中属性键值key对应的数据一旦改变,属性键值key绑定的所有的数据(包括双向@StorageLink和单向@StorageProp)都将同步修改。
  • @StorageLink(key)装饰的数据本身是状态变量,它的改变不仅仅会同步回AppStorage中,还会引起所属的自定义组件的重新渲染。

相关推荐

  1. springbootSpringApplicationRunListener

    2024-07-17 07:24:01       23 阅读

最近更新

  1. docker php8.1+nginx base 镜像 dockerfile 配置

    2024-07-17 07:24:01       67 阅读
  2. Could not load dynamic library ‘cudart64_100.dll‘

    2024-07-17 07:24:01       72 阅读
  3. 在Django里面运行非项目文件

    2024-07-17 07:24:01       58 阅读
  4. Python语言-面向对象

    2024-07-17 07:24:01       69 阅读

热门阅读

  1. [NOIP2006 提高组] 作业调度方案(含代码)

    2024-07-17 07:24:01       18 阅读
  2. OpenSearch 第三方IoT设备日志分析

    2024-07-17 07:24:01       29 阅读
  3. Photoshop

    Photoshop

    2024-07-17 07:24:01      20 阅读
  4. Github07-16 Python开源项目日报 Top10

    2024-07-17 07:24:01       23 阅读
  5. 用于图像增强的学习型可控ISP

    2024-07-17 07:24:01       28 阅读
  6. 掌握Xcode的魔术:自定义Storyboard的创建与管理

    2024-07-17 07:24:01       29 阅读
  7. Telegram Bot、小程序开发(三)Mini Apps小程序

    2024-07-17 07:24:01       23 阅读
  8. Google 地图参考手册

    2024-07-17 07:24:01       26 阅读
  9. 通过swagger自动生成jmeter脚本

    2024-07-17 07:24:01       24 阅读
  10. B树(B-tree)

    2024-07-17 07:24:01       28 阅读
  11. 081、Python 关于方法重写

    2024-07-17 07:24:01       22 阅读