HarmonyOS API：应用级变量的状态管理

版本：v3.1 Beta

应用级变量的状态管理

更新时间: 2023-02-17 09:19

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

说明

本模块首批接口从API version 7开始支持，后续版本的新增接口，采用上角标单独标记接口的起始版本。

AppStorage

Link

static Link(propName: string): any

与AppStorage中对应的propName建立双向数据绑定。

参数：

返回值：

AppStorage.SetOrCreate("PropA", 47); 
let linkToPropA1 = AppStorage.Link("PropA"); 
var linkToPropA2  = AppStorage.Link("PropA");       // linkToPropA2.get() == 47
linkToPropA1.set(48);      // 双向同步: linkToPropA1.get() == linkToPropA2.get() == 48

SetAndLink

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

与Link接口类似，如果当前的key保存于AppStorage，则返回该key对应的value。如果该key未被创建，则创建一个对应default值的Link返回。

参数：

返回值：

AppStorage.SetOrCreate("PropA", 47); 
var link1 = AppStorage.SetAndLink("PropB", 49);   // Create PropB 49 
var link2 = AppStorage.SetAndLink("PropA", 49); // PropA exists, remains 47

Prop

static Prop(propName: string): any

与AppStorage中对应的propName建立单向属性绑定。

参数：

返回值：

AppStorage.SetOrCreate("PropA", 47); 
var prop1 = AppStorage.Prop("PropA");   
var prop2 = AppStorage.Prop("PropA"); 
prop1.set(1);        // one-way sync: prop1.get()=1; but prop2.get() == 47

SetAndProp

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

与Prop接口类似，如果当前的key保存于AppStorage，则返回该key对应的value。如果该key未被创建，则创建一个对应default值的Prop返回。

参数：

返回值：

AppStorage.SetOrCreate("PropA", 47);
var prop = AppStorage.SetAndProp("PropB", 49);    // PropA -> 47, PropB -> 49

Has

static Has(propName: string): boolean

判断对应键值的属性是否存在。

参数：

返回值：

let simple = AppStorage.Has('simpleProp');

Get

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

通过此接口获取对应propName值的value。

参数：

返回值：

AppStorage.SetOrCreate("PropA", 47); 
let value= AppStorage.Get("PropA"); // 47

Set

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

对已保存的propName值，替换其value值。

参数：

返回值：

let simple = AppStorage.Set('simpleProp', 121);

SetOrCreate

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

创建或更新setOrCreate内部的值。

参数：

let simple = AppStorage.SetOrCreate('simpleProp', 121);

Delete

static Delete(propName: string): boolean

删除propName指定的键值对。

参数：

返回值：

let simple = AppStorage.Delete('simpleProp');

Keys

static Keys(): IterableIterator<string>

查找所有键。

返回值：

let simple = AppStorage.Keys();

staticClear

static staticClear(): boolean

删除所有的属性。

从API version 9开始废弃，推荐使用​​Clear9+​​。

返回值：

let simple = AppStorage.staticClear();

Clear⁹⁺

static Clear(): boolean

删除所有的属性。

返回值：

let simple = AppStorage.Clear();

IsMutable

static IsMutable(propName: string): boolean

查询属性及状态。

参数：

返回值：

let simple = AppStorage.IsMutable('simpleProp');

Size

static Size(): number

存在的键值对的个数。

返回值：

let simple = AppStorage.Size();

LocalStorage⁹⁺

constructor⁹⁺

constructor(initializingProperties?: Object)

创建一个新的LocalStorage对象，并进行初始化。

参数：

let storage = new LocalStorage();

GetShared⁹⁺

static GetShared(): LocalStorage

获取当前共享的LocalStorage对象。

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

返回值：

let storage = LocalStorage.GetShared();

has⁹⁺

has(propName: string): boolean

判断属性值是否存在。

参数：

返回值：

let storage = new LocalStorage();
storage.has('storageSimpleProp');

