乐趣区

关于harmonyos:HarmonyOSLocalStorage页面级UI状态存储

作者：

jiezi

在

LocalStorage是页面级的UI状态存储，通过@Entry装璜器接管的参数能够在页面内共享同一个LocalStorage实例。LocalStorage也能够在UIAbility实例内，在页面间共享状态。

本文仅介绍LocalStorage应用场景和相干的装璜器：@LocalStorageProp和@LocalStorageLink。

阐明
本模块从API version 9开始反对。

概述

LocalStorage是ArkTS为构建页面级别状态变量提供存储的内存内“数据库”。

  • 应用程序能够创立多个LocalStorage实例，LocalStorage实例能够在页面内共享，也能够通过GetShared接口，实现跨页面、UIAbility实例内共享。
  • 组件树的根节点，即被@Entry装璜的@Component，能够被调配一个LocalStorage实例，此组件的所有子组件实例将主动取得对该LocalStorage实例的拜访权限；
  • 被@Component装璜的组件最多能够拜访一个LocalStorage实例和AppStorage，未被@Entry装璜的组件不可被独立调配LocalStorage实例，只能承受父组件通过@Entry传递来的LocalStorage实例。一个LocalStorage实例在组件树上能够被调配给多个组件。
  • LocalStorage中的所有属性都是可变的。

应用程序决定LocalStorage对象的生命周期。当利用开释最初一个指向LocalStorage的援用时，比方销毁最初一个自定义组件，LocalStorage将被JS Engine垃圾回收。

LocalStorage依据与@Component装璜的组件的同步类型不同，提供了两个装璜器：

  • @LocalStorageProp：@LocalStorageProp装璜的变量和与LocalStorage中给定属性建设单向同步关系。
  • @LocalStorageLink：@LocalStorageLink装璜的变量和在@Component中创立与LocalStorage中给定属性建设双向同步关系。

限度条件

  • LocalStorage创立后，命名属性的类型不可更改。后续调用Set时必须应用雷同类型的值。
  • LocalStorage是页面级存储，GetShared接口仅能获取以后Stage通过windowStage.loadContent传入的LocalStorage实例，否则返回undefined。例子可见将LocalStorage实例从UIAbility共享到一个或多个视图。

@LocalStorageProp

在上文中曾经提到，如果要建设LocalStorage和自定义组件的分割，须要应用@LocalStorageProp和@LocalStorageLink装璜器。应用@LocalStorageProp(key)/@LocalStorageLink(key)装璜组件内的变量，key标识了LocalStorage的属性。

当自定义组件初始化的时候，@LocalStorageProp(key)/@LocalStorageLink(key)装璜的变量会通过给定的key，绑定LocalStorage对应的属性，实现初始化。本地初始化是必要的，因为无奈保障LocalStorage肯定存在给定的key（这取决于应用逻辑是否在组件初始化之前在LocalStorage实例中存入对应的属性）。

阐明
从API version 9开始，该装璜器反对在ArkTS卡片中应用。

@LocalStorageProp(key)是和LocalStorage中key对应的属性建设单向数据同步，咱们容许本地扭转的产生，然而对于@LocalStorageProp，本地的批改永远不会同步回LocalStorage中，相同，如果LocalStorage给定key的属性产生扭转，扭转会被同步给@LocalStorageProp，并笼罩掉本地的批改。

装璜器应用规定阐明

变量的传递/拜访规定阐明

图1 @LocalStorageProp初始化规定图示

察看变动和行为表现

察看变动

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

框架行为

  • 当@LocalStorageProp(key)装璜的数值扭转被察看到时，批改不会被同步回LocalStorage对应属性键值key的属性中。
  • 以后@LocalStorageProp(key)单向绑定的数据会被批改，即仅限于以后组件的公有成员变量扭转，其余的绑定该key的数据不会同步扭转。
  • 当@LocalStorageProp(key)装璜的数据自身是状态变量，它的扭转尽管不会同步回LocalStorage中，然而会引起所属的自定义组件的从新渲染。
  • 当LocalStorage中key对应的属性产生扭转时，会同步给所有@LocalStorageProp(key)装璜的数据，@LocalStorageProp(key)本地的批改将被笼罩。

