目录

@ohos.util.HashMap (非线性容器HashMap)

HashMap底层采用数组、链表和红黑树实现,支持高效查询、插入和删除。HashMap存储内容基于键值对映射,不允许重复的key,且一个key只能对应一个value。

HashMap和TreeMap相比,HashMap依据键的hashCode(哈希码)存取数据,访问速度较快,但不保证键的有序性。而TreeMap是有序存储和访问,查询效率较低。

HashSet基于HashMap实现。HashMap的输入参数由key、value两个值组成。在HashSet中,只对value对象进行存储和管理。

推荐使用场景: 需要快速存取、删除以及插入键值对数据时,推荐使用HashMap。典型应用场景包括数据缓存、键值查找表、配置参数管理等。

文档中使用了泛型,包含以下泛型参数:

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

容器类使用静态语言实现,限制了存储位置和属性,不支持自定义属性和方法。

导入模块

import { HashMap } from '@kit.ArkTS';

HashMap

[h2]属性

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

名称 类型 只读 可选 说明
length number 是 否 HashMap的元素个数。

[h2]constructor

constructor()

创建HashMap实例。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

错误码:

以下错误码的详细介绍请参见语言基础类库错误码。

错误码ID 错误信息
10200012 The HashMap's constructor cannot be directly invoked.

示例:

let hashMap = new HashMap<string, number>();

[h2]isEmpty

isEmpty(): boolean

判断该HashMap是否为空。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

返回值:

类型 说明
boolean 为空返回true,不为空返回false。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码。

错误码ID 错误信息
10200011 The isEmpty method cannot be bound.

示例:

let hashMap = new HashMap<string, number>();
let result = hashMap.isEmpty();
console.info("result:", result);  // result: true

[h2]hasKey

hasKey(key: K): boolean

判断此HashMap中是否包含指定key。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
key K 是 指定要查询的键,用于判断HashMap中是否包含该键。

返回值:

类型 说明
boolean 包含指定key返回true,不包含指定key返回false。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码。

错误码ID 错误信息
10200011 The hasKey method cannot be bound.

示例:

let hashMap = new HashMap<string, number>();
hashMap.set("squirrel", 123);
let result = hashMap.hasKey("squirrel");
console.info("result:", result);  // result: true

[h2]hasValue

hasValue(value: V): boolean

判断此HashMap中是否包含指定value。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
value V 是 指定要查询的值,用于判断HashMap中是否包含该值。

返回值:

类型 说明
boolean 包含指定的value返回true,不包含指定的value返回false。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码。

错误码ID 错误信息
10200011 The hasValue method cannot be bound.

示例:

let hashMap = new HashMap<string, number>();
hashMap.set("squirrel", 123);
let result = hashMap.hasValue(123);
console.info("result:", result);  // result: true

[h2]get

get(key: K): V

获取指定key对应的value,不存在返回undefined。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
key K 是 指定要获取其对应value的键。

返回值:

类型 说明
V 返回key映射的value值;key不存在时返回undefined。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码。

错误码ID 错误信息
10200011 The get method cannot be bound.

示例:

let hashMap = new HashMap<string, number>();
hashMap.set("squirrel", 123);
hashMap.set("sparrow", 356);
let result = hashMap.get("sparrow");
console.info("result:", result);  // result: 356

[h2]setAll

setAll(map: HashMap<K, V>): void

将指定HashMap中的所有元素设置到当前HashMap中,若当前HashMap中已存在相同key,则对应value会被覆盖。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
map HashMap<K, V> 是 需要将其全部元素添加到当前HashMap的源HashMap对象。若map与当前HashMap存在重复key,map中的value将替换当前HashMap中对应key的value。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码。

错误码ID 错误信息
10200011 The setAll method cannot be bound.

示例:

let hashMap = new HashMap<string, number>();
hashMap.set("squirrel", 123);
hashMap.set("sparrow", 356);
let newHashMap = new HashMap<string, number>();
newHashMap.set("newMap", 99);
hashMap.setAll(newHashMap);
let result = hashMap.hasKey("newMap");
console.info("result:", result);  // result: true

[h2]set

set(key: K, value: V): Object

