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

HashMap底层使用数组+链表+红黑树的方式实现，查询、插入和删除的效率都很高。HashMap存储内容基于key-value的键值对映射，不能有重复的key，且一个key只能对应一个value。

HashMap和TreeMap相比，HashMap依据键的hashCode存取数据，访问速度较快。而TreeMap是有序存取，效率较低。

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

推荐使用场景： 需要快速存取、删除以及插入键值对数据时，推荐使用HashMap。

文档中存在泛型的使用，涉及以下泛型标记符：

• K：Key，键
  
• V：Value，值

说明：

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

导入模块

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

HashMap

属性

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

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

constructor

constructor()

HashMap的构造函数。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

错误码：

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

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

示例：

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

isEmpty

isEmpty(): boolean

判断该HashMap是否为空。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

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

错误码：

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

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

示例：

const hashMap: HashMap<string, number> = new HashMap<string, number>();
let result = hashMap.isEmpty();

hasKey

hasKey(key: K): boolean

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

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
key	K	是	指定Key。

返回值：

类型	说明
boolean	包含指定Key返回true，否则返回false。

错误码：

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

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

示例：

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

hasValue

hasValue(value: V): boolean

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

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
value	V	是	指定value。

返回值：

类型	说明
boolean	包含指定value返回true，否则返回false。

错误码：

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

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

示例：

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

get

get(key: K): V

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

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

ArkTS版本： 该接口仅适用于ArkTS1.1。

参数：

参数名	类型	必填	说明
key	K	是	查找的指定key。

返回值：

类型	说明
V	返回key映射的value值。

错误码：

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

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

示例：

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

get²⁰⁺

get(key: K): V | undefined

获取指定key映射的value值，不存在返回undefined。

原子化服务API： 从API version 20开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

ArkTS版本： 该接口仅适用于ArkTS1.2。

参数：

参数名	类型	必填	说明
key	K	是	要查找的键。

返回值：

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

示例：

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

setAll

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

将一个HashMap中的所有元素组添加到另一个hashMap中。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
map	HashMap<K, V>	是	被添加元素的hashMap。

错误码：

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

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
10200011	The setAll method cannot be bound.

示例：

const hashMap: HashMap<string, number> = new HashMap<string, number>();
hashMap.set("squirrel", 123);
hashMap.set("sparrow", 356);
let newHashMap: HashMap<string, number> = new HashMap<string, number>();
newHashMap.set("newMap", 99);
hashMap.setAll(newHashMap);

set

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

向HashMap中添加或更新一组数据。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
key	K	是	添加或更新成员数据的键名。
value	V	是	添加或更新成员数据的值。

返回值：

类型	说明
Object	返回添加后的hashMap。

错误码：

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

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
10200011	The set method cannot be bound.

示例：

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

remove

remove(key: K): V

删除指定key所对应元素。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

ArkTS版本： 该接口仅适用于ArkTS1.1。

参数：

参数名	类型	必填	说明
key	K	是	指定key。

返回值：

类型	说明
V	返回删除元素的值。

错误码：

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

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

示例：

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

remove²⁰⁺

remove(key: K): V | undefined

删除指定key所对应元素。

原子化服务API： 从API version 20开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

ArkTS版本： 该接口仅适用于ArkTS1.2。

参数：

参数名	类型	必填	说明
key	K	是	指定key。

返回值：

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

示例：

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

clear

clear(): void

清除HashMap中的所有元素，并把length置为0。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

错误码：

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

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

示例：

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

keys

keys(): IterableIterator<K>

返回包含此映射中包含的键的新迭代器对象。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
IterableIterator<K>	返回一个迭代器。

错误码：

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

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

示例：

let hashMap: HashMap<string, number> = new HashMap<string, number>();
hashMap.set("squirrel", 123);
hashMap.set("sparrow", 356);
let iter = hashMap.keys();
let temp = iter.next();
while(!temp.done) {
  console.info("value:" + temp.value);
  temp = iter.next();
}

values

values(): IterableIterator<V>

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

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
IterableIterator<V>	返回一个迭代器。

错误码：

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

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

示例：

let hashMap: HashMap<string, number> = new HashMap<string, number>();
hashMap.set("squirrel", 123);
hashMap.set("sparrow", 356);
let iter = hashMap.values();
let temp = iter.next();
while(!temp.done) {
  console.info("value:" + temp.value);
  temp = iter.next();
}

replace

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

