1# @ohos.util.Stack (线性容器Stack) 2 3Stack基于数组的数据结构实现，特点是先进后出，只能在一端进行数据的插入和删除。 4 5Stack和[Queue](js-apis-queue.md)相比，Queue基于循环队列实现，只能在一端删除，另一端插入，而Stack都在一端操作。 6 7**推荐使用场景：** 一般符合先进后出的场景可以使用Stack。 8 9文档中存在泛型的使用，涉及以下泛型标记符：<br> 10- T：Type，类 11 12> **说明：** 13> 14> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 15 16 17## 导入模块 18 19```ts 20import Stack from '@ohos.util.Stack'; 21``` 22 23## Stack 24 25### 属性 26 27**系统能力：** SystemCapability.Utils.Lang 28 29| 名称 | 类型 | 可读 | 可写 | 说明 | 30| -------- | -------- | -------- | -------- | -------- | 31| length | number | 是 | 否 | Stack的元素个数。 | 32 33 34### constructor 35 36constructor() 37 38Stack的构造函数。 39 40**系统能力：** SystemCapability.Utils.Lang 41 42**错误码：** 43 44以下错误码的详细介绍请参见[语言基础类库错误码](errorcode-utils.md)。 45 46| 错误码ID | 错误信息 | 47| -------- | -------- | 48| 10200012 | The Stack's constructor cannot be directly invoked. | 49 50**示例：** 51 52```ts 53let stack : Stack<number | string | Object> = new Stack(); 54``` 55 56 57### push 58 59push(item: T): T 60 61在栈顶插入元素，并返回该元素。 62 63**系统能力：** SystemCapability.Utils.Lang 64 65**参数：** 66 67| 参数名 | 类型 | 必填 | 说明 | 68| -------- | -------- | -------- | -------- | 69| item | T | 是 | 添加进去的元素。 | 70 71**返回值：** 72 73| 类型 | 说明 | 74| -------- | -------- | 75| T | 返回被添加进去的元素。 | 76 77**错误码：** 78 79以下错误码的详细介绍请参见[语言基础类库错误码](errorcode-utils.md)。 80 81| 错误码ID | 错误信息 | 82| -------- | -------- | 83| 10200011 | The push method cannot be bound. | 84 85**示例：** 86 87``` 88class C1 { 89 name: string = "" 90 age: string = "" 91} 92let stack : Stack<number | string | C1> = new Stack(); 93let result = stack.push("a"); 94let result1 = stack.push(1); 95let c : C1 = {name : "Dylon", age : "13"}; 96let result2 = stack.push(c); 97``` 98 99### pop 100 101pop(): T 102 103删除栈顶元素并返回该元素，栈为空时返回undefined。 104 105**系统能力：** SystemCapability.Utils.Lang 106 107**返回值：** 108 109| 类型 | 说明 | 110| -------- | -------- | 111| T | 返回栈顶元素，栈为空时返回undefined。 | 112 113**错误码：** 114 115以下错误码的详细介绍请参见[语言基础类库错误码](errorcode-utils.md)。 116 117| 错误码ID | 错误信息 | 118| -------- | -------- | 119| 10200011 | The pop method cannot be bound. | 120 121**示例：** 122 123```ts 124let stack : Stack<number> = new Stack(); 125stack.push(2); 126stack.push(4); 127stack.push(5); 128stack.push(2); 129stack.push(4); 130let result = stack.pop(); 131``` 132 133### peek 134 135peek(): T 136 137获取并返回栈顶元素。 138 139**系统能力：** SystemCapability.Utils.Lang 140 141**返回值：** 142 143| 类型 | 说明 | 144| -------- | -------- | 145| T | 返回栈顶元素。 | 146 147**错误码：** 148 149以下错误码的详细介绍请参见[语言基础类库错误码](errorcode-utils.md)。 150 151| 错误码ID | 错误信息 | 152| -------- | -------- | 153| 10200011 | The peek method cannot be bound. | 154 155**示例：** 156 157```ts 158let stack : Stack<number> = new Stack(); 159stack.push(2); 160stack.push(4); 161stack.push(5); 162stack.push(2); 163let result = stack.peek(); 164``` 165 166### locate 167 168locate(element: T): number 169 170返回指定元素第一次出现时的下标值，查找失败返回-1。 171 172**系统能力：** SystemCapability.Utils.Lang 173 174**参数：** 175 176| 参数名 | 类型 | 必填 | 说明 | 177| -------- | -------- | -------- | -------- | 178| element | T | 是 | 指定元素。 | 179 180**返回值：** 181 182| 类型 | 说明 | 183| -------- | -------- | 184| number | 找到就返回下标值，没有该值时返回-1。 | 185 186**错误码：** 187 188以下错误码的详细介绍请参见[语言基础类库错误码](errorcode-utils.md)。 189 190| 错误码ID | 错误信息 | 191| -------- | -------- | 192| 10200011 | The locate method cannot be bound. | 193 194**示例：** 195 196```ts 197let stack : Stack<number> = new Stack(); 198stack.push(2); 199stack.push(4); 200stack.push(5); 201stack.push(2); 202let result = stack.locate(2); 203``` 204 205### forEach 206 207forEach(callbackFn: (value: T, index?: number, stack?: Stack<T>) => void, 208thisArg?: Object): void 209 210通过回调函数来遍历Stack实例对象上的元素以及元素对应的下标。 211 212**系统能力：** SystemCapability.Utils.Lang 213 214**参数：** 215 216| 参数名 | 类型 | 必填 | 说明 | 217| -------- | -------- | -------- | -------- | 218| callbackFn | function | 是 | 回调函数。 | 219| thisArg | Object | 否 | callbackfn被调用时用作this值，默认值为当前实例对象。 | 220 221callbackfn的参数说明： 222 223| 参数名 | 类型 | 必填 | 说明 | 224| -------- | -------- | -------- | -------- | 225| value | T | 是 | 当前遍历到的元素。 | 226| index | number | 否 | 当前遍历到的下标值，默认值为0。 | 227| stack | Stack<T> | 否 | 当前调用forEach方法的实例对象，默认值为当前实例对象。 | 228 229**错误码：** 230 231以下错误码的详细介绍请参见[语言基础类库错误码](errorcode-utils.md)。 232 233| 错误码ID | 错误信息 | 234| -------- | -------- | 235| 10200011 | The forEach method cannot be bound. | 236 237**示例：** 238 239```ts 240let stack : Stack<number> = new Stack(); 241stack.push(2); 242stack.push(4); 243stack.push(5); 244stack.push(4); 245stack.forEach((value : number, index ?: number) :void => { 246 console.log("value:" + value, "index:" + index); 247}); 248``` 249 250### isEmpty 251 252isEmpty(): boolean 253 254判断该栈是否为空。 255 256**系统能力：** SystemCapability.Utils.Lang 257 258**返回值：** 259 260| 类型 | 说明 | 261| -------- | -------- | 262| boolean | 为空返回true，不为空返回false。 | 263 264**错误码：** 265 266以下错误码的详细介绍请参见[语言基础类库错误码](errorcode-utils.md)。 267 268| 错误码ID | 错误信息 | 269| -------- | -------- | 270| 10200011 | The isEmpty method cannot be bound. | 271 272**示例：** 273 274```ts 275let stack : Stack<number> = new Stack(); 276stack.push(2); 277stack.push(4); 278stack.push(5); 279stack.push(4); 280let result = stack.isEmpty(); 281``` 282 283### [Symbol.iterator] 284 285[Symbol.iterator]\(): IterableIterator<T> 286 287返回一个迭代器，迭代器的每一项都是一个 JavaScript 对象,并返回该对象。 288 289> **说明：** 290> 291> 本接口不支持在.ets文件中使用 292 293**系统能力：** SystemCapability.Utils.Lang 294 295**返回值：** 296 297| 类型 | 说明 | 298| -------- | -------- | 299| IterableIterator<T> | 返回一个迭代器。 | 300 301**错误码：** 302 303以下错误码的详细介绍请参见[语言基础类库错误码](errorcode-utils.md)。 304 305| 错误码ID | 错误信息 | 306| -------- | -------- | 307| 10200011 | The Symbol.iterator method cannot be bound. | 308 309**示例：** 310```ts 311let stack : Stack<number> = new Stack(); 312stack.push(2); 313stack.push(4); 314stack.push(5); 315stack.push(4); 316 317// 使用方法一： 318while(!stack.isEmpty()) { 319 // 业务逻辑 320 let item = stack.pop() 321 console.log("value:" + item); 322} 323 324// 使用方法二： 325let iter = stack[Symbol.iterator](); 326let temp: IteratorResult<number> = iter.next().value; 327while(temp != undefined) { 328 console.log("value:" + temp); 329 temp = iter.next().value; 330} 331```