向HashMap中添加或更新一个键值对。若key不存在,则添加新的键值对;若key已存在,则更新其对应的value。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
key K 是 添加或更新的键名。若key已存在,将替换对应的value。
value V 是 添加或更新的值。

返回值:

类型 说明
Object 返回包含添加或更新后元素的当前HashMap实例。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码。

错误码ID 错误信息
10200011 The set method cannot be bound.

示例:

let hashMap = new HashMap<string, number>();
hashMap.set("squirrel", 123);
console.info("result:", hashMap.get("squirrel"));  // result: 123

[h2]remove

remove(key: K): V

删除指定key对应的元素,并返回该元素的value。若key不存在,则返回undefined。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
key K 是 指定要删除元素的键,用于定位并移除HashMap中该键对应的键值对。

返回值:

类型 说明
V 返回删除元素的值;key不存在时返回undefined。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码。

错误码ID 错误信息
10200011 The remove method cannot be bound.

示例:

let hashMap = new HashMap<string, number>();
hashMap.set("squirrel", 123);
hashMap.set("sparrow", 356);
let result = hashMap.remove("sparrow");
console.info("result:", result);  // result: 356

[h2]clear

clear(): void

清除HashMap中的所有元素,并将length置为0。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

错误码:

以下错误码的详细介绍请参见语言基础类库错误码。

错误码ID 错误信息
10200011 The clear method cannot be bound.

示例:

let hashMap = new HashMap<string, number>();
hashMap.set("squirrel", 123);
hashMap.set("sparrow", 356);
hashMap.clear();
let result = hashMap.isEmpty();
console.info("result:", result);  // result: true

[h2]keys

keys(): IterableIterator<K>

返回新迭代器对象,包含此HashMap中所有的键。

不建议在keys迭代过程中使用set、remove方法,因其可能导致迭代过程中的状态异常,建议使用for循环来进行安全的插入与删除操作。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

返回值:

类型 说明
IterableIterator<K> 返回包含此HashMap中所有key的迭代器。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码。

错误码ID 错误信息
10200011 The keys method cannot be bound.

示例:

let hashMap = new HashMap<string, number>();
hashMap.set("squirrel", 123);
hashMap.set("sparrow", 356);
let keys = hashMap.keys();
for (let key of keys) {
  console.info("key:" + key);
}
// key:squirrel
// key:sparrow

[h2]values

values(): IterableIterator<V>

返回新迭代器对象,包含此HashMap中所有键对应的值。

不建议在values迭代过程中使用set、remove方法,因其可能导致迭代过程中的状态异常,建议使用for循环来进行安全的插入与删除操作。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

返回值:

类型 说明
IterableIterator<V> 返回包含此HashMap中所有value的迭代器。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码。

错误码ID 错误信息
10200011 The values method cannot be bound.

示例:

let hashMap = new HashMap<string, number>();
hashMap.set("squirrel", 123);
hashMap.set("sparrow", 356);
let values = hashMap.values();
for (let value of values) {
  console.info("value:", value);
}
// value: 123
// value: 356

[h2]replace

replace(key: K, newValue: V): boolean

替换指定键对应的值。仅当指定key已存在时才执行替换并返回true,若key不存在则不修改HashMap并返回false。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
key K 是 依据key指定替换的元素,仅当key已存在时替换生效。
newValue V 是 替换指定key对应value的新值。仅当指定key已存在时,newValue才会替换原有value;若key不存在,该值不会被设置。

返回值:

类型 说明
boolean 是否成功对已有数据进行替换,成功返回true,失败返回false。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码。

错误码ID 错误信息
10200011 The replace method cannot be bound.

示例:

let hashMap = new HashMap<string, number>();
hashMap.set("sparrow", 123);
let result = hashMap.replace("sparrow", 357);
console.info("result:", result);  // result: true

[h2]forEach

forEach(callbackFn: (value?: V, key?: K, map?: HashMap<K, V>) => void, thisArg?: Object): void

在遍历过程中对每个元素调用一次回调函数。

不建议在forEach遍历过程中使用set、remove方法,因其可能导致迭代过程中的状态异常,如需在遍历中插入或删除元素,建议使用for循环来进行安全的插入与删除操作。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
callbackFn function 是 回调函数,在遍历每个元素时被调用,用于对元素执行自定义操作。
thisArg Object 否 callbackFn被调用时用作this值。当需要在回调函数中访问其他对象的属性或方法时,可传入自定义thisArg。不传入时默认值为当前实例对象。

