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

Javascript

JS Array.push() 用法:從尾端加入元素

JS Array.push() 用法:從尾端加入元素 特色圖片

Array.prototype.push()(一般簡稱 Array.push())是 JavaScript 用來在陣列尾端加入元素的方法:它會把你給的值接在陣列最後面,並回傳加入後的新長度。

白話一點,就像在排隊隊伍的最後面再站進一個人:隊伍變長了,而你拿到的是目前總共幾個人。

基本用法:加入元素並取得新長度

push() 可以不帶參數,也可以一次帶入多個要加入的元素,語法就是 array.push(element1, element2, ..., elementN)。

const fruits = ['apple', 'banana'];
const len = fruits.push('mango');

console.log(len);    // 3(新的長度,不是新陣列)
console.log(fruits); // [ 'apple', 'banana', 'mango' ]

MDN 說明,push() 的回傳值是呼叫方法後該物件的新 length,同時它會改變陣列的長度與內容。

一次加入多個元素

多個元素用逗號分開傳入,會依照傳入順序接在尾端,回傳值是加完之後的總長度:

const sports = ['soccer', 'baseball'];
const total = sports.push('football', 'swimming');

console.log(total);  // 4
console.log(sports); // [ 'soccer', 'baseball', 'football', 'swimming' ]

不傳任何參數時,陣列不會改變,回傳的就是目前的長度:

const empty = [];

console.log(empty.push()); // 0
console.log(empty);        // []

加入的是陣列時:整個當成一個元素

如果直接把陣列傳給 push(),那個陣列會被當成單一元素放進去,結果會變成巢狀陣列:

const a = [1, 2];
a.push([3, 4]);

console.log(a);        // [ 1, 2, [ 3, 4 ] ]
console.log(a.length); // 3

想把另一個陣列的每個元素都加進來,要用展開運算子(spread syntax,...)把它攤開:

const b = [1, 2];
b.push(...[3, 4]);

console.log(b);        // [ 1, 2, 3, 4 ]
console.log(b.length); // 4

合併兩個陣列

同樣的做法可以把第二個陣列的元素全部接到第一個陣列後面:

const vegetables = ['parsnip', 'potato'];
const moreVegs = ['celery', 'beetroot'];

vegetables.push(...moreVegs);

console.log(vegetables); // [ 'parsnip', 'potato', 'celery', 'beetroot' ]

MDN 提醒,展開運算子只在元素數量沒有超過引擎允許的函式引數上限時可用;陣列很長時,改用 concat(),或用迴圈多次呼叫 push()。

push() 會直接改動原陣列

push() 是會改動原陣列(mutating)的方法。如果想保留原陣列、拿到一個接上新元素的新陣列,MDN 建議改用 concat():

const orig = [1, 2, 3];
const added = orig.concat([4]);

console.log(added); // [ 1, 2, 3, 4 ]
console.log(orig);  // [ 1, 2, 3 ](原陣列沒有改變)

MDN 特別說明,這裡要把元素包在一個額外的陣列裡,因為如果元素本身是陣列,concat() 會把它攤開,而不是當成單一元素加入。

搭配迴圈挑出符合條件的元素

常見用法是在迴圈裡,把符合條件的值一個個加進新陣列:

const src = [1, 2, 3, 4];
const evens = [];

for (const n of src) {
  if (n % 2 === 0) evens.push(n);
}

console.log(evens); // [ 2, 4 ]

搭配 pop() 當作堆疊使用

push() 在尾端加入元素,pop() 從尾端取出元素,兩者搭配就是「後進先出」的堆疊(stack):

const stack = [];
stack.push('a');
stack.push('b');
stack.push('c');

console.log(stack.pop()); // c(最後放入的先取出)
console.log(stack.pop()); // b
console.log(stack);       // [ 'a' ]

進階:push() 是通用方法,也能用在類陣列物件

MDN 說明,push() 只要求 this 有 length 屬性與整數鍵的屬性;ECMAScript 規格也註明這個方法刻意設計成通用(generic),不要求 this 一定是陣列。因此可以用 call() 套用在類陣列物件上:

const arrayLike = { length: 3, unrelated: 'foo', 2: 4 };
Array.prototype.push.call(arrayLike, 1, 2);

console.log(arrayLike);
// { '2': 4, '3': 1, '4': 2, length: 5, unrelated: 'foo' }

如果物件沒有 length,會被當成長度 0,從索引 0 開始設定:

const plainObj = {};
Array.prototype.push.call(plainObj, 1, 2);

console.log(plainObj); // { '0': 1, '1': 2, length: 2 }

注意事項

  1. 回傳值是新長度,不是新陣列:const result = arr.push(1) 的 result 是數字,不能接著再串 .map() 等陣列方法。
  2. 字串不適合用 push():MDN 指出字串是不可變的(immutable),不適合當作 push() 的目標。
  3. 只能加在尾端:MDN 說明 unshift() 的行為與 push() 類似,但作用在陣列開頭,要加在開頭請用它。
  4. 長度有上限:規格規定,若原長度加上新增個數大於 2^53 – 1,會丟出 TypeError。

補充說明:規格定義的流程是:先取得目前長度,檢查加上新增個數是否超過 2^53 – 1,依序把每個值設定到以長度為索引的屬性,再把 length 設為新長度並回傳。

參考資料與延伸閱讀

發佈留言