harmonyOs ArkTS零基础 - 应用级变量的状态管理（四）

最新推荐文章于 2024-07-04 20:00:00 发布
最新推荐文章于 2024-07-04 20:00:00 发布
阅读量827 收藏 9
点赞数 8
分类专栏： harmonyOs ArkTS零基础学习 文章标签： harmonyos 华为
版权声明：本文为博主原创文章，遵循 CC 4.0 BY 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/LIU_HONGPENG/article/details/139619364
版权

状态管理模块提供了应用程序的数据存储能力、持久化数据管理能力、UIAbility数据存储能力和应用程序需要的环境状态。

本文中T和S的含义如下：

类型描述
TClass，number，boolean，string和这些类型的数组形式。
Snumber，boolean，string。

AppStorage
Link
static Link(propName: string): any

与AppStorage中对应的propName建立双向数据绑定。如果给定的propName在AppStorage中存在，返回与AppStorage中propName对应属性的双向绑定数据。
双向绑定数据的修改会同步回AppStorage中，AppStorage会将变化同步到所有绑定该propName的数据和自定义组件中。
如果AppStorage中不存在propName，则返回undefined。

参数：

参数名类型必填参数描述
propNamestring是AppStorage中的属性名。

返回值：

类型描述
any返回双向绑定的数据，如果AppStorage不存在对应的propName，则返回undefined。
AppStorage.SetOrCreate('PropA', 47);
let linkToPropA1 = AppStorage.Link('PropA');
let linkToPropA2 = AppStorage.Link('PropA'); // linkToPropA2.get() == 47
linkToPropA1.set(48); // 双向同步: linkToPropA1.get() == linkToPropA2.get() == 48

双向绑定数据的修改会同步回AppStorage中，AppStorage会将变化同步到所有绑定该propName的数据和自定义组件中。


import router from '@ohos.router';

@Entry
@Component
struct Storage {
  onPageShow() {
    AppStorage.SetOrCreate("PropA", 47)
    let linkToPropA1 = AppStorage.Link('PropA');
    let linkToPropA2 = AppStorage.Link('PropA');
    console.info("AppStorage" + linkToPropA2.get())
    console.info("---------------------------------------------------------")
    linkToPropA1.set(48);
    console.info("AppStorage" + linkToPropA1.get())
    console.info("---------------------------------------------------------")
  }

  build() {
    Column() {
      Text("AppStorage测试")
        .width('100%')
        .height(50)
        .onClick(() => {
          router.pushUrl({
            url: 'pages/two/Second',
          }, router.RouterMode.Single)
        })
    }
  }
}


06-07 18:43:24.154 4852-1709/? I 0FEFE/JsApp: AppStorage47
06-07 18:43:24.154 4852-1709/? I 0FEFE/JsApp: AppStorage48

@Entry
@Component
struct Second {
  aboutToAppear() {
    let linkToPropA1 = AppStorage.Link('PropA');
    let linkToPropA2 = AppStorage.Link('PropA');
    console.info("AppStorage2" + linkToPropA2.get())
    console.info("---------------------------------------------------------")
    console.info("AppStorage2" + linkToPropA1.get())
  }

  build() {

  }
}

06-07 18:43:25.735 4852-1709/com.beijing.naxx.myapplication I 0FEFE/JsApp: AppStorage248
06-07 18:43:25.736 4852-1709/com.beijing.naxx.myapplication I 0FEFE/JsApp: AppStorage248

SetAndLink
static SetAndLink(propName: string, defaultValue: T): SubscribedAbstractProperty

与Link接口类似，如果给定的propName在AppStorage中存在，则返回该propName对应的属性的双向绑定数据。如果不存在，则使用defaultValue在AppStorage创建和初始化propName，返回其双向绑定数据。

参数

参数名类型必填参数描述
propNamestring是AppStorage中的属性名。
defaultValueT是当propName在AppStorage中不存在，使用defaultValue在AppStorage中初始化对应的propName。

返回值：

类型描述
SubscribedAbstractPropertySubscribedAbstractProperty的实例，和AppStorage中propName对应属性的双向绑定的数据。
@Component
@Entry
struct SetAndLink {
  onPageShow() {
    AppStorage.SetOrCreate("PropA", 47)
    let link1: SubscribedAbstractProperty<number> = AppStorage.SetAndLink("PropB", 49)
    let link2: SubscribedAbstractProperty<number> = AppStorage.SetAndLink("PropA", 50)

    console.info("AppStorage: ", link1.get())
    console.info("AppStorage: ", link2.get())
  }

  build() {

  }
}

06-07 19:01:45.361 8712-2792/? I 0FEFE/JsApp: AppStorage:  49
06-07 19:01:45.361 8712-2792/? I 0FEFE/JsApp: AppStorage:  47

与Link区别

LinkSetAndLink
返回双向绑定的数据，如果AppStorage不存在对应的propName，则返回undefined。当propName在AppStorage中不存在，使用defaultValue在AppStorage中初始化对应的propName。
如果propName存在，直接覆盖如果propName存在，不会覆盖原值

