紀錄工作經驗、相關知識,解決技術相關問題。

Javascript

JS Array.length 用法:陣列長度與截斷陣列

JS Array.length 用法:陣列長度與截斷陣列 特色圖片

Array.length(正式名稱是 Array 實例的 length 屬性)是 JavaScript 用來取得陣列長度的屬性:寫 arr.length,就會得到這個陣列目前有幾個「位置」。

白話一點,就像一排編號從 0 開始的置物櫃,length 回報的是櫃子的總格數;它不是方法,所以後面不加括號。

基本用法:取得陣列長度

const fruits = ['apple', 'banana', 'mango'];

console.log(fruits.length); // 3
console.log([].length);     // 0(空陣列的長度是 0)

索引從 0 開始,所以最後一個元素的索引是 length - 1:

const fruits = ['apple', 'banana', 'mango'];

console.log(fruits[fruits.length - 1]); // mango(最後一個元素)
console.log(fruits[fruits.length]);     // undefined(超出範圍)

MDN 說明,length 的值是一個小於 232 的非負整數,並且永遠大於陣列中最大的索引。

length 會自動跟著陣列內容變動

陣列物件會自動讓 length 與內容保持同步。依 MDN 與 ECMAScript 規格,這表示:

你做的事結果
把 length 設成比目前小的值陣列被截斷,超出新長度的元素被刪除
把 length 設成比目前大的值陣列被延長,多出來的是空位(empty slot)
對超出目前長度的索引賦值length 自動增加為「最大索引 + 1」

最後一種情況:

const a = ['a', 'b'];
a[5] = 'f';

console.log(a.length); // 6
console.log(a);        // [ 'a', 'b', <3 empty items>, 'f' ]

索引 2 到 4 沒有被賦值,所以是空位,但 length 已經變成 6。

縮短陣列:修改 length 會截斷元素

直接指定比目前小的 length,超出的元素就會被刪除,而且無法復原:

const numbers = [1, 2, 3, 4, 5];

if (numbers.length > 3) {
  numbers.length = 3;
}

console.log(numbers);        // [ 1, 2, 3 ]
console.log(numbers[3]);     // undefined(後面的元素已被刪除)

這個寫法會直接改動原本的陣列,不會回傳新陣列。如果想保留原陣列,可以用 slice() 取出需要的部分。

即使之後再把 length 改回 5,被刪掉的 4 和 5 也不會回來,只會變成空位:

numbers.length = 5;
console.log(numbers); // [ 1, 2, 3, <2 empty items> ]

用 length = 0 清空陣列

把 length 設成 0,等於刪除所有元素:

const list = [1, 2, 3];
list.length = 0;

console.log(list);        // []
console.log(list.length); // 0

這個寫法與「指定一個新的空陣列」不同。length = 0 是清空同一個陣列物件,所有指向它的變數都會看到變化;= [] 只是讓這個變數改指向新陣列,其他變數仍指向舊陣列:

const ref = [1, 2, 3];
const alias = ref;
ref.length = 0;
console.log(alias); // [](同一個陣列,一起被清空)

let re = [1, 2, 3];
const alias2 = re;
re = [];
console.log(alias2); // [ 1, 2, 3 ](alias2 仍指向舊陣列)

延長陣列:多出來的是空位,不是 undefined

把 length 設成比目前大的值,新增的位置是空位,不是值為 undefined 的元素:

const arr = [1, 2];
arr.length = 5;

console.log(arr);    // [ 1, 2, <3 empty items> ]
console.log(3 in arr); // false(索引 3 沒有這個屬性)
arr.forEach((e) => console.log(e)); // 只印出 1、2

forEach() 等方法會略過空位,所以只執行兩次。因此 length 計算的是「位置數」,不保證每個位置都有值:

console.log([undefined, undefined, undefined].length); // 3
console.log(new Array(3).length);                      // 3(全是空位)
console.log([1, , 3].length);                          // 3
console.log(Object.keys([1, , 3]).length);             // 2(只有兩個真正存在的元素)

用 length 控制迴圈

走訪陣列時,可以用 length 當迴圈的結束條件:

const numbers = [1, 2, 3, 4, 5];
const length = numbers.length;

for (let i = 0; i < length; i++) {
  numbers[i] *= 2;
}

console.log(numbers); // [ 2, 4, 6, 8, 10 ]

注意事項

  1. length 不是元素個數的保證:如上所述,空位也會被算進 length。想知道真正有值的元素數量,可以用 filter() 之類會略過空位的方法計算。
    const sparse = [];
    sparse[100] = 1;
    
    console.log(sparse.length);                    // 101
    console.log(sparse.filter(() => true).length); // 1
  2. 設定不合法的值會丟出 RangeError:length 必須是小於 232 的非負整數,負數、小數、NaN 與過大的值都不行:new Array(-100) 同樣會丟出 RangeError。
    for (const v of [-1, 1.5, 2 ** 32, NaN]) {
      try {
        const x = [];
        x.length = v;
      } catch (e) {
        console.log(v, e.name + ': ' + e.message);
      }
    }
    // -1 RangeError: Invalid array length
    // 1.5 RangeError: Invalid array length
    // 4294967296 RangeError: Invalid array length
    // NaN RangeError: Invalid array length
  3. length 可以被設成唯讀:用 Object.defineProperty() 把 length 設為不可寫入後,陣列就無法再自動更新 length。在嚴格模式(strict mode)下,新增元素會丟出 TypeError:
    'use strict';
    
    const numbers = [1, 2, 3, 4, 5];
    Object.defineProperty(numbers, 'length', { writable: false });
    
    try {
      numbers[5] = 6;
    } catch (e) {
      console.log(e.name + ': ' + e.message);
    }
    // TypeError: Cannot assign to read only property 'length' of object '[object Array]'
  4. 有不可刪除的元素時,無法縮短到比它更小:ECMAScript 規格說明,若新長度小於等於某個不可設定(non-configurable)元素的索引,length 只會縮到該索引加 1:
    const locked = [1, 2, 3, 4];
    Object.defineProperty(locked, 2, { configurable: false, value: 3 });
    
    locked.length = 0;
    console.log(locked.length, locked); // 3 [ 1, 2, 3 ]

補充說明:字串也有 length,例如 'abc'.length 回傳 3。MDN 說明字串的 length 是以 UTF-16 code unit 計算長度,與陣列的 length 是兩個不同的屬性。

參考資料與延伸閱讀

發佈留言