@LocalStorageLink

如果咱们须要将自定义组件的状态变量的更新同步回LocalStorage，就须要用到@LocalStorageLink。

@LocalStorageLink(key)是和LocalStorage中key对应的属性建设双向数据同步：

1.本地批改产生，该批改会被写回LocalStorage中；
2.LocalStorage中的批改产生后，该批改会被同步到所有绑定LocalStorage对应key的属性上，包含单向（@LocalStorageProp和通过prop创立的单向绑定变量）、双向（@LocalStorageLink和通过link创立的双向绑定变量）变量。

装璜器应用规定阐明

变量的传递/拜访规定阐明

图2 @LocalStorageLink初始化规定图示

察看变动和行为表现

察看变动

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

框架行为

1.当@LocalStorageLink(key)装璜的数值扭转被察看到时，批改将被同步回LocalStorage对应属性键值key的属性中。
2.LocalStorage中属性键值key对应的数据一旦扭转，属性键值key绑定的所有的数据（包含双向@LocalStorageLink和单向@LocalStorageProp）都将同步批改。
3.当@LocalStorageLink(key)装璜的数据自身是状态变量，它的扭转不仅仅会同步回LocalStorage中，还会引起所属的自定义组件的从新渲染。

应用场景

应用逻辑应用LocalStorage

let storage = new LocalStorage({ 'PropA': 47 }); // 创立新实例并应用给定对象初始化
let propA = storage.get('PropA') // propA == 47
let link1 = storage.link('PropA'); // link1.get() == 47
let link2 = storage.link('PropA'); // link2.get() == 47
let prop = storage.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

从UI外部应用LocalStorage

除了利用程序逻辑应用LocalStorage，还能够借助LocalStorage相干的两个装璜器@LocalStorageProp和@LocalStorageLink，在UI组件外部获取到LocalStorage实例中存储的状态变量。

本示例以@LocalStorage为例，展现了：

  • 应用构造函数创立LocalStorage实例storage；
  • 应用@Entry装璜器将storage增加到CompA顶层组件中；
  • @LocalStorageLink绑定LocalStorage对给定的属性，建设双向数据同步。
// 创立新实例并应用给定对象初始化
let storage = new LocalStorage({ 'PropA': 47 });
@Component
struct Child {
  // @LocalStorageLink变量装璜器与LocalStorage中的'PropA'属性建设双向绑定
  @LocalStorageLink('PropA') storLink2: number = 1;
  build() {
    Button(`Child from LocalStorage ${this.storLink2}`)
      // 更改将同步至LocalStorage中的'PropA'以及Parent.storLink1
      .onClick(() => this.storLink2 += 1)
  }
}
// 使LocalStorage可从@Component组件拜访
@Entry(storage)
@Component
struct CompA {
  // @LocalStorageLink变量装璜器与LocalStorage中的'PropA'属性建设双向绑定
  @LocalStorageLink('PropA') storLink1: number = 1;
  build() {
    Column({ space: 15 }) {
      Button(`Parent from LocalStorage ${this.storLink1}`) // initial value from LocalStorage will be 47, because 'PropA' initialized already
        .onClick(() => this.storLink1 += 1)
      // @Component子组件主动取得对CompA LocalStorage实例的拜访权限。
      Child()
    }
  }
}

@LocalStorageProp和LocalStorage单向同步的简略场景

在上面的示例中，CompA 组件和Child组件别离在本地创立了与storage的’PropA’对应属性的单向同步的数据，咱们能够看到：

  • CompA中对this.storProp1的批改，只会在CompA中失效，并没有同步回storage；
  • Child组件中，Text绑定的storProp2 仍旧显示47。