Prop
static Prop(propName: string): any

与AppStorage中对应的propName建立单向属性绑定。如果给定的propName在AppStorage中存在，则返回与AppStorage中propName对应属性的单向绑定数据。如果AppStorage中不存在propName，则返回undefined。单向绑定数据的修改不会被同步回AppStorage中。

参数

参数名类型必填描述
propNamestring是AppStorage中的属性名。

返回值

类型描述
any返回单向绑定的数据，如果AppStorage不存在对应的propName，则返回undefined。
import router from '@ohos.router';
@Entry
@Component
struct Prop {
  onPageShow() {
    AppStorage.SetOrCreate('PropA', 50);
    let prop1 = AppStorage.Prop("PropA")
    let prop2 = AppStorage.Prop("PropA")
    prop1.set(1)

    console.debug("Prop: "+prop1.get())
    console.debug("Prop: "+prop2.get())
  }

  build() {
    Column() {
      Text("Prop测试")
        .width('100%')
        .height(50)
        .onClick(() => {
          router.pushUrl({
            url: 'pages/two/Second',
          }, router.RouterMode.Single)
        })
    }
  }
}

06-07 20:36:13.480 30791-7850/? D 0FEFE/JsApp: Prop: 1
06-07 20:36:13.480 30791-7850/? D 0FEFE/JsApp: Prop: 50

单向绑定数据的修改不会被同步回AppStorage中

 AppStorage.SetOrCreate('PropA', 50);
 let prop1 = AppStorage.Prop("PropA")
 prop1.set(1)

Second

@Entry
@Component
struct Second {
  aboutToAppear() {
    let prop1 = AppStorage.Prop("PropA")
    let prop2 = AppStorage.Prop("PropA")
    console.info("Prop2: " + prop1.get())
    console.info("---------------------------------------------------------")
    console.info("Prop2: " + prop2.get())
  }

  build() {

  }
}

06-07 20:36:23.936 30791-7850/com.beijing.naxx.myapplication I 0FEFE/JsApp: Prop2: 50
06-07 20:36:23.936 30791-7850/com.beijing.naxx.myapplication I 0FEFE/JsApp: Prop2: 50

SetAndProp
static SetAndProp<“S”>(propName: string, defaultValue: S): SubscribedAbstractProperty<“S”>

与Prop接口类似。如果给定的propName在AppStorage存在，则返回该propName对应的属性的单向绑定数据。如果不存在，则使用defaultValue在AppStorage创建和初始化propName对应的属性，返回其单向绑定数据。

参数：

参数名类型必填参数描述
propNamestring是AppStorage中的属性名。
defaultValueS是当propName在AppStorage中不存在时，使用default在AppStorage中初始化对应的propName。

返回值：

类型描述
SubscribedAbstractProperty<“S”>SubscribedAbstractProperty<“S”>的实例。
AppStorage.SetOrCreate('PropA', 47);
let prop: SubscribedAbstractProperty<number> = AppStorage.SetAndProp('PropB', 49); // PropA -> 47, PropB -> 49

Has
static Has(propName: string): boolean

判断propName对应的属性是否在AppStorage中存在。

参数：

参数名类型必填参数描述
propNamestring是AppStorage中的属性名。

返回值：

类型描述
boolean如果propName对应的属性在AppStorage中存在，则返回true。不存在则返回false。
    if (AppStorage.Has("PropA")) {
      console.info("PropA：" + "存在")
    } else {
      console.info("PropA：" + "不存在")
    }

06-07 20:54:08.323 2581-8941/? I 0FEFE/JsApp: PropA：存在

Get
static Get(propName: string): T | undefined

获取propName在AppStorage中对应的属性。如果不存在返回undefined。

参数

参数名类型必填描述
propNamestring是AppStorage中的属性名。

返回值：

类型描述
T undefinedAppStorage中propName对应的属性，如果不存在返回undefined。
@Entry
@Component
struct Prop {
  onPageShow() {
    AppStorage.SetOrCreate('PropA', 47);
    let value: number = AppStorage.Get('PropA'); //

    console.debug("Get: " + value)

  }

  build() {

  }
}

06-07 20:57:52.024 3485-9186/? D 0FEFE/JsApp: Get: 47

Set
static Set(propName: string, newValue: T): boolean

在AppStorage中设置propName对应属性的值。如果newValue的值和propName对应属性的值相同，即不需要做赋值操作，状态变量不会通知UI刷新propName对应属性的值。

参数

参数名类型必填描述
propNamestring是AppStorage中的属性名。
newValueT是属性值，不能为undefined或null。

返回值：

类型描述
boolean如果AppStorage不存在propName对应的属性，或者设置的newValue是undefined或者null，返回false。设置成功则返回true
@Entry
@Component
struct Prop {
  onPageShow() {
    AppStorage.SetOrCreate('PropA', 48);
    let res: boolean = AppStorage.Set('PropA', 47)
    let res1: boolean = AppStorage.Set('PropB', 47)


    console.debug("Set: " + res)
    console.debug("Set: " + res1)

  }

