1# 线性容器ArrayList 2 3>  **说明：** 4> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 5 6ArrayList是一种线性数据结构，底层基于数组实现。ArrayList会根据实际需要动态调整容量，每次扩容增加50%。 7 8ArrayList和[Vector](js-apis-vector.md)相似，都是基于数组实现。它们都可以动态调整容量，但Vector每次扩容增加1倍。 9 10ArrayList和[LinkedList](js-apis-linkedlist.md)相比，ArrayList的随机访问效率更高。但由于ArrayList的增删操作会影响数组内其他元素的移动，LinkedList的增加和删除操作效率更高。 11 12**推荐使用场景：** 当需要频繁读取集合中的元素时，推荐使用ArrayList。 13 14## 导入模块 15 16```ts 17import ArrayList from '@ohos.util.ArrayList'; 18``` 19 20## ArrayList 21 22### 属性 23 24**系统能力：** SystemCapability.Utils.Lang 25 26| 名称 | 参数类型 | 可读 | 可写 | 说明 | 27| -------- | -------- | -------- | -------- | -------- | 28| length | number | 是 | 否 | ArrayList的元素个数。 | 29 30 31### constructor 32 33constructor() 34 35ArrayList的构造函数。 36 37**系统能力：** SystemCapability.Utils.Lang 38 39**示例：** 40 41```ts 42let arrayList = new ArrayList(); 43``` 44 45 46### add 47 48add(element: T): boolean 49 50在ArrayList尾部插入元素。 51 52**系统能力：** SystemCapability.Utils.Lang 53 54**参数：** 55 56| 参数名 | 类型 | 必填 | 说明 | 57| -------- | -------- | -------- | -------- | 58| element | T | 是 | 待插入的元素。 | 59 60**返回值：** 61 62| 类型 | 说明 | 63| -------- | -------- | 64| boolean | 插入成功返回true，失败返回false。 | 65 66**示例：** 67 68 ```ts 69 let arrayList = new ArrayList(); 70 let result = arrayList.add("a"); 71 let result1 = arrayList.add(1); 72 let b = [1, 2, 3]; 73 let result2 = arrayList.add(b); 74 let c = {name: "lala", age: "13"}; 75 let result3 = arrayList.add(false); 76 ``` 77 78### insert 79 80insert(element: T, index: number): void 81 82在长度范围内任意位置插入指定元素。 83 84**系统能力：** SystemCapability.Utils.Lang 85 86**参数：** 87 88| 参数名 | 类型 | 必填 | 说明 | 89| -------- | -------- | -------- | -------- | 90| element | T | 是 | 被插入的元素。 | 91| index | number | 是 | 被插入的位置索引。 | 92 93**示例：** 94 95```ts 96let arrayList = new ArrayList(); 97arrayList.insert("A", 0); 98arrayList.insert(0, 1); 99arrayList.insert(true, 2); 100``` 101 102### has 103 104has(element: T): boolean 105 106判断此ArrayList中是否含有该指定元素。 107 108**系统能力：** SystemCapability.Utils.Lang 109 110**参数：** 111 112| 参数名 | 类型 | 必填 | 说明 | 113| -------- | -------- | -------- | -------- | 114| element | T | 是 | 指定元素。 | 115 116**返回值：** 117 118| 类型 | 说明 | 119| -------- | -------- | 120| boolean | 返回true表示包含指定元素，否则返回false。 | 121 122**示例：** 123 124```ts 125let arrayList = new ArrayList(); 126let result = arrayList.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); 127arrayList.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); 128let result1 = arrayList.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); 129``` 130 131### getIndexOf 132 133getIndexOf(element: T): number 134 135返回指定元素第一次出现时的下标值，查找失败返回-1。 136 137**系统能力：** SystemCapability.Utils.Lang 138 139**参数：** 140 141| 参数名 | 类型 | 必填 | 说明 | 142| -------- | -------- | -------- | -------- | 143| element | T | 是 | 指定元素。 | 144 145**返回值：** 146 147| 类型 | 说明 | 148| -------- | -------- | 149| number | 返回指定元素第一次出现时的下标值，查找失败返回-1。 | 150 151**示例：** 152 153```ts 154let arrayList = new ArrayList(); 155arrayList.add(2); 156arrayList.add(4); 157arrayList.add(5); 158arrayList.add(2); 159arrayList.add(1); 160arrayList.add(2); 161arrayList.add(4); 162let result = arrayList.getIndexOf(2); 163``` 164 165### getLastIndexOf 166 167getLastIndexOf(element: T): number 168 169返回指定元素最后一次出现时的下标值，查找失败返回-1。 170 171**系统能力：** SystemCapability.Utils.Lang 172 173**参数：** 174 175| 参数名 | 类型 | 必填 | 说明 | 176| -------- | -------- | -------- | -------- | 177| element | T | 是 | 指定元素。 | 178 179**返回值：** 180 181| 类型 | 说明 | 182| -------- | -------- | 183| number | 返回指定元素最后一次出现时的下标值，查找失败返回-1。 | 184 185**示例：** 186 187```ts 188let arrayList = new ArrayList(); 189arrayList.add(2); 190arrayList.add(4); 191arrayList.add(5); 192arrayList.add(2); 193arrayList.add(1); 194arrayList.add(2); 195arrayList.add(4); 196let result = arrayList.getLastIndexOf(2); 197``` 198 199### removeByIndex 200 201removeByIndex(index: number): T 202 203根据元素的下标值查找元素，返回元素后将其删除。 204 205**系统能力：** SystemCapability.Utils.Lang 206 207**参数：** 208 209| 参数名 | 类型 | 必填 | 说明 | 210| -------- | -------- | -------- | -------- | 211| index | number | 是 | 指定元素的下标值。 | 212 213**返回值：** 214 215| 类型 | 说明 | 216| -------- | -------- | 217| T | 返回删除的元素。 | 218 219**示例：** 220 221```ts 222let arrayList = new ArrayList(); 223arrayList.add(2); 224arrayList.add(4); 225arrayList.add(5); 226arrayList.add(2); 227arrayList.add(4); 228let result = arrayList.removeByIndex(2); 229``` 230 231### remove 232 233remove(element: T): boolean 234 235删除查找到的第一个指定的元素。 236 237**系统能力：** SystemCapability.Utils.Lang 238 239**参数：** 240 241| 参数名 | 类型 | 必填 | 说明 | 242| -------- | -------- | -------- | -------- | 243| element | T | 是 | 指定元素。 | 244 245**返回值：** 246 247| 类型 | 说明 | 248| -------- | -------- | 249| boolean | 删除成功返回true，失败返回false。 | 250 251**示例：** 252 253```ts 254let arrayList = new ArrayList(); 255arrayList.add(2); 256arrayList.add(4); 257arrayList.add(5); 258arrayList.add(4); 259let result = arrayList.remove(2); 260``` 261 262### removeByRange 263 264removeByRange(fromIndex: number, toIndex: number): void 265 266从一段范围内删除元素，包括起始值但不包括终止值。 267 268**系统能力：** SystemCapability.Utils.Lang 269 270**参数：** 271 272| 参数名 | 类型 | 必填 | 说明 | 273| -------- | -------- | -------- | -------- | 274| fromIndex | number | 是 | 起始下标。 | 275| toIndex | number | 是 | 终止下标。 | 276 277**示例：** 278 279```ts 280let arrayList = new ArrayList(); 281arrayList.add(2); 282arrayList.add(4); 283arrayList.add(5); 284arrayList.add(4); 285arrayList.removeByRange(2, 4); 286arrayList.removeByRange(4, 3); 287arrayList.removeByRange(2, 6); 288``` 289 290### replaceAllElements 291 292replaceAllElements(callbackfn: (value: T, index?: number, arrlist?: ArrayList<T>) => T, 293thisArg?: Object): void 294 295用户操作ArrayList中的元素，用操作后的元素替换原元素并返回操作后的元素。 296 297**系统能力：** SystemCapability.Utils.Lang 298 299**参数：** 300 301| 参数名 | 类型 | 必填 | 说明 | 302| -------- | -------- | -------- | -------- | 303| callbackfn | function | 是 | 回调函数。 | 304| thisArg | Object | 否 | callbackfn被调用时用作this值。 | 305 306callbackfn的参数说明： 307 308| 参数名 | 类型 | 必填 | 说明 | 309| -------- | -------- | -------- | -------- | 310| value | T | 是 | 当前遍历到的元素。 | 311| index | number | 否 | 当前遍历到的下标值。 | 312| arrlist | ArrayList<T> | 否 | 当前调用replaceAllElements方法的实例对象。 | 313 314**示例：** 315 316```ts 317let arrayList = new ArrayList(); 318arrayList.add(2); 319arrayList.add(4); 320arrayList.add(5); 321arrayList.add(4); 322arrayList.replaceAllElements((value) => { 323 // 用户操作逻辑根据实际场景进行添加。 324 return value; 325}); 326``` 327 328### forEach 329 330forEach(callbackfn: (value: T, index?: number, arrlist?: ArrayList<T>) => void, 331thisArg?: Object): void 332 333通过回调函数来遍历ArrayList实例对象上的元素以及元素对应的下标。 334 335**系统能力：** SystemCapability.Utils.Lang 336 337**参数：** 338 339| 参数名 | 类型 | 必填 | 说明 | 340| -------- | -------- | -------- | -------- | 341| callbackfn | function | 是 | 回调函数。 | 342| thisArg | Object | 否 | callbackfn被调用时用作this值。 | 343 344callbackfn的参数说明： 345 346| 参数名 | 类型 | 必填 | 说明 | 347| -------- | -------- | -------- | -------- | 348| value | T | 是 | 当前遍历到的元素。 | 349| index | number | 否 | 当前遍历到的下标值。 | 350| arrlist | ArrayList<T> | 否 | 当前调用forEach方法的实例对象。 | 351 352**示例：** 353 354```ts 355let arrayList = new ArrayList(); 356arrayList.add(2); 357arrayList.add(4); 358arrayList.add(5); 359arrayList.add(4); 360arrayList.forEach((value, index) => { 361 console.log("value:" + value, "index:" + index); 362}); 363``` 364 365### sort 366 367sort(comparator?: (firstValue: T, secondValue: T) => number): void 368 369对ArrayList中的元素排序。 370 371**系统能力：** SystemCapability.Utils.Lang 372 373**参数：** 374 375| 参数名 | 类型 | 必填 | 说明 | 376| -------- | -------- | -------- | -------- | 377| comparator | function | 否 | 回调函数。 | 378 379comparator的参数说明： 380 381| 参数名 | 类型 | 必填 | 说明 | 382| -------- | -------- | -------- | -------- | 383| firstValue | T | 是 | 前一项元素。 | 384| secondValue | T | 是 | 后一项元素。 | 385 386**示例：** 387 388```ts 389let arrayList = new ArrayList(); 390arrayList.add(2); 391arrayList.add(4); 392arrayList.add(5); 393arrayList.add(4); 394arrayList.sort((a: number, b: number) => a - b); 395arrayList.sort((a: number, b: number) => b - a); 396arrayList.sort(); 397``` 398 399### subArrayList 400 401subArrayList(fromIndex: number, toIndex: number): ArrayList<T> 402 403根据下标截取ArrayList中的一段元素，并返回这一段ArrayList实例，包括起始值但不包括终止值。 404 405**系统能力：** SystemCapability.Utils.Lang 406 407**参数：** 408 409| 参数名 | 类型 | 必填 | 说明 | 410| -------- | -------- | -------- | -------- | 411| fromIndex | number | 是 | 起始下标。 | 412| toIndex | number | 是 | 终止下标。 | 413 414**返回值：** 415 416| 类型 | 说明 | 417| -------- | -------- | 418| ArrayList<T> | 返回ArrayList对象实例。 | 419 420**示例：** 421 422```ts 423let arrayList = new ArrayList(); 424arrayList.add(2); 425arrayList.add(4); 426arrayList.add(5); 427arrayList.add(4); 428let result1 = arrayList.subArrayList(2, 4); 429let result2 = arrayList.subArrayList(4, 3); 430let result3 = arrayList.subArrayList(2, 6); 431``` 432 433### clear 434 435clear(): void 436 437清除ArrayList中的所有元素，并把length置为0。 438 439**系统能力：** SystemCapability.Utils.Lang 440 441**示例：** 442 443```ts 444let arrayList = new ArrayList(); 445arrayList.add(2); 446arrayList.add(4); 447arrayList.add(5); 448arrayList.add(4); 449arrayList.clear(); 450``` 451 452### clone 453 454clone(): ArrayList<T> 455 456克隆一个与ArrayList相同的实例，并返回克隆后的实例。修改克隆后的实例并不会影响原实例。 457 458**系统能力：** SystemCapability.Utils.Lang 459 460 461**返回值：** 462 463| 类型 | 说明 | 464| -------- | -------- | 465| ArrayList<T> | 返回ArrayList对象实例。 | 466 467**示例：** 468 469```ts 470let arrayList = new ArrayList(); 471arrayList.add(2); 472arrayList.add(4); 473arrayList.add(5); 474arrayList.add(4); 475let result = arrayList.clone(); 476``` 477 478### getCapacity 479 480getCapacity(): number 481 482获取当前实例的容量大小。 483 484**系统能力：** SystemCapability.Utils.Lang 485 486**返回值：** 487 488| 类型 | 说明 | 489| -------- | -------- | 490| number | 返回arraylist的容量大小。 | 491 492**示例：** 493 494```ts 495let arrayList = new ArrayList(); 496arrayList.add(2); 497arrayList.add(4); 498arrayList.add(5); 499arrayList.add(4); 500let result = arrayList.getCapacity(); 501``` 502 503### convertToArray 504 505convertToArray(): Array<T> 506 507把当前ArrayList实例转换成数组，并返回转换后的数组。 508 509**系统能力：** SystemCapability.Utils.Lang 510 511**返回值：** 512 513| 类型 | 说明 | 514| -------- | -------- | 515| Array<T> | 返回数组类型。 | 516 517**示例：** 518 519```ts 520let arrayList = new ArrayList(); 521arrayList.add(2); 522arrayList.add(4); 523arrayList.add(5); 524arrayList.add(4); 525let result = arrayList.convertToArray(); 526``` 527 528### isEmpty 529 530isEmpty(): boolean 531 532判断该ArrayList是否为空。 533 534**系统能力：** SystemCapability.Utils.Lang 535 536**返回值：** 537 538| 类型 | 说明 | 539| -------- | -------- | 540| boolean | 为空返回true，不为空返回false。 | 541 542**示例：** 543 544```ts 545let arrayList = new ArrayList(); 546arrayList.add(2); 547arrayList.add(4); 548arrayList.add(5); 549arrayList.add(4); 550let result = arrayList.isEmpty(); 551``` 552 553### increaseCapacityTo 554 555increaseCapacityTo(newCapacity: number): void 556 557如果传入的新容量大于或等于ArrayList中的元素个数，将容量变更为新容量。 558 559**系统能力：** SystemCapability.Utils.Lang 560 561**参数：** 562 563| 参数名 | 类型 | 必填 | 说明 | 564| -------- | -------- | -------- | -------- | 565| newCapacity | number | 是 | 新容量。 | 566 567**示例：** 568 569```ts 570let arrayList = new ArrayList(); 571arrayList.add(2); 572arrayList.add(4); 573arrayList.add(5); 574arrayList.add(4); 575arrayList.increaseCapacityTo(2); 576arrayList.increaseCapacityTo(8); 577``` 578 579### trimToCurrentLength 580 581trimToCurrentLength(): void 582 583把容量限制为当前的length大小。 584 585**系统能力：** SystemCapability.Utils.Lang 586 587**示例：** 588 589```ts 590let arrayList = new ArrayList(); 591arrayList.add(2); 592arrayList.add(4); 593arrayList.add(5); 594arrayList.add(4); 595arrayList.trimToCurrentLength(); 596``` 597 598### [Symbol.iterator] 599 600[Symbol.iterator]\(): IterableIterator<T> 601 602返回一个迭代器，迭代器的每一项都是一个 JavaScript 对象，并返回该对象。 603 604**系统能力：** SystemCapability.Utils.Lang 605 606**返回值：** 607 608| 类型 | 说明 | 609| -------- | -------- | 610| IterableIterator<T> | 返回一个迭代器。 | 611 612**示例：** 613 614```ts 615let arrayList = new ArrayList(); 616arrayList.add(2); 617arrayList.add(4); 618arrayList.add(5); 619arrayList.add(4); 620 621// 使用方法一： 622for (let item of arrayList) { 623 console.log("value:" + item); 624} 625 626// 使用方法二： 627let iter = arrayList[Symbol.iterator](); 628let temp = iter.next().value; 629while(temp != undefined) { 630 console.log("value:" + temp); 631 temp = iter.next().value; 632} 633```
