1# @ohos.util.Queue (线性容器Queue) 2 3>  **说明：** 4> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 5 6Queue的特点是先进先出，在尾部增加元素，在头部删除元素。根据循环队列的数据结构实现。 7 8Queue和[Deque](js-apis-deque.md)相比，Queue只能在一端删除一端增加，Deque可以两端增删。 9 10**推荐使用场景：** 一般符合先进先出的场景可以使用Queue。 11 12文档中存在泛型的使用,涉及以下泛型标记符:<br> 13- T: Type, 类 14 15## 导入模块 16 17```ts 18import Queue from '@ohos.util.Queue'; 19``` 20 21 22## Queue 23 24### 属性 25 26**系统能力：** SystemCapability.Utils.Lang 27 28| 名称 | 类型 | 可读 | 可写 | 说明 | 29| -------- | -------- | -------- | -------- | -------- | 30| length | number | 是 | 否 | Queue的元素个数。 | 31 32 33### constructor 34 35constructor() 36 37Queue的构造函数。 38 39**系统能力：** SystemCapability.Utils.Lang 40 41**错误码：** 42 43以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 44 45| 错误码ID | 错误信息 | 46| -------- | -------- | 47| 10200012 | The Queue's constructor cannot be directly invoked. | 48 49**示例：** 50 51```ts 52let queue = new Queue(); 53``` 54 55 56### add 57 58add(element: T): boolean 59 60在队列尾部插入元素。 61 62**系统能力：** SystemCapability.Utils.Lang 63 64**参数：** 65 66| 参数名 | 类型 | 必填 | 说明 | 67| -------- | -------- | -------- | -------- | 68| element | T | 是 | 添加进去的元素。 | 69 70**返回值：** 71 72| 类型 | 说明 | 73| -------- | -------- | 74| boolean | 插入成功返回true，否则返回false。 | 75 76**错误码：** 77 78以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 79 80| 错误码ID | 错误信息 | 81| -------- | -------- | 82| 10200011 | The add method cannot be bound. | 83 84**示例：** 85 86```ts 87let queue = new Queue(); 88let result = queue.add("a"); 89let result1 = queue.add(1); 90let b = [1, 2, 3]; 91let result2 = queue.add(b); 92let c = {name : "Dylon", age : "13"}; 93let result3 = queue.add(c); 94``` 95 96### pop 97 98pop(): T 99 100删除头元素并返回该删除元素。 101 102**系统能力：** SystemCapability.Utils.Lang 103 104**返回值：** 105 106| 类型 | 说明 | 107| -------- | -------- | 108| T | 返回删除的元素。 | 109 110**错误码：** 111 112以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 113 114| 错误码ID | 错误信息 | 115| -------- | -------- | 116| 10200011 | The pop method cannot be bound. | 117 118**示例：** 119 120```ts 121let queue = new Queue(); 122queue.add(2); 123queue.add(4); 124queue.add(5); 125queue.add(2); 126queue.add(4); 127let result = queue.pop(); 128``` 129 130### getFirst 131 132getFirst(): T 133 134获取队列的头元素。 135 136**系统能力：** SystemCapability.Utils.Lang 137 138**返回值：** 139 140| 类型 | 说明 | 141| -------- | -------- | 142| T | 返回获取的元素。 | 143 144**错误码：** 145 146以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 147 148| 错误码ID | 错误信息 | 149| -------- | -------- | 150| 10200011 | The getFirst method cannot be bound. | 151 152**示例：** 153 154```ts 155let queue = new Queue(); 156queue.add(2); 157queue.add(4); 158queue.add(5); 159queue.add(2); 160let result = queue.getFirst(); 161``` 162 163### forEach 164 165forEach(callbackFn: (value: T, index?: number, Queue?: Queue<T>) => void, 166thisArg?: Object): void 167 168通过回调函数来遍历Queue实例对象上的元素以及元素对应的下标。 169 170**系统能力：** SystemCapability.Utils.Lang 171 172**参数：** 173 174| 参数名 | 类型 | 必填 | 说明 | 175| -------- | -------- | -------- | -------- | 176| callbackFn | function | 是 | 回调函数。 | 177| thisArg | Object | 否 | callbackfn被调用时用作this值。 | 178 179callbackfn的参数说明： 180 181| 参数名 | 类型 | 必填 | 说明 | 182| -------- | -------- | -------- | -------- | 183| value | T | 是 | 当前遍历到的元素。 | 184| index | number | 否 | 当前遍历到的下标值。 | 185| Queue | Queue<T> | 否 | 当前调用forEach方法的实例对象。 | 186 187**错误码：** 188 189以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 190 191| 错误码ID | 错误信息 | 192| -------- | -------- | 193| 10200011 | The forEach method cannot be bound. | 194 195**示例：** 196 197```ts 198let queue = new Queue(); 199queue.add(2); 200queue.add(4); 201queue.add(5); 202queue.add(4); 203queue.forEach((value, index) => { 204 console.log("value:" + value, "index:" + index); 205}); 206``` 207 208### [Symbol.iterator] 209 210[Symbol.iterator]\(): IterableIterator<T> 211 212返回一个迭代器，迭代器的每一项都是一个 JavaScript 对象,并返回该对象。 213 214**系统能力：** SystemCapability.Utils.Lang 215 216**返回值：** 217 218| 类型 | 说明 | 219| -------- | -------- | 220| IterableIterator<T> | 返回一个迭代器。 | 221 222**错误码：** 223 224以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 225 226| 错误码ID | 错误信息 | 227| -------- | -------- | 228| 10200011 | The Symbol.iterator method cannot be bound. | 229 230**示例：** 231```ts 232let queue = new Queue(); 233queue.add(2); 234queue.add(4); 235queue.add(5); 236queue.add(4); 237 238// 使用方法一： 239for (let item of queue) { 240 console.log("value:" + item); 241} 242 243// 使用方法二： 244let iter = queue[Symbol.iterator](); 245let temp = iter.next().value; 246while(temp != undefined) { 247 console.log("value:" + temp); 248 temp = iter.next().value; 249} 250```