  build() {

  }
}


06-07 21:02:02.097 4607-9483/? D 0FEFE/JsApp: Set: true
06-07 21:02:02.097 4607-9483/? D 0FEFE/JsApp: Set: false

SetOrCreate
static SetOrCreate(propName: string, newValue: T): void

如果propName已经在AppStorage中存在，并且newValue和propName对应属性的值不同，则设置propName对应属性的值为newValue，否则状态变量不会通知UI刷新propName对应属性的值。

如果propName不存在，则创建propName属性，值为newValue。setOrCreate只可以创建单个AppStorage的键值对，如果想创建多个AppStorage键值对，可以多次调用此方法。

参数：

参数名类型必填描述
propNamestring是AppStorage中的属性名。
newValueT是属性值，不能为undefined或null。
AppStorage.SetOrCreate('simpleProp', 121);

Delete
static Delete(propName: string): boolean

在AppStorage中删除propName对应的属性。

在AppStorage中删除该属性的前提是必须保证该属性没有订阅者。如果有订阅者，则返回false。删除成功返回true。

属性的订阅者为Link、Prop等接口绑定的propName，以及@StorageLink(‘propName’)和@StorageProp(‘propName’)。这就意味着如果自定义组件中使用@StorageLink(‘propName’)和@StorageProp(‘propName’)或者SubscribedAbstractProperty实例依旧对propName有同步关系，则该属性不能从AppStorage中删除。

参数

参数名类型必填描述
propNamestring是AppStorage中的属性名。

返回值：

类型描述
boolean如果AppStorage中有对应的属性，且该属性已经没有订阅者，则删除成功，返回true。如果属性不存在，或者该属性还存在订阅者，则返回false。
AppStorage.SetOrCreate('PropA', 47);
AppStorage.Link('PropA');
let res: boolean = AppStorage.Delete('PropA'); // false, PropA still has a subscriber

AppStorage.SetOrCreate('PropB', 48);
let res1: boolean = AppStorage.Delete('PropB'); // true, PropB is deleted from AppStorage successfully

Keys
static Keys(): IterableIterator

返回AppStorage中所有的属性名。

返回值：

类型描述
IterableIteratorAppStorage中所有的属性名。
@Entry
@Component
struct Prop {
  onPageShow() {
    AppStorage.SetOrCreate('PropB', 48);
    AppStorage.SetOrCreate('PropC', 49);
    AppStorage.SetOrCreate('PropD', 50);
    let keys: IterableIterator<string> = AppStorage.Keys()

    for (let key of keys) {
      console.log("AppStorageKeys: " + key);
    }

  }

  build() {

  }
}

06-07 21:40:49.378 15152-12073/? I 0FEFE/JsApp: AppStorageKeys: PropB
06-07 21:40:49.379 15152-12073/? I 0FEFE/JsApp: AppStorageKeys: PropC
06-07 21:40:49.379 15152-12073/? I 0FEFE/JsApp: AppStorageKeys: PropD

Clear9+
static Clear(): boolean

清除AppStorage的所有的属性。在AppStorage中清除所有属性的前提是，已经没有任何订阅者。如果有，则什么都不做返回false；删除成功返回true。

返回值：

类型描述
boolean删除所有的属性，如果当前有状态变量依旧引用此属性，返回false。
@Entry
@Component
struct Prop {
  onPageShow() {
    AppStorage.SetOrCreate('PropB', 48);
    AppStorage.SetOrCreate('PropC', 49);
    AppStorage.SetOrCreate('PropD', 50);

    let simple = AppStorage.Clear();
    if (simple) {
      console.info("staticClear：" + " 删除成功")
    } else {
      console.info("staticClear：" + " 删除失败")
    }
  }

  build() {

  }
}

06-07 21:45:15.853 16799-12433/? I 0FEFE/JsApp: staticClear： 删除成功

进一步验证，是否删除

@Entry
@Component
struct Prop {
  onPageShow() {
    AppStorage.SetOrCreate('PropB', 48);
    AppStorage.SetOrCreate('PropC', 49);
    AppStorage.SetOrCreate('PropD', 50);

    let simple = AppStorage.Clear();
    if (simple) {
      console.info("staticClear：" + " 删除成功")
    } else {
      console.info("staticClear：" + " 删除失败")
    }

    if (  AppStorage.Has("PropB")) {
      console.info("Has：" + " PropB 存在")
    } else {
      console.info("Has：" + " PropB 已被删除")
    }

  }

  build() {

  }
}

06-07 21:47:35.970 17420-12597/? I 0FEFE/JsApp: Has： PropB 已被删除

IsMutable
static IsMutable(propName: string): boolean

返回AppStorage中propName对应的属性是否是可变的。

参数：

参数名类型必填参数描述
propNamestring是AppStorage中的属性名。

返回值：

类型描述
boolean返回AppStorage中propNam对应的属性是否是可变的。

