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