【鸿蒙 HarmonyOS 4.0】应用状态:LocalStorage/AppStorage/PersistentStorage

本文主要是介绍【鸿蒙 HarmonyOS 4.0】应用状态:LocalStorage/AppStorage/PersistentStorage,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

一、介绍

如果要实现应用级的,或者多个页面的状态数据共享,就需要用到应用级别的状态管理的概念。

  • LocalStorage:页面级UI状态存储,通常用于UIAbility内、页面间的状态共享。
  • AppStorage:特殊的单例LocalStorage对象,由UI框架在应用程序启动时创建,为应用程序UI状态属性提供中央存储;
  • PersistentStorage:持久化存储UI状态,通常和AppStorage配合使用,选择AppStorage存储的数据写入磁盘,以确保这些属性在应用程序重新启动时的值与应用程序关闭时的值相同;

二、LocalStorage:页面级UI状态存储

LocalStorage是页面级的UI状态存储,通过@Entry装饰器接收的参数可以在页面内共享同一个LocalStorage实例。LocalStorage也可以在UIAbility实例内,在页面间共享状态。

LocalStorage根据与@Component装饰的组件的同步类型不同,提供了两个装饰器:

✍@LocalStorageProp装饰的变量和与LocalStorage中给定属性建立单向同步关系。

✍@LocalStorageLink装饰的变量和在@Component中创建与LocalStorage中给定属性建立双向同步关系。

2.1、从应用逻辑使用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() = 47link1.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

2.2、从UI内部使用LocalStorage

2.2.1、使用步骤:

①使用构造函数创建LocalStorage实例storage;

②使用@Entry装饰器将storage添加到LocalStoragePage顶层组件中;

③建立数据同步

@LocalStorageLink绑定LocalStorage对给定的属性,建立双向数据同步。

@LocalStorageProp绑定LocalStorage对给定的属性,建立单向数据同步

2.2.2、@LocalStorageProp和LocalStorage建立单向同步的场景

// 创建新实例并使用给定对象初始化
let storage = new LocalStorage({ name:'Tom' });
// 使LocalStorage可从@Component组件访问
@Entry(storage)
@Component
struct LocalStoragePage {// @LocalStorageProp变量装饰器与LocalStorage中的'name'属性建立单向绑定@LocalStorageProp('name') myName:string = ''build() {Row() {Column() {Text(this.myName).fontSize(50).fontWeight(FontWeight.Bold)//点击按钮后,只改变当前组件显示的myName,不会同步到LocalStorage中Button('更改名字').onClick(()=>{this.myName = 'jack'})//子组件ChildChild()}.width('100%')}.height('100%')}
}@Component
struct Child {// @LocalStorageProp变量装饰器与LocalStorage中的'name'属性建立单向绑定@LocalStorageProp('name') myName:string = ''build() {Row(){//当父组件改变时,子组件不会改变,myName显示 'Tom'Text(`Child-${this.myName}`).fontSize(30)}}
}

说明:

在上面的示例中, LocalStoragePage组件和Child组件分别在本地创建了与storage的'name'对应属性的单向同步的数据,可以看到:

  • LocalStoragePage中对this.myName的修改,只会在LocalStoragePage中生效,并没有同步回storage;
  • Child组件中,Text绑定的myName 依旧显示 'Tom'。

2.2.3、@LocalStorageLink和LocalStorage双向同步的场景

// 创建新实例并使用给定对象初始化
let storage = new LocalStorage({ name:'Tom' });
// 使LocalStorage可从@Component组件访问
@Entry(storage)
@Component
struct LocalStoragePage {// @LocalStorageLink变量装饰器与LocalStorage中的'name'属性建立双向绑定@LocalStorageLink('name') myName:string = ''build() {Row() {Column() {Text(this.myName).fontSize(50).fontWeight(FontWeight.Bold)//点击按钮后,当前组件显示的myName,会同步到LocalStorage中Button('更改名字').onClick(()=>{this.myName = 'jack'})//子组件ChildChild()}.width('100%')}.height('100%')}
}@Component
struct Child {// @LocalStorageLink变量装饰器与LocalStorage中的'name'属性建立双向绑定@LocalStorageLink('name') myName:string = ''build() {Row(){//当父组件改变时,子组件也会改变,myName显示 'jack'Text(`Child-${this.myName}`).fontSize(30)}}
}

说明:

在上面的示例中, LocalStoragePage组件和Child组件分别在本地创建了与storage的'name'对应属性的双向同步的数据,可以看到:

  • LocalStoragePage中对this.myName的修改,会同步到storage中
  • 父组件发生变化后,Child组件中,Text绑定的myName 也会改变为 'jack'。

拓展:

数据双向同步时,在父组件点击按钮通过this.myName进行名字的修改,还有一种写法是直接通过storage的set方法来改变name的值,如下写法:

点击按钮后,storage中的name值由'Tom'更改为'rose',父子组件中都发生了改变

        //点击按钮后,当前组件显示的myName,会同步到LocalStorage中Button('更改名字').onClick(()=>{// this.myName = 'jack'storage.set('name','rose')})

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

2.3.1、使用步骤

①​ 在所属UIAbility中创建LocalStorage实例,并调用windowStage.loadContent。

②创建2个UI页面,在UI页面通过GetShared接口获取在通过loadContent共享的LocalStorage实例

备注:LocalStorage.GetShared只在模拟器或者实机上才有效,不能在Preview预览器中使用。

// Comp1.etsimport router from '@ohos.router'
// 通过getShared接口获取stage共享的LocalStorage实例
let storage = LocalStorage.GetShared()
@Entry(storage)
@Component
struct Comp1 {@LocalStorageLink('cityName') cityName:string = ''build() {Row() {Column() {Text('Comp1'+'-'+this.cityName).fontSize(30).fontWeight(FontWeight.Bold)Button('去Comp1').onClick(()=>{router.pushUrl({url:'pages/Comp2'})})}.width('100%')}.height('100%')}
}
// Comp2.etsimport router from '@ohos.router'
// 通过getShared接口获取stage共享的LocalStorage实例
let storage = LocalStorage.GetShared()
@Entry(storage)
@Component
struct Comp2 {@State message:string = 'Comp2'@LocalStorageLink('cityName') cityName:string = ''build() {Row() {Column() {Text(this.message).fontSize(30).fontWeight(FontWeight.Bold)Button('返回Comp1').onClick(()=>{this.cityName = '深圳'router.back()})}.width('100%')}.height('100%')}
}

说明:

以上分别为Comp1页面与Comp2页面

Comp1页面通过getShared接口获取stage共享的LocalStorage实例,使用Text展示cityName初始值为'北京',并跳转至Comp2页面

Comp2页面也通过getShared接口获取stage共享的LocalStorage实例,在返回Comp1页面前,先将cityName值更改为'深圳',所以返回到Comp1页面时,呈现的cityName值已更改为'深圳'了

三、AppStorage:应用全局的UI状态存储 

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

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

✍@StorageProp(key)是和AppStorage中key对应的属性建立单向数据同步

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

3.1、从应用逻辑使用AppStorage

AppStorage.SetOrCreate('PropA', 47);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() == 47link1.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() == 49AppStorage.Get('PropA') // == 49
link1.get() // == 49
link2.get() // == 49
prop.get() // == 49

3.2、从UI内部使用AppStorage

@StorageLink变量装饰器与AppStorage配合使用,此装饰器使用AppStorage中的属性创建双向数据同步。


AppStorage.SetOrCreate('money', 50);@Entry
@Component
struct AppStoragePage {@StorageLink('money') storLink: number = 1;build() {Row() {Column() {Text(`AppStorage ${this.storLink}`).fontSize(30).onClick(() => this.storLink += 1)}.width('100%')}.height('100%')}
}

四、PersistentStorage:持久化存储UI状态

LocalStorage和AppStorage都是运行时的内存,但是在应用退出再次启动后,依然能保存选定的结果,那便需要用到PersistentStorage

PersistentStorage是应用程序中的可选单例对象。此对象的作用是持久化存储选定的AppStorage属性,以确保这些属性在应用程序重新启动时的值与应用程序关闭时的值相同。

PersistentStorage允许的类型和值有:

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

注意:

①PersistentStorage的持久化变量最好是小于2kb的数据,不要大量的数据持久化,因为PersistentStorage写入磁盘的操作是同步的,大量的数据本地化读写会同步在UI线程中执行,影响UI渲染性能。如果开发者需要存储大量的数据,建议使用数据库api。

②PersistentStorage只能在UI页面内使用,否则将无法持久化数据。

示例:

PersistentStorage.PersistProp('highScore', '0');

4.1、使用场景

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

1、初始化PersistentStorage:

PersistentStorage.PersistProp('money', 50);

 2、在AppStorage获取对应属性:

AppStorage.Get('money'); // returns 50

 或在组件内部定义:

@StorageLink('money') money:number = 10;

完整代码如下:

PersistentStorage.PersistProp('money',50)@Entry
@Component
struct PersistentStoragePage {@State message: string = 'Hello PersistentStoragePage'@StorageLink('money') money:number = 10build() {Row() {Column({space:10}) {Text(this.message).fontSize(30)// 应用退出时会保存当前结果。重新启动后,会显示上一次的保存结果Text(`money:${this.money}`).fontSize(30).fontWeight(FontWeight.Bold).onClick(()=>{this.money += 1})}.width('100%')}.height('100%')}
}

说明:

点击money所增加的数字,应用退出时会保存当前结果。重新启动页面,会显示上一次的保存结果

当前持久化存储在API9模拟器上暂不支持。

4.2、PersistentStorage与AppStorage访问顺序

正确顺序为:AppStorage需在 PersistentStorage之后访问

需要先判断是否需要覆盖上一次保存在PersistentStorage中的值,如果需要覆盖,再调用AppStorage的接口进行修改,如果不需要覆盖,则不调用AppStorage的接口。

PersistentStorage.PersistProp('aProp', 48);
if (AppStorage.Get('aProp') > 50) {// 如果PersistentStorage存储的值超过50,设置为47AppStorage.SetOrCreate('aProp',47);
}

这篇关于【鸿蒙 HarmonyOS 4.0】应用状态:LocalStorage/AppStorage/PersistentStorage的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/776547

相关文章

PostgreSQL简介及实战应用

《PostgreSQL简介及实战应用》PostgreSQL是一种功能强大的开源关系型数据库管理系统,以其稳定性、高性能、扩展性和复杂查询能力在众多项目中得到广泛应用,本文将从基础概念讲起,逐步深入到高... 目录前言1. PostgreSQL基础1.1 PostgreSQL简介1.2 基础语法1.3 数据库

Python中的filter() 函数的工作原理及应用技巧

《Python中的filter()函数的工作原理及应用技巧》Python的filter()函数用于筛选序列元素,返回迭代器,适合函数式编程,相比列表推导式,内存更优,尤其适用于大数据集,结合lamb... 目录前言一、基本概念基本语法二、使用方式1. 使用 lambda 函数2. 使用普通函数3. 使用 N

Python中yield的用法和实际应用示例

《Python中yield的用法和实际应用示例》在Python中,yield关键字主要用于生成器函数(generatorfunctions)中,其目的是使函数能够像迭代器一样工作,即可以被遍历,但不会... 目录python中yield的用法详解一、引言二、yield的基本用法1、yield与生成器2、yi

Python多线程应用中的卡死问题优化方案指南

《Python多线程应用中的卡死问题优化方案指南》在利用Python语言开发某查询软件时,遇到了点击搜索按钮后软件卡死的问题,本文将简单分析一下出现的原因以及对应的优化方案,希望对大家有所帮助... 目录问题描述优化方案1. 网络请求优化2. 多线程架构优化3. 全局异常处理4. 配置管理优化优化效果1.

从基础到高阶详解Python多态实战应用指南

《从基础到高阶详解Python多态实战应用指南》这篇文章主要从基础到高阶为大家详细介绍Python中多态的相关应用与技巧,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、多态的本质:python的“鸭子类型”哲学二、多态的三大实战场景场景1:数据处理管道——统一处理不同数据格式

Java Stream 的 Collectors.toMap高级应用与最佳实践

《JavaStream的Collectors.toMap高级应用与最佳实践》文章讲解JavaStreamAPI中Collectors.toMap的使用,涵盖基础语法、键冲突处理、自定义Map... 目录一、基础用法回顾二、处理键冲突三、自定义 Map 实现类型四、处理 null 值五、复杂值类型转换六、处理

分布式锁在Spring Boot应用中的实现过程

《分布式锁在SpringBoot应用中的实现过程》文章介绍在SpringBoot中通过自定义Lock注解、LockAspect切面和RedisLockUtils工具类实现分布式锁,确保多实例并发操作... 目录Lock注解LockASPect切面RedisLockUtils工具类总结在现代微服务架构中,分布

Python标准库之数据压缩和存档的应用详解

《Python标准库之数据压缩和存档的应用详解》在数据处理与存储领域,压缩和存档是提升效率的关键技术,Python标准库提供了一套完整的工具链,下面小编就来和大家简单介绍一下吧... 目录一、核心模块架构与设计哲学二、关键模块深度解析1.tarfile:专业级归档工具2.zipfile:跨平台归档首选3.

使用IDEA部署Docker应用指南分享

《使用IDEA部署Docker应用指南分享》本文介绍了使用IDEA部署Docker应用的四步流程:创建Dockerfile、配置IDEADocker连接、设置运行调试环境、构建运行镜像,并强调需准备本... 目录一、创建 dockerfile 配置文件二、配置 IDEA 的 Docker 连接三、配置 Do

深入浅出SpringBoot WebSocket构建实时应用全面指南

《深入浅出SpringBootWebSocket构建实时应用全面指南》WebSocket是一种在单个TCP连接上进行全双工通信的协议,这篇文章主要为大家详细介绍了SpringBoot如何集成WebS... 目录前言为什么需要 WebSocketWebSocket 是什么Spring Boot 如何简化 We