// 创立新实例并应用给定对象初始化
let storage = new LocalStorage({ 'PropA': 47 });
// 使LocalStorage可从@Component组件拜访
@Entry(storage)
@Component
struct CompA {
  // @LocalStorageProp变量装璜器与LocalStorage中的'PropA'属性建设单向绑定
  @LocalStorageProp('PropA') storProp1: number = 1;
  build() {
    Column({ space: 15 }) {
      // 点击后从47开始加1，只扭转以后组件显示的storProp1，不会同步到LocalStorage中
      Button(`Parent from LocalStorage ${this.storProp1}`)
        .onClick(() => this.storProp1 += 1)
      Child()
    }
  }
}
@Component
struct Child {
  // @LocalStorageProp变量装璜器与LocalStorage中的'PropA'属性建设单向绑定
  @LocalStorageProp('PropA') storProp2: number = 2;
  build() {
    Column({ space: 15 }) {
      // 当CompA扭转时，以后storProp2不会扭转，显示47
      Text(`Parent from LocalStorage ${this.storProp2}`)
    }
  }
}

@LocalStorageLink和LocalStorage双向同步的简略场景

上面的示例展现了@LocalStorageLink装璜的数据和LocalStorage双向同步的场景

// 结构LocalStorage实例
let storage = new LocalStorage({ 'PropA': 47 });
// 调用link（api9以上）接口结构'PropA'的双向同步数据，linkToPropA 是全局变量
let linkToPropA = storage.link('PropA');
@Entry(storage)
@Component
struct CompA {
  // @LocalStorageLink('PropA')在CompA自定义组件中创立'PropA'的双向同步数据，初始值为47，因为在结构LocalStorage曾经给“PropA”设置47
  @LocalStorageLink('PropA') storLink: number = 1;
  build() {
    Column() {
      Text(`incr @LocalStorageLink variable`)
        // 点击“incr @LocalStorageLink variable”，this.storLink加1，扭转同步回storage，全局变量linkToPropA也会同步扭转 
        .onClick(() => this.storLink += 1)
      // 并不倡议在组件内应用全局变量linkToPropA.get()，因为可能会有生命周期不同引起的谬误。
      Text(`@LocalStorageLink: ${this.storLink} - linkToPropA: ${linkToPropA.get()}`)
    }
  }
}

兄弟节点之间同步状态变量

上面的示例展现了通过@LocalStorageLink双向同步兄弟节点之间的状态。

先看Parent自定义组件中产生的变动：

1.点击“playCount ${this.playCount} dec by 1”，this.playCount减1，批改同步回LocalStorage中，Child组件中的playCountLink绑定的组件会同步刷新；
2.点击“countStorage ${this.playCount} incr by 1”，调用LocalStorage的set接口，更新LocalStorage中“countStorage”对应的属性，Child组件中的playCountLink绑定的组件会同步刷新；
3.Text组件“playCount in LocalStorage for debug ${storage.get<number>(‘countStorage’)}”没有同步刷新，因为storage.get<number>(‘countStorage’)返回的是惯例变量，惯例变量的更新并不会引起Text组件的从新渲染。

Child自定义组件中的变动：

1.playCountLink的刷新会同步回LocalStorage，并且引起兄弟组件和父组件相应的刷新。

let storage = new LocalStorage({ countStorage: 1 });
@Component
struct Child {
  // 子组件实例的名字
  label: string = 'no name';
  // 和LocalStorage中“countStorage”的双向绑定数据
  @LocalStorageLink('countStorage') playCountLink: number = 0;
  build() {
    Row() {
      Text(this.label)
        .width(50).height(60).fontSize(12)
      Text(`playCountLink ${this.playCountLink}: inc by 1`)
        .onClick(() => {
          this.playCountLink += 1;
        })
        .width(200).height(60).fontSize(12)
    }.width(300).height(60)
  }
}
@Entry(storage)
@Component
struct Parent {
  @LocalStorageLink('countStorage') playCount: number = 0;
  build() {
    Column() {
      Row() {
        Text('Parent')
          .width(50).height(60).fontSize(12)
        Text(`playCount ${this.playCount} dec by 1`)
          .onClick(() => {
            this.playCount -= 1;
          })
          .width(250).height(60).fontSize(12)
      }.width(300).height(60)
      Row() {
        Text('LocalStorage')
          .width(50).height(60).fontSize(12)
        Text(`countStorage ${this.playCount} incr by 1`)
          .onClick(() => {
            storage.set<number>('countStorage', 1 + storage.get<number>('countStorage'));
          })
          .width(250).height(60).fontSize(12)
      }.width(300).height(60)
      Child({ label: 'ChildA' })
      Child({ label: 'ChildB' })
      Text(`playCount in LocalStorage for debug ${storage.get<number>('countStorage')}`)
        .width(300).height(60).fontSize(12)
    }
  }
}