callbackFn的参数说明:

参数名 类型 必填 说明
value V 否 当前遍历到的元素键值对的值。
key K 否 当前遍历到的元素键值对的键。
map HashMap<K, V> 否 当前调用forEach方法的HashMap实例对象,默认值为当前实例对象。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码。

错误码ID 错误信息
10200011 The forEach method cannot be bound.

示例:

let hashMap = new HashMap<string, number>();
hashMap.set("sparrow", 123);
hashMap.set("gull", 357);
hashMap.forEach((value: number, key: string) => {
  console.info("value: " + value, "key: " + key);
});
// value: 123 key: sparrow
// value: 357 key: gull
// 不建议在forEach中使用set、remove方法,因其可能导致迭代过程中的状态异常,建议使用for循环来进行安全的插入与删除操作。
let hashMap = new HashMap<string, number>();
for (let i = 0; i < 10; i++) {
  hashMap.set("sparrow" + i, 123);
}

for (let i = 0; i < 10; i++) {
  hashMap.remove("sparrow" + i);
}

[h2]entries

entries(): IterableIterator<[K, V]>

返回此HashMap中包含的键值对的新迭代器对象。

不建议在entries迭代过程中使用set、remove方法,因其可能导致迭代过程中的状态异常,如需在遍历中插入或删除元素,建议使用for循环来进行安全的插入与删除操作。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

返回值:

类型 说明
IterableIterator<[K, V]> 返回包含此HashMap中所有键值对的迭代器。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码。

错误码ID 错误信息
10200011 The entries method cannot be bound.

示例:

let hashMap = new HashMap<string, number>();
hashMap.set("squirrel", 123);
hashMap.set("sparrow", 356);
let iter = hashMap.entries();
let temp: IteratorResult<Object[]> = iter.next();
while (!temp.done) {
  console.info("key:" + temp.value[0]);
  console.info("value:" + temp.value[1]);
  temp = iter.next();
}
// 不建议在entries中使用set、remove方法,因其可能导致迭代过程中的状态异常,建议使用for循环来进行安全的插入与删除操作。
let hashMap = new HashMap<string, number>();
for (let i = 0; i < 10; i++) {
  hashMap.set("sparrow" + i, 123);
}

for (let i = 0; i < 10; i++) {
  hashMap.remove("sparrow" + i);
}

[h2][Symbol.iterator]

[Symbol.iterator](): IterableIterator<[K, V]>

返回一个迭代器,迭代器的每一项都是一个包含键和值的数组[K, V]。

不建议在Symbol.iterator迭代过程中使用set、remove方法,因其可能导致迭代过程中的状态异常,如需在遍历中插入或删除元素,建议使用for循环来进行安全的插入与删除操作。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Utils.Lang

返回值:

类型 说明
IterableIterator<[K, V]> 返回包含此HashMap中所有键值对的迭代器。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码。

错误码ID 错误信息
10200011 The Symbol.iterator method cannot be bound.

示例:

let hashMap = new HashMap<string, number>();
hashMap.set("squirrel", 123);
hashMap.set("sparrow", 356);

// 使用方法一:
for (let item of hashMap) {
  console.info("key:", item[0]);
  console.info("value:", item[1]);
}
// key: squirrel
// value: 123
// key: sparrow
// value: 356

// 使用方法二:
let iter = hashMap[Symbol.iterator]();
let temp: IteratorResult<Object[]> = iter.next();
while (!temp.done) {
  console.info("key:", temp.value[0]);
  console.info("value:", temp.value[1]);
  temp = iter.next();
}
// key: squirrel
// value: 123
// key: sparrow
// value: 356
// 不建议在Symbol.iterator中使用set、remove方法,因其可能导致迭代过程中的状态异常,建议使用for循环来进行安全的插入与删除操作。
let hashMap = new HashMap<string, number>();
for (let i = 0; i < 10; i++) {
  hashMap.set("sparrow" + i, 123);
}

for (let i = 0; i < 10; i++) {
  hashMap.remove("sparrow" + i);
}