@Entry
@Component
struct Prop {
  onPageShow() {
    AppStorage.SetOrCreate('PropB', 48);

    let res: boolean = AppStorage.IsMutable('PropB');

    if (res) {
      console.info("IsMutable："+"PropB 可变")
    }else {
      console.info("IsMutable："+"PropB 不可变")
    }

  }

  build() {

  }
}

06-07 21:57:55.865 19601-13218/? I 0FEFE/JsApp: IsMutable：PropB 可变

Size
static Size(): number

返回AppStorage中的属性数量。

返回值：

类型描述
number返回AppStorage中属性的数量。
@Entry
@Component
struct Prop {
  onPageShow() {
    AppStorage.SetOrCreate('PropB', 48);
    AppStorage.SetOrCreate('PropB', 48); //增加重复一条数据，输出size 1 ，说明重复数据无效

    let res: number = AppStorage.Size()
    console.info("Size1：" + res)


    AppStorage.SetOrCreate('Propc', 48);
    let res2: number = AppStorage.Size()
    console.info("Size2：" + res2)


  }

  build() {

  }
}

06-07 22:07:31.030 23021-14058/? I 0FEFE/JsApp: Size1：1
06-07 22:07:31.030 23021-14058/? I 0FEFE/JsApp: Size2：2

LocalStorage9+

constructor9+
constructor(initializingProperties?: Object)

创建一个新的LocalStorage实例。使用Object.keys(initializingProperties)返回的属性和其数值，初始化LocalStorage实例。

从API version 9开始，该接口支持在ArkTS卡片中使用。

参数：

参数名类型必填参数描述
initializingPropertiesObject否用initializingProperties包含的属性和数值初始化LocalStorage。initializingProperties不能为undefined。

@Entry
@Component
struct Prop {
  onPageShow() {
	//创建方式一
    let storageA: LocalStorage = new LocalStorage();
    storageA.setOrCreate("PropA", 47)

    console.info("LocalStorage：" + storageA.get("PropA"))

	//创建方式二
    let storageB: LocalStorage = new LocalStorage({ 'PropB': 48 });
    console.info("LocalStorage：" + storageB.get("PropB"))
  }

  build() {

  }
}

06-07 22:15:20.800 25029-14597/? I 0FEFE/JsApp: LocalStorage：47
06-07 22:15:20.831 25029-14597/? I 0FEFE/JsApp: LocalStorage：48

GetShared9+
static GetShared(): LocalStorage
获取当前stage共享的LocalStorage实例。使用案例可参考将LocalStorage实例从UIAbility共享到一个或多个视图。

从API version 9开始，该接口支持在ArkTS卡片中使用。

模型约束：此接口仅可在Stage模型下使用。

返回值：

类型描述
LocalStorage返回LocalStorage实例

  /**
     * Get current LocalStorage shared from stage.
     * @StageModelOnly
     * @form
     * @since 9
     */
    static GetShared(): LocalStorage;
    
let storage: LocalStorage = LocalStorage.GetShared();

has9+
has(propName: string): boolean

判断propName对应的属性是否在LocalStorage中存在。

从API version 9开始，该接口支持在ArkTS卡片中使用。

参数：

参数名类型必填参数描述
propNamestring是LocalStorage中的属性名。

返回值：

类型描述
boolean如果propName对应的属性在AppStorage中存在，则返回true。不存在则返回false。
let storage: LocalStorage = new LocalStorage({ 'PropA': 47 });
storage.has('PropA'); // true

get9+
get(propName: string): T | undefined

获取propName在LocalStorage中对应的属性。

从API version 9开始，该接口支持在ArkTS卡片中使用。

参数：

参数名类型必填参数描述
propNamestring是LocalStorage中的属性名。

返回值：

类型描述
T undefinedLocalStorage中propName对应的属性，如果不存在返回undefined。
let storage: LocalStorage = new LocalStorage({ 'PropA': 47 });
let value: number = storage.get('PropA'); // 47

set9+
set(propName: string, newValue: T): boolean

在LocalStorage中设置propName对应属性的值。如果newValue的值和propName对应属性的值相同，即不需要做赋值操作，状态变量不会通知UI刷新propName对应属性的值。

从API version 9开始，该接口支持在ArkTS卡片中使用。

参数：

参数名类型必填参数描述
propNamestring是LocalStorage中的属性名
newValueT是属性值，不能为undefined或者null

返回值：

类型描述
boolean如果LocalStorage不存在propName对应的属性，或者设置的newValue是undefined或者null，返回false。设置成功返回true
let storage: LocalStorage = new LocalStorage({ 'PropA': 47 });
let res: boolean = storage.set('PropA', 47); // true
let res1: boolean = storage.set('PropB', 47); // false

setOrCreate9+
setOrCreate(propName: string, newValue: T): boolean

如果propName已经在LoStorage中存在，并且newValue和propName对应属性的值不同，则设置propName对应属性的值为newValue，否则状态变量不会通知UI刷新propName对应属性的值。

如果propName不存在，则创建propName属性，值为newValue。setOrCreate只可以创建单个LocalStorage的键值对，如果想创建多个LocalStorage键值对，可以多次调用此方法。

