鸿蒙OS中的Localstorage、Appstorage及PersistentStorage

如果开发者要实现应用级的，或者多个页面的状态数据共享，就需要用到应用级别的状态管理的概念，即Localstorage、AppStorage、PersistentStorage

这三个都具有存储数据的功能，可以实现应用级别的数据共享，但是三者的区别和作用不同。以下是对三者的介绍：

• LocalStorage：页面级UI状态存储，通常用于UIAbility内、页面间的状态共享。

• AppStorage：特殊的单例LocalStorage对象，由UI框架在应用程序启动时创建，为应用程序UI状态属性提供中央存储。

• PersistentStorage：持久化存储UI状态，通常和AppStorage配合使用，选择AppStorage存储的数据写入磁盘，以确保这些属性在应用程序重新启动时的值与应用程序关闭时的值相同。

一、LocalStorage

LocalStorage是ArkTS为构建页面级别状态变量提供存储的内存内“数据库”，通常用于页面内的数据共享。

支持类型

LocalStorage支持的数据类型有：

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

使用方式：

// 创建新实例并使用给定对象初始化
let storage = new LocalStorage({ 'key': 47 });

@Entry(storage)
@Component
struct CompA {
  // @LocalStorageLink变量装饰器实现双向绑定
  @LocalStorageLink('key') storkey: number = 1;

  build() {
    Column({ space: 15 }) {
      Button(`Parent from LocalStorage ${this.storkey}`) 
        .onClick(() => {
            this.storkey += 1//通过this进行访问修改
        })
    }
  }
}

二、AppStorage

AppStorage是应用级的状态管理，可以实现在不同页面的数据共享，相当于整个应用的“中枢”，持久化数据PersistentStorage和环境变量Environment都是通过和AppStorage中转，才可以和UI交互。

支持类型：

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

使用方式

//初始化一个AppStorage实例
AppStorage.SetOrCreate('key', 47);

@Entry(storage)
@Component
struct Comp {
  //通过LocalStorageLink建立双向绑定
  @LocalStorageLink('PropA') localStorLink: number = 1;

  build() {
    Column({ space: 20 }) {
      Text(`From LocalStorage ${this.localStorLink}`)
        .onClick(() => {
            this.localStorLink += 1//通过this可以访问修改key值
        })
    }
  }
}

三、PersistentStorage

PersistentStorage的作用是实现用户数据的持久化，和AppStorage中的属性建立双向同步。

支持类型：

PersistentStorage允许的类型和值有：

• number, string, boolean, enum 等简单类型。
• 可以被JSON.stringify()和JSON.parse()重构的对象。例如Date, Map, Set等内置类型则不支持，以及对象的属性方法不支持持久化。

PersistentStorage不允许的类型和值有：

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

使用方式

PersistProp：

将AppStorage中key对应的属性持久化到文件中。该接口的调用通常在访问AppStorage之前。

PersistProps：

可以一次性持久化多个数据，适合在应用启动的时候初始化。

DeleteProp

删除属性为highScore的值：PersistentStorage.DeleteProp('highScore');

//初始化要持久化的数据
PersistentStorage.PersistProp('Prop', 47);

//持久化多个数据
//PersistentStorage.PersistProps([{ key: 'a', defaultValue: '0' }, { key: 'b', defaultValue: '1' }]);

@Entry
@Component
struct Index {
//利用 @StorageLink进行双向访问
  @StorageLink('Prop') Prop: number = 48

  build() {
    Row() {
      Column() {
        // 应用退出时会保存当前结果。重新启动后，会显示上一次的保存结果
        Text(`${this.aProp}`)
          .onClick(() => {
            this.aProp += 1;
          })
      }
    }
  }
}

注意点：

坑点-PersistentStorage的初始化要写在Ability的windowStage.loadContent('/pages/Index'······）加载的对应的页面中，即在Index页面的entry上方进行初始化，否则持久化容易失效。