ArkTS-AppStorage应用全局的UI状态存储

AppStorage应用全局的UI状态存储

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

和LocalStorage不同的是，LocalStorage是页面级的，通常应用于页面内的数据共享。而对于AppStorage，是应用级的全局状态共享。AppStorage还相当于整个应用的“中枢”，持久化数据PersistentStorage和环境变量Environment都是通过和AppStorage中转，才可以和UI回交互。

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

概述

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

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

AppStorage中的属性可以被双向同步，数据可以是存在于本地或远程设备上，并具有不同的功能，比如数据持久化（详见PersistentStorage）。这些数据是通过业务逻辑中实现，与UI解耦，如果希望这些数据在UI中使用，需要用到@StorageProp和StorageLink。

@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的对应属性到组件的状态变量。组件本地的修改是允许的，但是ApppStorage中给定的属性一旦发生变化，将覆盖本地的修改。
被装饰变量的初始值	必须指定，如果AppStorage实例中不存在属性，则作为初始化默认值，并存入AppStorage中。

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

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

观察变化和行为表现

观察变化

• 当装饰的数据类型为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
是否支持组件外访问	否。

观察变化和行为表现

观察变化

• 当装饰的数据类型为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对应的非静态方法。

代码语言：javascript复制

AppStorage.setOrCreate('PropA',47)

let storage: LocalStorage = new LocalStorage({'PropA':17});
let propA: number = AppStorage.Get('PropA')// propA in AppStorage == 47,propA in LocalStorage == 17
var link1: SubscribedAbstractProperty<number> = AppStorage.Link('PropA'); //link1.get()==47
var link2: SubscribedAbstractProperty<number> = AppStorage.Link('PropA'); //link2.get()==47
var prop: SUbscribedAbstractProperty<number> = AppStorage.Prop('PropA'); //prop.get() = 47

link1.set(48); //two-way sync: link1.get() == link2.get() == prop.get() == 48
prop.set(1); //one-way sync: prop.get()=1; but link1.get() == link2.get() == 48
link1.set(49); //two-way sync: link1.get() == link2.get() == prop.get() == 49

storage.get('PropA') // == 17
storage.set('PropA',101);
storage.get('PropA') // ==101

AppStorage.Get('PropA') // ==49
link1.get() // == 49
link2.get() // == 49
prop.get() // == 49

从UI内部使用AppStorage和LocalStorage

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

代码语言：javascript复制

AppStorage.SetOrCreate('PropA',47);
let storage = new LocalStorage({'PropA':48});

@Entry(storage)
@Component
struct CompA{
    @StorageLink('PropA') storLink: number = 1;
    @LocalStorageLink('PropA') localStorLink: number = 1;
    
    build(){
        Column({space: 20}){
            Text(`From AppStorage ${this.storLink}`)
            .onClick(()=> this.storLink =1)
            Text(`From LocalStorage ${this.localStorLink}`)
            .onClick(()=> this.localStorLink  =1)
        }
    }
}

限制条件

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

1.在AppStorage中创建属性后，调用PersistentStorage.PersistProp()接口时，会使用在AppStorage中已经存在的值，并覆盖PersistentStorage中的同名属性，所以建议要使用相反的调用顺序

2.如果在AppStorage中已经创建属性后，再调用Environment.EnvProp()创建同名的属性，会调用失败。因为AppStorage已经有同名属性，Envrionment环境变量不会再写入AppStorage中，所以建议AppStorage中属性不要使用Environment预置环境变量名

存储 ui 变量 数据 同步

0 人点赞