JavaScript 的 replace() 有個讓人惱火的行為:傳入字串當搜尋條件時,它只會替換第一個符合的部分。這跟 PHP 的 str_replace 預設全域替換的行為差很多。本文整理幾種達成全域替換的方法。
replace 本身就能做到全域替換,關鍵是改用正則表達式並加上全域旗標 g:
str.replace(/www.baidu.com/g, 'www.jb51.net');
或者用建構子形式:
str.replace(new RegExp('www.baidu.com', 'gm'), 'www.jb51.net');
這會把 str 中所有的 www.baidu.com 換成 www.jb51.net。
但這裡有個大坑:範例中的 www.baidu.com 裡的點 . 在正則中是「任意字元」的意思,所以它其實會把 wwwXbaiduYcom 這種字串也一起換掉。處理網域或含特殊字元的字串時,必須先跳脫:
str.replace(/www\.baidu\.com/g, 'www.jb51.net');
// 或者用程式自動跳脫
function escapeRegExp(s) {
return s.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
}
str.replace(new RegExp(escapeRegExp('www.baidu.com'), 'g'), 'www.jb51.net');
自己包一個 replaceAll 方法,呼叫起來更直觀:
String.prototype.replaceall = function (s1, s2) {
return this.replace(new RegExp(s1, "gm"), s2);
}
這其實就是方法一的包裝。使用時:
str.replaceall('www.baidu.com', 'www.jb51.net');
不過擴充原生 prototype 有幾個缺點值得考慮:可能與其他函式庫或未來的標準方法命名衝突、會出現在 for-in 列舉中(除非用 Object.defineProperty 設為不可列舉)、也不利於程式碼追蹤。與其擴充,寫成獨立工具函式更安全:
function replaceAll(str, search, replacement) {
return str.split(search).join(replacement);
}
這個寫法有個好處:完全不涉及正則,因此不用處理跳脫問題,任何字元都能當搜尋目標,行為最可預測。
ES2021 正式提供了 String.prototype.replaceAll,目前所有主流瀏覽器與 Node.js 15+ 皆已支援:
'a-b-c'.replaceAll('-', '+'); // "a+b+c"
'a-b-c'.replaceAll(/-/g, '+'); // 正則也支援,但必須帶 g 旗標
注意一個規則:使用 replaceAll 搭配正則時,必須加上 g 旗標,否則會丟出 TypeError。這是刻意設計的,用來提醒你「replaceAll 搭配沒有 g 的正則」是矛盾的寫法。
第二個參數若含以下符號會有特殊意義,替換時要留意:
$&:符合的子字串本身$`:符合位置之前的部分$':符合位置之後的部分$n:第 n 個捕獲群組$$:字面的 $ 符號若想避免這些被解析,可改用函式作為第二參數:str.replace(/x/g, () => '$&'),函式的回傳值會被直接採用,不再做符號替換。