跳至主要內容
FrAIFlow

問題解決指南 / 文字與程式碼

為什麼錢字號會改變 JavaScript 的取代文字?

尋找取代工具竟然改變了取代文字本身?即使搜尋項目只是一般字串,JavaScript 仍會解讀取代參數中的錢字號序列。如果使用者要的是字面文字,請用函式回傳該文字。

同一值,兩種解讀
依保留範例製作的說明圖,並非應用程式截圖。

修改輸入前,先認清取代範本

假設要將佔位文字換成一段價格說明,而說明中有 $&。使用者預期看到這兩個字元,舊的佔位文字卻又出現。這不一定是編碼問題。即使搜尋使用普通字串而非正規表示式,取代參數仍有自己的一小套範本語法。

先複製文字,只測試一個比對。如果錢字號序列被改變,將取代參數改成回呼函式,再比較結果;這次比較保持搜尋條件不變。同時改動兩邊,會更難看出是哪個規則造成意外。

2012 年一則公開案例以 $' 取代整個字串,結果卻是空字串。這個符號表示比對內容後面的尾端文字;由於比對已涵蓋全部內容,後面便沒有剩餘文字。

const input = "as";
const replacement = "$'";
input.replace("as", replacement);       // ""
input.replace("as", () => replacement); // "$'"

保留的 Node.js v24.19.0 測試重現了兩種結果。其他取代符號包括代表一個錢字號的 $$、代表比對內容的 $&,以及模式中有對應群組時使用的 $1 等擷取參照。另有前綴與具名擷取形式,不是每個單獨錢字號都有特殊意義。

明確區分兩種模式
依保留範例製作的說明圖,並非應用程式截圖。

使用者要字面文字時,就使用回呼函式

const draft = "Price: TOKEN. Repeat: TOKEN.";
const typedReplacement = "$& costs $$";

console.log(draft.replaceAll("TOKEN", typedReplacement));
// Price: TOKEN costs $. Repeat: TOKEN costs $.

console.log(draft.replaceAll("TOKEN", () => typedReplacement));
// Price: $& costs $$. Repeat: $& costs $$.

第一個呼叫會解讀取代字串;第二個呼叫則由函式針對每次比對回傳使用者的字面值。回傳值直接插入,不會再經過取代範本解析。這適合承諾一般尋找取代的工具,使用者不應只為貼上文字,就必須學會特殊的錢字號跳脫規則。

不要為了修正這個問題,就自動把使用者的搜尋文字轉成正規表示式。在字面模式中,像 a.b 這樣的搜尋通常應找到真正的句點,而不是任意字元。如果同時提供正規表示式擷取與取代範本,請另設標示清楚的進階模式;像 $1 這種範本在該模式中有用,不應未加說明就突然變成普通文字。

字串取代會解讀錢字號符號,回呼則完整保留輸入的字面文字。
依上方相同的人工 Node.js 範例製作的前後比較說明,並非文字編輯器截圖。開啟圖片可查看完整細節。
function replaceLiteralOnce(text, search, value) {
  return text.replace(search, () => value);
}
function replaceLiteralAll(text, search, value) {
  if (search === "") throw new Error("Search must not be empty");
  return text.replaceAll(search, () => value);
}

這些函式預期接收應用程式提供的字串:一個只取代第一處,另一個取代所有符合的位置。只有replaceLiteralAll會拒絕空搜尋,避免意外在碼元之間插入文字。replaceLiteralOnce收到空搜尋時,會把取代值插入字串開頭。如果產品本來就支援擷取範本,應保留並清楚標示該模式,不要悄悄改變其意義。

在最後使用情境中,預覽完整修改

請同時顯示原文與修改後的文字,尤其是全部取代。測試包含單一錢字號、兩個錢字號、比對符號與空字串的取代值,也確認沒有比對時的行為。空取代值可以合法表示刪除;空搜尋則需要明確的產品決定,因為它可能在字串各位置之間插入文字。

最後確認結果如何顯示。回呼函式回傳字面文字,不代表 HTML 就安全。未受信任的文字應放在 textarea 或 textContent 中預覽,讓貼上的標籤顯示為文字,而不是執行。預覽符合使用者意圖後才儲存或送出,大量編輯也應保留復原方式。

保存的測試資料透過回呼回傳時,會完整保留 $&、$'、$$ 與 $1。請在自己的非回歸測試加入類似範例,涵蓋重複比對與空取代值。保留來源,大量修改前先預覽。

實測:字串參數產生空輸出,函式則保留字面的錢字號與單引號。
保留的原始說明圖。
Node.js 紀錄:含美元符號的取代文字,分別用字串引數與回呼函式處理時的差異
Node.js 對含字面錢字號文字執行取代的保存結果。這是測試輸出畫面,不是原發問者的應用程式。開啟完整尺寸的證據圖片。

資料來源與延伸閱讀