从API version 9开始，该接口支持在ArkTS卡片中使用。

参数：

参数名类型必填参数描述
propNamestring是LocalStorage中的属性名
newValueT是属性值，不能为undefined或者null

返回值：

类型描述
boolean如果设置的newValue是undefined或者null，返回false。
如果LocalStorage存在propName，则更新其值为newValue，返回true。
如果LocalStorage不存在propName，则创建propName，并初始化其值为newValue，返回true
let storage: LocalStorage = new LocalStorage({ 'PropA': 47 });
let res: boolean =storage.setOrCreate('PropA', 121); // true
let res1: boolean =storage.setOrCreate('PropB', 111); // true
let res2: boolean =storage.setOrCreate('PropB', undefined); // false

link9+
link(propName: string): SubscribedAbstractProperty

如果给定的propName在LocalStorage实例中存在，则返回与LocalStorage中propName对应属性的双向绑定数据。

双向绑定数据的修改会被同步回LocalStorage中，LocalStorage会将变化同步到所有绑定该propName的数据和Component中。

如果LocalStorage中不存在propName，则返回undefined。

从API version 9开始，该接口支持在ArkTS卡片中使用

参数：

参数名类型必填参数描述
propNamestring是LocalStorage中的属性名

返回值：

类型描述
SubscribedAbstractPropertySubscribedAbstractProperty的实例，如果AppStorage不存在对应的propName，再返回undefined。
let storage: LocalStorage = new LocalStorage({ 'PropA': 47 });
let linkToPropA1: SubscribedAbstractProperty<number> = storage.link('PropA');
let linkToPropA2: SubscribedAbstractProperty<number> = storage.link('PropA'); // linkToPropA2.get() == 47
linkToPropA1.set(48); // 双向同步: linkToPropA1.get() == linkToPropA2.get() == 48

setAndLink9+
setAndLink(propName: string, defaultValue: T): SubscribedAbstractProperty

与Link接口类似，如果给定的propName在LocalStorage存在，则返回该propName对应的属性的双向绑定数据。如果不存在，则使用defaultValue在LocalStorage创建和初始化propName，返回其双向绑定数据。

从API version 9开始，该接口支持在ArkTS卡片中使用。

参数名类型必填参数描述
propNamestring是LocalStorage中的属性名
defaultValueT是当propName在LocalStorage中不存在，使用default在LocalStorage中初始化对应的propName。

返回值：

类型描述
SubscribedAbstractProperty<“T”>SubscribedAbstractProperty的实例，如果AppStorage不存在对应的propName，再返回undefined。
let storage: LocalStorage = new LocalStorage({ 'PropA': 47 });
let link1: SubscribedAbstractProperty<number> = storage.setAndLink('PropB', 49); // Create PropB 49
var link2: SubscribedAbstractProperty<number> = storage.setAndLink('PropA', 50); // PropA exists, remains 47

prop9+
prop<“S">(propName: string): SubscribedAbstractProperty<”S“>

如果给定的propName在LocalStorage存在，则返回与LocalStorage中propName对应属性的单向绑定数据。如果LocalStorage中不存在propName，则返回undefined。单向绑定数据的修改不会被同步回LocalStorage中。

从API version 9开始，该接口支持在ArkTS卡片中使用。

参数：

参数名类型必填参数描述
propNamestring是LocalStorage中的属性名

返回值：

类型描述
SubscribedAbstractProperty<”S“>SubscribedAbstractProperty<”S“>的实例，如果AppStorage不存在对应的propName，则返回undefined
let storage: LocalStorage = new LocalStorage({ 'PropA': 47 });
let prop1: SubscribedAbstractProperty<number> = storage.prop('PropA');
let prop2: SubscribedAbstractProperty<number> = storage.prop('PropA');
prop1.set(1); // one-way sync: prop1.get()=1; but prop2.get() == 47

setAndProp9+
setAndProp<”S>(propName: string, defaultValue: S): SubscribedAbstractProperty<“S>

propName在LocalStorage存在，则返回该propName对应的属性的单向绑定数据。如果不存在，则使用defaultValue在LocalStorage创建和初始化propName对应的属性，返回其单向绑定数据

从API version 9开始，该接口支持在ArkTS卡片中使用。

参数：

参数名类型必填参数描述
propNamestring是LocalStorage中的属性名
defaultValueS是当propName在AppStorage中不存在，使用default在AppStorage中初始化对应的propName

返回值：

类型描述
SubscribedAbstractProperty<”S>SubscribedAbstractProperty<“S>的实例，和AppStorage中propName对应属性的单向绑定的数据
let storage: LocalStorage = new LocalStorage({ 'PropA': 47 });
let prop: SubscribedAbstractProperty<number> = storage.setAndProp('PropB', 49); // PropA -> 47, PropB -> 49

delete9+
delete(propName: string): boolean

在LocalStorage中删除propName对应的属性。删除属性的前提是该属性已经没有订阅者，如果有则返回false。删除成功则返回true。