将LocalStorage实例从UIAbility共享到一个或多个视图

下面的实例中，LocalStorage的实例仅仅在一个@Entry装璜的组件和其所属的子组件（一个页面）中共享，如果心愿其在多个视图中共享，能够在所属UIAbility中创立LocalStorage实例，并调用windowStage.loadContent。

// EntryAbility.ts
import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
let para:Record<string,number> = { 'PropA': 47 };
let localStorage: LocalStorage = new LocalStorage(para);
export default class EntryAbility extends UIAbility {
  storage: LocalStorage = localStorage
  onWindowStageCreate(windowStage: window.WindowStage) {
    windowStage.loadContent('pages/Index', this.storage);
  }
}

阐明
在UI页面通过getShared接口获取在通过loadContent共享的LocalStorage实例。
LocalStorage.getShared只在模拟器或者实机上才无效，不能在Preview预览器中应用。

// 通过GetShared接口获取stage共享的LocalStorage实例
let storage = LocalStorage.GetShared()
@Entry(storage)
@Component
struct CompA {
  // can access LocalStorage instance using 
  // @LocalStorageLink/Prop decorated variables
  @LocalStorageLink('PropA') varA: number = 1;
  build() {
    Column() {
      Text(`${this.varA}`).fontSize(50)
    }
  }
}

阐明
对于开发者更倡议应用这个形式来构建LocalStorage的实例，并且在创立LocalStorage实例的时候就写入默认值，因为默认值能够作为运行异样的备份，也能够用作页面的单元测试。

为了可能让大家跟上互联网时代的技术迭代，在这里跟大家分享一下我本人近期学习心得以及参考网上材料整顿出的一份最新版的鸿蒙学习晋升材料，有须要的小伙伴自行支付，限时开源，先到先得~~~~

支付以下高清学习路线原图请点击→《鸿蒙全套学习指南》纯血鸿蒙HarmonyOS根底技能学习路线图

支付以上残缺高清学习路线图，请点击→《鸿蒙 (Harmony OS)开发学习手册》小编本人整顿的局部学习材料（蕴含有高清视频、开发文档、电子书籍等）

以上分享的学习路线都适宜哪些人跟着学习？
-应届生/计算机专业通过学习鸿蒙新兴技术，入行互联网，将来高起点待业。
-0根底转行提前布局新方向，抓住风口，自我晋升，取得更多就业机会。
-技术晋升/进阶跳槽倒退瓶颈期，晋升职场竞争力，疾速把握鸿蒙技术，享受蓝海红利。

最初

鸿蒙开发学习是一个系统化的过程，从基础知识的学习到实战技能的锻炼，再到对前沿技术的摸索，每一环节都至关重要。心愿这份教程材料能帮忙您疾速入门并在鸿蒙开发之路上步步攀升，成就一番事业。让咱们一起乘风破浪，拥抱鸿蒙生态的广大将来！

如果你感觉这篇内容对你有帮忙，我想麻烦大家动动小手给我：点赞，转发，有你们的 『点赞和评论』，才是我发明的能源。

关注我，同时能够期待后续文章ing，不定期分享原创常识。

想要获取更多残缺鸿蒙最新VIP学习材料，请点击→《鸿蒙根底入门学习指南》

评论

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

这个站点使用 Akismet 来减少垃圾评论。了解你的评论数据如何被处理。

更多文章