get⁹⁺

get<T>(propName: string): T

获取对应propName的值。

参数：

返回值：

let storage = new LocalStorage();
let simpleValue = storage.get('storageSimpleProp');

set⁹⁺

set<T>(propName: string, newValue: T): boolean

设置propName在LocalStorage中对应的值。

参数：

返回值：

let storage = new LocalStorage();
storage.set('storageSimpleProp', 121);

setOrCreate⁹⁺

setOrCreate<T>(propName: string, newValue?: T): boolean

如果propName存在，则用newValue更新propName的值。如果propName不存在，则创建并用newValue初始化propName的值。

参数：

返回值：

let storage = new LocalStorage();
storage.setOrCreate('storageSimpleProp', 121);

link⁹⁺

link<T>(propName: string): T

与LocalStorage双向数据绑定。

参数：

返回值：

let storage = new LocalStorage({'storageSimpleProp': 47});
let link1 = storage.link('storageSimpleProp');

setAndLink⁹⁺

setAndLink<T>(propName: string, defaultValue: T): T

与link接口类似，双向数据绑定LocalStorage。

参数：

返回值：

let storage = new LocalStorage();
let localStorage = storage.setAndLink('storageSimpleProp', 121);

prop⁹⁺

prop<T>(propName: string): T

单向属性绑定的一种。更新组件的状态。

参数：

返回值：

let storage = new LocalStorage();
let localStorage = storage.prop('storageSimpleProp');

setAndProp⁹⁺

setAndProp<T>(propName: string, defaultValue: T): T

与Prop接口类似，存在localStorage的单向数据绑定prop值。

参数：

返回值：

let storage = new LocalStorage();
let localStorage = storage.setAndProp('storageSimpleProp', 121);

delete⁹⁺

delete(propName: string): boolean

删除propName指定的键值对。

参数：

返回值：

let storage = new LocalStorage();
storage.delete('storageSimpleProp');

keys⁹⁺

keys(): IterableIterator<string>

查找所有键。

返回值：

let storage = new LocalStorage();
let simple = storage.keys();

size⁹⁺

size(): number

存在的键值对的个数。

返回值：

let storage = new LocalStorage();
let simple = storage.size();

clear⁹⁺

clear(): boolean

删除所有的属性。

返回值：

let storage = new LocalStorage();
let simple = storage.clear();

PersistentStorage

PersistProp

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

关联命名的属性AppStorage变为持久化数据。

参数：

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

DeleteProp

static DeleteProp(key: string): void

取消双向数据绑定，该属性值将从持久存储中删除。

参数：

PersistentStorage.DeleteProp('highScore');

PersistProps

static PersistProps(properties: {key: string, defaultValue: any;}[]): void

关联多个命名的属性绑定。

参数：

PersistentStorage.PersistProps([{key: 'highScore', defaultValue: '0'},{key: 'wightScore',defaultValue: '1'}]);

Keys

static Keys(): Array<string>

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

返回值：

let simple = PersistentStorage.Keys();

说明

• PersistProp接口使用时，需要保证输入对应的key应当在AppStorage存在。
• DeleteProp接口使用时，只能对本次启动已经link过的数据生效。

Environment

EnvProp

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

关联此系统项到AppStorage中，建议在app启动时使用此接口。如果该属性在AppStorage已存在，返回false。请勿使用AppStorage中的变量，在调用此方法关联环境变量。

参数：

返回值：

内置环境变量说明：

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

EnvProps

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

关联此系统项数组到AppStorage中。

参数：

Environment.EnvProps([{key: 'accessibilityEnabled', defaultValue: 'default'},{key: 'accessibilityUnEnabled', defaultValue: 'undefault'}]);

Keys

static Keys(): Array<string>

返回关联的系统项。

返回值：

let simple = Environment.Keys();

文章转载自：​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/ts-state-management-0000001478181453-V3?catalogVersion=V3​​