属性的订阅者是link，prop接口绑定的propName，以及@LocalStorageLink(‘propName’)和@LocalStorageProp(‘propName’)。如果自定义组件Component中使用或者SubscribedAbstractProperty（link和prop接口的返回类型）依旧有同步关系，则该属性不能从LocalStorage中删除。

从API version 9开始，该接口支持在ArkTS卡片中使用。
参数：

参数名类型必填参数描述
propNamestring是LocalStorage中的属性名

返回值：

类型描述
boolean如果LocalStorage中有对应的属性，且该属性已经没有订阅者，则删除成功返回true。如果属性不存在，或者该属性还存在订阅者，则返回false。
let storage: LocalStorage = new LocalStorage({ 'PropA': 47 });
storage.link('PropA');
let res: boolean = storage.delete('PropA'); // false, PropA still has a subscriber
let res1: boolean = storage.delete('PropB'); // false, PropB is not in storage
storage.setOrCreate('PropB', 48);
let res2: boolean = storage.delete('PropB'); // true, PropB is deleted from storage successfully

keys9+
keys(): IterableIterator<”string>

返回LocalStorage中所有的属性名。

从API version 9开始，该接口支持在ArkTS卡片中使用。

返回值：

参数名类型必填参数描述
propNamestring是LocalStorage中的属性名
let storage: LocalStorage = new LocalStorage({ 'PropA': 47 });
let keys: IterableIterator<string> = storage.keys();

size9+
size(): number

返回LocalStorage中的属性数量。

从API version 9开始，该接口支持在ArkTS卡片中使用。

返回值：

参数名参数描述
number返回键值对的数量。
let storage: LocalStorage = new LocalStorage({ 'PropA': 47 });
let res: number = storage.size(); // 1

clear9+
clear(): boolean

清除LocalStorage的所有的属性。在LocalStorage中清除所有属性的前提是已经没有任何订阅者。如果有则返回false；清除成功返回true。

从API version 9开始，该接口支持在ArkTS卡片中使用。
返回值：

类型描述
boolean如果LocalStorage中的属性已经没有任何订阅者，则清除成功，返回true。否则返回false
let storage: LocalStorage = new LocalStorage({ 'PropA': 47 });
let res: boolean = storage.clear(); // true, there are no subscribers

SubscribedAbstractProperty

get9+
abstract get(): T

读取从AppStorage/LocalStorage同步属性的数据。

从API version 9开始，该接口支持在ArkTS卡片中使用。

返回值：

类型描述
TAppStorage/LocalStorage同步属性的数据。
AppStorage.SetOrCreate('PropA', 47); 
let prop1 = AppStorage.Prop('PropA');    
prop1.get(); //  prop1.get()=47

set9+
abstract set(newValue: T): void

设置AppStorage/LocalStorage同步属性的数据。

从API version 9开始，该接口支持在ArkTS卡片中使用。

参数：

类型描述必填参数描述
newValueT是要设置的数据
AppStorage.SetOrCreate('PropA', 47);
let prop1 = AppStorage.Prop('PropA');
prop1.set(1); //  prop1.get()=1

PersistentStorage

PersistProp
static PersistProp(key: string, defaultValue: T): void

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

确定属性的类型和值的顺序如下：

  1. 如果PersistentStorage文件中存在key对应的属性，在AppStorage中创建对应的propName，并用在PersistentStorage中找到的key的属性初始化；
  2. 如果PersistentStorage文件中没有查询到key对应的属性，则在AppStorage中查找key对应的属性。如果找到key对应的属性，则将该属性持久化；
  3. 如果AppStorage也没查找到key对应的属性，则在AppStorage中创建key对应的属性。用defaultValue初始化其值，并将该属性持久化。

参数：

类型描述必填参数描述
keystring是属性名。
defaultValueT是在PersistentStorage和AppStorage未查询到时，则使用默认值初始化初始化它。不允许为undefined和null

AppStorage的属性向PersistentStorage中持久化的允许的类型是：
1: number，string，boolean，enum基础类型。
2: Object中可序列化的属性。
3: 不允许undefined和null。

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

DeleteProp
static DeleteProp(key: string): void

PersistProp的逆向操作。将key对应的属性从PersistentStorage删除，后续AppStorage的操作，对PersistentStorage不会再有影响

参数：

类型描述必填参数描述
keystring是PersistentStorage中的属性名。
PersistentStorage.DeleteProp('highScore');

Keys
static Keys(): Array

返回所有持久化属性的key的数组。

返回值：

类型描述
Array<“string>返回所有持久化属性的key的数组
let keys: Array<string> = PersistentStorage.Keys();

Environment

EnvProp
static EnvProp<”S>(key: string, value: S): boolean

将Environment的内置环境变量key存入AppStorage中。如果系统中未查询到Environment环境变量key的值，则使用默认值value，存入成功，返回true。如果AppStorage已经有对应的key，则返回false。

所以建议在程序启动的时候调用该接口。

在没有调用EnvProp，就使用AppStorage读取环境变量是错误的。

参数：