对HashMap中一组数据进行更新（替换）。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
key	K	是	依据key指定替换的元素。
newValue	V	是	替换成员数据的值。

返回值：

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

错误码：

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

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

示例：

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

forEach

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

通过回调函数来遍历HashMap实例对象上的元素以及元素对应的下标。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

ArkTS版本： 该接口仅适用于ArkTS1.1。

参数：

参数名	类型	必填	说明
callbackFn	function	是	回调函数。
thisArg	Object	否	callbackfn被调用时用作this值，默认值为当前实例对象。

callbackfn的参数说明：

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

错误码：

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

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
10200011	The forEach method cannot be bound.

示例：

let hashMap: HashMap<string, number> = new HashMap();
hashMap.set("sparrow", 123);
hashMap.set("gull", 357);
hashMap.forEach((value?: number, key?: string) => {
  console.log("value:" + value, "key:" + key);
});

// 不建议在forEach中使用set、remove方法，会导致死循环等不可预知的风险，可使用for循环来进行插入和删除。
let hashMap: HashMap<string, number> = new HashMap();
for(let i = 0; i < 10; i++) {
  hashMap.set("sparrow" + i, 123);
}

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

forEach²⁰⁺

forEach(callbackFn: HashMapCbFn<K, V>): void

通过回调函数来遍历HashMap实例对象上的元素以及元素对应的下标。

原子化服务API： 从API version 20开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

ArkTS版本： 该接口仅适用于ArkTS1.2。

参数：

参数名	类型	必填	说明
callbackFn	HashMapCbFn<K, V>	是	回调函数。

示例：

import { HashMapCbFn } from '@ohos.util.HashMap';

let hashMap: HashMap<string, number> = new HashMap<string, number>();
hashMap.set("sparrow", 123);
hashMap.set("gull", 357);
let hashMapCb: HashMapCbFn<string, number> = (value: number, key: string, map: HashMap<string, number>) => {
  console.info("value: " + value, " key: " + key);
};
hashMap.forEach(hashMapCb);

entries

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

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

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
IterableIterator<[K, V]>	返回一个迭代器。

错误码：

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

错误码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<[string, Number]> = 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);
}

[Symbol.iterator]

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

返回一个迭代器，迭代器的每一项都是一个 JavaScript 对象，并返回该对象。

原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

ArkTS版本： 该接口仅适用于ArkTS1.1。

返回值：

类型	说明
IterableIterator<[K, V]>	返回一个迭代器。

错误码：

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

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

示例：

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

// 使用方法一：
let keys = Array.from(hashMap.keys());
for (let key of keys) {
  console.log("key:" + key);
  console.log("value:" + hashMap.get(key));
}

// 使用方法二：
 let iter = hashMap[Symbol.iterator]();
 let temp: IteratorResult<Object[]> = iter.next();
 while(!temp.done) {
   console.log("key:" + temp.value[0]);
   console.log("value:" + temp.value[1]);
   temp = iter.next();
 }

// 不建议在Symbol.iterator中使用set、remove方法，会导致死循环等不可预知的风险，可使用for循环来进行插入和删除。
let hashMap: HashMap<string, number> = new HashMap();
for(let i = 0; i < 10; i++) {
  hashMap.set("sparrow" + i, 123);
}

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

$_iterator²⁰⁺

$_iterator(): IterableIterator<[K, V]>

返回一个迭代器，迭代器的每一项都是一个JavaScript对象，并返回该对象。

原子化服务API： 从API version 20开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

ArkTS版本： 该接口仅适用于ArkTS1.2。

返回值：

类型	说明
IterableIterator<[K, V]>	返回一个迭代器。

示例：

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

// 使用方法一：
for (let item of hashMap) {
  console.info("key:" + item[0]);
  console.info("value:" + item[1]);
}

// 使用方法二：
 let iter = hashMap.$_iterator();
 let temp: IteratorResult<[string, Number]> = iter.next();
 while(!temp.done) {
   console.info("key:" + temp.value![0]);
   console.info("value:" + temp.value![1]);
   temp = iter.next();
 }

HashMapCbFn<K, V>²⁰⁺

type HashMapCbFn<K, V> = (value: V, key: K, map: HashMap<K, V>) => void

HashMap中forEach方法的回调函数。

原子化服务API： 从API version 20开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.Utils.Lang

ArkTS版本： 该接口仅适用于ArkTS1.2。

参数：

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