HarmonyOS NEXT应用开发之PersistentStorage：长期化存储UI状态 ...

前两个小节介绍的LocalStorage和AppStorage都是运行时的内存，但是在应用退出再次启动后，依然能生存选定的效果，是应用开发中十分常见的征象，这就需要用到PersistentStorage。
PersistentStorage是应用程序中的可选单例对象。此对象的作用是长期化存储选定的AppStorage属性，以确保这些属性在应用程序重新启动时的值与应用程序关闭时的值相同。
概述

PersistentStorage将选定的AppStorage属性保留在设备磁盘上。应用程序通过API，以决定哪些AppStorage属性应借助PersistentStorage长期化。UI和业务逻辑不直接访问PersistentStorage中的属性，所有属性访问都是对AppStorage的访问，AppStorage中的更改会主动同步到PersistentStorage。
PersistentStorage和AppStorage中的属性建立双向同步。应用开发通常通过AppStorage访问PersistentStorage，另外尚有一些接口可以用于管理长期化属性，但是业务逻辑始终是通过AppStorage获取和设置属性的。
限定条件

PersistentStorage答应的范例和值有：

• number, string, boolean, enum 等简单范例。
  
• 可以被JSON.stringify()和JSON.parse()重构的对象，以及对象的属性方法不支持长期化。
  
• API12及以上支持Map范例，可以观察到Map团体的赋值，同时可通过调用Map的接口set, clear, delete 更新Map的值。且更新的值被长期化存储。
  
• API12及以上支持Set范例，可以观察到Set团体的赋值，同时可通过调用Set的接口add, clear, delete 更新Set的值。且更新的值被长期化存储。
  
• API12及以上支持Date范例，可以观察到Date团体的赋值，同时可通过调用Date的接口setFullYear, setMonth, setDate, setHours, setMinutes, setSeconds, setMilliseconds, setTime, setUTCFullYear, setUTCMonth, setUTCDate, setUTCHours, setUTCMinutes, setUTCSeconds, setUTCMilliseconds 更新Date的属性。且更新的值被长期化存储。
  
• API12及以上支持undefined 和 null。
  
• API12及以上[支持连合范例。
  

PersistentStorage不答应的范例和值有：

• 不支持嵌套对象（对象数组，对象的属性是对象等）。因为目前框架无法检测AppStorage中嵌套对象（包罗数组）值的变化，所以无法写回到PersistentStorage中。
  

长期化数据是一个相对痴钝的操作，应用程序应克制以下情况：

• 长期化大型数据集。
  
• 长期化经常变化的变量。
  

PersistentStorage的长期化变量最好是小于2kb的数据，不要大量的数据长期化，因为PersistentStorage写入磁盘的操作是同步的，大量的数据本地化读写会同步在UI线程中实行，影响UI渲染性能。假如开发者需要存储大量的数据，发起使用数据库api。
PersistentStorage和UI实例相关联，长期化操作需要在UI实例初始化成功后（即 loadContent 传入的回调被调用时）才可以被调用，早于该机遇调用会导致长期化失败。

1. // EntryAbility.ets
2. onWindowStageCreate(windowStage: window.WindowStage): void {
3.    
4.   windowStage.loadContent('pages/Index', (err) => {
5.    
6.     if (err.code) {
7.    
8.       return;
9.     }
10.     PersistentStorage.persistProp('aProp', 47);
12.   });
13. }

复制代码

使用场景

从AppStorage中访问PersistentStorage初始化的属性

• 初始化PersistentStorage：
  

1.    PersistentStorage.persistProp('aProp', 47);

复制代码

• 在AppStorage获取对应属性：
  

1.    AppStorage.get<number>('aProp'); // returns 47

复制代码

或在组件内部界说：

1.    @StorageLink('aProp') aProp: number = 48;

复制代码

完整代码如下：

1. PersistentStorage.persistProp('aProp', 47);
3. @Entry
4. @Component
5. struct Index {
6.    
7.   @State message: string = 'Hello World'
8.   @StorageLink('aProp') aProp: number = 48
10.   build() {
11.    
12.     Row() {
13.    
14.       Column() {
15.    
16.         Text(this.message)
17.         // 应用退出时会保存当前结果。重新启动后，会显示上一次的保存结果
18.         Text(`${
19.      this.aProp}`)
20.           .onClick(() => {
21.    
22.             this.aProp += 1;
23.           })
24.       }
25.     }
26.   }
27. }

复制代码

• 新应用安装后初次启动运行：
  
     
  
  • 调用persistProp初始化PersistentStorage，起首查询在PersistentStorage本地文件中是否存在“aProp”，查询效果为不存在，因为应用是第一次安装。   
    
  • 接着查询属性“aProp”在AppStorage中是否存在，依旧不存在。   
    
  • 在AppStorge中创建名为“aProp”的number范例属性，属性初始值是界说的默认值47。   
    
  • PersistentStorage将属性“aProp”和值47写入磁盘，AppStorage中“aProp”对应的值和其后续的更改将被长期化。   
    
  • 在Index组件中创建状态变量@StorageLink(‘aProp’) aProp，和AppStorage中“aProp”双向绑定，在创建的过程中会在AppStorage中查找，成功找到“aProp”，所以使用其在AppStorage找到的值47。  
    
  图1 PersistProp初始化流程
  
  

• 触发点击事件后：
  
     
  
  • 状态变量@StorageLink(‘aProp’) aProp改变，触发Text组件重新刷新。   
    
  • @StorageLink装饰的变量是和AppStorage中建立双向同步的，所以@StorageLink(‘aProp’) aProp的变化会被同步回AppStorage中。   
    
  • AppStorage中“aProp”属性的改变会同步到所有绑定该“aProp”的单向大概双向变量，在本示例中没有其他的绑定“aProp”的变量。   
    
  • 因为“aProp”对应的属性已经被长期化，所以在AppStorage中“aProp”的改变会触发PersistentStorage，将新的改变写入本地磁盘。  
    
    
  
• 后续启动应用：
  
     
  
  • 实行PersistentStorage.persistProp(‘aProp’, 47)，在起首查询在PersistentStorage本地文件查询“aProp”属性，成功查询到。   
    
  • 将在PersistentStorage查询到的值写入AppStorage中。   
    
  • 在Index组件里，@StorageLink绑定的“aProp”为PersistentStorage写入AppStorage中的值，即为上一次退出应用存入的值。  
    
  
  

在PersistentStorage之前访问AppStorage中的属性

该示例为反例。在调用PersistentStorage.persistProp大概persistProps之前使用接口访问AppStorage中的属性是错误的，因为这样的调用顺序会丢失上一次应用程序运行中的属性值：

1. let aProp = AppStorage

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。