参数名类型必填参数描述
keystring是环境变量名称，支持的范围详见内置环境变量说明
valueS是查询不到环境变量key，则使用value作为默认值存入AppStorage中。

返回值：

类型描述
boolean如果key对应的属性在AppStorage中存在，则返回false。不存在则在AppStorage中创建key对应的属性，返回true

Environment.EnvProp('accessibilityEnabled', 'default');

内置环境变量说明

key类型说明
accessibilityEnabledstring无障碍屏幕朗读是否启用
colorModeColorMode深浅色模式，可选值为：- ColorMode.LIGHT：浅色模式；- ColorMode.DARK：深色模式
fontScalenumber字体大小比例。
fontWeightScalenumber字重比例。
layoutDirectionLayoutDirection布局方向类型，可选值为：- LayoutDirection.LTR：从左到右；- LayoutDirection.RTL：从右到左
languageCodestring当前系统语言，小写字母，例如zh

EnvProps
static EnvProps(props: {key: string; defaultValue: any;}[]): void

和EnvProp类似，不同点在于参数为数组，可以一次性初始化多个数据。建议在应用启动时调用，将系统环境变量批量存入AppStorage中。

参数：

参数名类型必填参数描述
props{key: string, defaultValue: any}[]是系统环境变量和默认值的键值对的数组。
Environment.EnvProps([{ key: 'accessibilityEnabled', defaultValue: 'default' }, { key: 'languageCode', defaultValue: 'en'}, { key: 'prop', defaultValue: 'hhhh' }]);

Keys
static Keys(): Array

返回环境变量的属性key的数组。

返回值：

类型描述
Array<“string>返回关联的系统项数组。
Environment.EnvProps([{ key: 'accessibilityEnabled', defaultValue: 'default' }, { key: 'languageCode', defaultValue: 'en' }, { key: 'prop', defaultValue: 'hhhh' }]);

let keys: Array<string> = Environment.Keys(); // accessibilityEnabled, languageCode, prop
刘了个刘
关注
  • 8
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
深入理解ArkTs中的AppStorage和LocalStorage
一键难忘的博客
11-30 1660
通过深入理解ARKTS中的AppStorage和LocalStorage，我们能够更好地利用这两个特性进行应用状态的管理和共享。合理使用这些工具，可以提高代码的可维护性和性能，使得开发更加高效。在实际开发中，根据具体需求和场景选择合适的状态管理方式，将有助于构建更健壮、可扩展的HarmonyOS应用。ARKTS中的AppStorage和LocalStorage为开发者提供了强大的状态管理工具，使得应用程序能够高效地共享和管理状态数据。
【OpenHarmony】ArkTS 语法基础 ⑥ ( ArkTS 状态管理 - @Link 装饰器 )
06-05
【OpenHarmony】ArkTS 语法基础 ⑥ ( ArkTS 状态管理 | @Link 装饰器 | 子组件定义使用 @Link 变量 | 父容器中定义 @State 变量并绑定子组件变量 ) https://hanshuliang.blog.csdn.net/article/details/139466799 ...
构建第一个ArkTS应用之@AppStorage：应用全局的UI状态存储
二当家的
05-08 1038
AppStorage是在应用启动的时候会被创建的单例。它的目的是为了提供应用状态数据的中心存储，这些状态数据在应用级别都是可访问的。AppStorage将在应用运行过程保留其属性。属性通过唯一的键字符串值访问。AppStorage可以和UI组件同步，且可以在应用业务逻辑中被访问。AppStorage中的属性可以被双向同步，数据可以是存在于本地或远程设备上，并具有不同的功能，比如数据持久化（详见这些数据是通过业务逻辑中实现，与UI解耦，如果希望这些数据在UI中使用，需要用到和。
鸿蒙Harmony应用开发—ArkTS-应用级变量的状态管理
m0_64420071的博客
03-23 928
状态管理模块提供了应用程序的数据存储能力、持久化数据管理能力、UIAbility数据存储能力和应用程序需要的环境状态。
HarmonyOS学习路之方舟开发框架—学习ArkTS语言（状态管理 七）
爱吃土豆丝的打工人的博客
09-12 803
PersistentStorage将选定的AppStorage属性保留在设备磁盘上。应用程序通过API，以决定哪些AppStorage属性应借助PersistentStorage持久化。UI和业务逻辑不直接访问PersistentStorage中的属性，所有属性访问都是对AppStorage的访问，AppStorage中的更改会自动同步到PersistentStorage。PersistentStorage和AppStorage中的属性建立双向同步。
鸿蒙方舟UI开发框架-eTS状态管理
m0_61077450的博客
03-21 2291
组件内的状态管理 1：@State 使用方式：@State count: number = 1 @State状态数据具有以下特征： 支持多种类型：允许class、number、boolean、string强类型的按值和按引用类型。允许这些强类型构成的数组，即Array、Array、Array、Array。不允许object和any。 支持多实例：组件不同实例的内部状态数据独立。 内部私有：标记为@State的属性是私有变量，只能在组件内访问。 需要本地初始化：必须为所有@State变量分配初始值，将变量
HarmonyOS应用开发-保存到变量.doc
06-07
HarmonyOS应用开发-保存到变量
HarmonyOS应用开发者基础题库
12-29
【HarmonyOS应用开发者基础题库】主要涵盖了鸿蒙系统应用开发的基础知识，涉及DevEco Studio集成开发环境、 ArkTS编程语言、应用程序框架以及页面布局设计等方面。 1. **DevEco Studio**：它是华为提供的开发...
HarmonyOS应用开发者认证题目满分指南
01-27
【 HarmonyOS 应用开发者认证知识点详解】 HarmonyOS 是华为推出的一款面向全场景的分布式操作系统，旨在提供无缝跨设备的用户体验。为了帮助开发者快速掌握HarmonyOS应用开发，官方提供了"HarmonyOS第一课"系列...
掌握HarmonyOS框架的ArkTs如何管理和共享状态数据
dsgdauigfs的博客
12-01 479
通过深入理解ARKTS中的AppStorage和LocalStorage，我们能够更好地利用这两个特性进行应用状态的管理和共享。合理使用这些工具，可以提高代码的可维护性和性能，使得开发更加高效。在实际开发中，根据具体需求和场景选择合适的状态管理方式，将有助于构建更健壮、可扩展的HarmonyOS应用。ARKTS中的AppStorage和LocalStorage为开发者提供了强大的状态管理工具，使得应用程序能够高效地共享和管理状态数据。
鸿蒙HarmonyOS项目实战开发：分布式账本(1)，鸿蒙面试题及答案2024百度
2401_84185441的博客
04-16 904
/ { previewUrl: “/picture/icon10_10.png”, title: “宠物” ,number:10},// { previewUrl: “/picture/icon9_9.png”, title: “生活” ,number:9},TextInput({ placeholder: ‘输入收支时间’, text: this.payTime })新建一个账单数据 添加到分布式数据。在另一台设备监听并获取显示该条数据。新建一个账单数据 添加到分布式数据。
鸿蒙开发-ArkTS 语言-状态管理
游小北的博客
11-25 2512
基于官方文档学习ArtTS
鸿蒙HarmonyOS应用开发-窥探：State装饰器
shudaoshanQAQ的博客
01-02 1202
类型参数TFunction必须是函数，实际上就是构造方法。类装饰器的返回值，要么是返回处理后的原始构造方法，要么返回一个新的构造方法target：（对于实例属性）类的原型对象（prototype），或者（对于静态属性）类的构造函数。propertyKey：所装饰属性的属性名，注意类型有可能是字符串，也有可能是 Symbol 值) => void;target：（对于类的静态方法）类的构造函数，或者（对于类的实例方法）类的原型。propertyKey：所装饰方法的方法名，类型为。
鸿蒙开发基础，ArkTs语言-运行你的第一个Hello World
m0_62167422的博客
12-04 2283
ArkTs是目前鸿蒙开发的主要语言，目前鸿蒙的主推模型Stage的新版本(3.1.0(API 9))开发不支持Java和JavaScript了，所以开发鸿蒙应用学习ArkTs是很有必要的。ArkTs是Ts(TypeScript)的扩展，后面的介绍就是介绍ArkTs的特性，Ts部分可以参考：5分钟上手TypeScript · TypeScript中文网 · TypeScript——JavaScript的超集。
【鸿蒙开发】第十章 ArkTS语言UI范式-状态管理（二）
Yvan
01-13 1395
上章节 第九章 ArkTS语言UI范式-状态管理 我们了解了状态管理是什么，分别有哪些状态管理，并介绍了组件内状态管理的相关知识，本章节接着上一章节的内容，我们来继续学习`应用状态管理`和`其他状态管理`的相关知识。
【鸿蒙开发】第六章 ArkTS基础知识 - 类、接口及泛型
Yvan
12-16 6922
大概了解ArkTS的基础类型和用法和ts的大致基本相同，与Java也极其相似。本章节我们继续学习ArkTS类和接口、泛型等相关知识，为后续鸿蒙应用开发夯实基础。
基础篇：ArkTS基础语法介绍
最新发布
风中追风
07-04 799
目前流行的编程语言TypeScript是在JavaScript基础上通过添加类型定义扩展而来的，而ArkTS则是TypeScript的进一步扩展。TypeScript深受开发者的喜爱，因为它提供了一种更结构化的JavaScript编码方法。ArkTS旨在保持TypeScript的大部分语法，为现有的TypeScript开发者实现无缝过渡，让移动开发者快速上手ArkTS。ArkTS比typeScipt更严格，它的一大特性是它专注于低运行时开销。
HarmonyOS开发基础：DevEcoStudio, ArkTS与应用框架
"HarmonyOS应用开发者基础题库涵盖了鸿蒙系统开发的基本概念、工具使用、 ArkTS语言知识以及应用程序框架的理解。" 在HarmonyOS应用开发中，DevEco Studio扮演着至关重要的角色，它是一个全面的集成开发环境，专为...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

刘了个刘

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值