RegExp.prototype[Symbol.match]()

Baseline 已廣泛支援

此特性已非常成熟,可在多種裝置和瀏覽器版本上使用。自 ⁨2016 年 9 月⁩以來,它已在各大瀏覽器中可用。

[Symbol.match]() 方法是 RegExp 例項上用於指定 String.prototype.match() 應如何表現的方法。此外,它的存在(或缺失)會影響物件是否被視為正則表示式。

試一試

class RegExp1 extends RegExp {
  [Symbol.match](str) {
    const result = RegExp.prototype[Symbol.match].call(this, str);
    if (result) {
      return "VALID";
    }
    return "INVALID";
  }
}

console.log("2012-07-02".match(new RegExp1("(\\d+)-(\\d+)-(\\d+)")));
// Expected output: "VALID"

語法

js
regexp[Symbol.match](str)

引數

str

作為匹配目標的 String

返回值

一個 Array,其內容取決於全域性標誌(g)是否存在,如果未找到匹配項,則為 null

  • 如果使用了 g 標誌,將返回所有與整個正則表示式匹配的結果,但不包含捕獲組。
  • 如果未使用 g 標誌,則只返回第一個完整匹配及其相關的捕獲組。在這種情況下,match() 將返回與 RegExp.prototype.exec() 相同的結果(一個帶有額外屬性的陣列)。

描述

此方法在 String.prototype.match() 中被內部呼叫。

例如,以下兩個示例返回相同的結果。

js
"abc".match(/a/);

/a/[Symbol.match]("abc");

如果正則表示式是全域性的(帶有 g 標誌),則將重複呼叫該正則表示式的 exec() 方法,直到 exec() 返回 null。否則,exec() 只會被呼叫一次,其結果將成為 [Symbol.match]() 的返回值。

因為 [Symbol.match]() 會持續呼叫 exec() 直到它返回 null,並且 exec() 在最後一個匹配失敗時會自動將正則表示式的 lastIndex 重置為 0,所以 [Symbol.match]() 在退出時通常不會產生副作用。但是,當正則表示式是 粘性(sticky)但非全域性時,lastIndex 不會被重置。在這種情況下,每次呼叫 match() 都可能返回不同的結果。

js
const re = /[abc]/y;
for (let i = 0; i < 5; i++) {
  console.log("abc".match(re), re.lastIndex);
}
// [ 'a' ] 1
// [ 'b' ] 2
// [ 'c' ] 3
// null 0
// [ 'a' ] 1

當正則表示式是粘性且全域性時,它仍然會執行粘性匹配 — 即,它將無法匹配 lastIndex 之後的任何出現。

js
console.log("ab-c".match(/[abc]/gy)); // [ 'a', 'b' ]

如果當前匹配為空字串,lastIndex 仍會被推進 — 如果正則表示式是 Unicode 感知的,它將前進一個 Unicode 程式碼點;否則,它將前進一個 UTF-16 程式碼單元。

js
console.log("😄".match(/(?:)/g)); // [ '', '', '' ]
console.log("😄".match(/(?:)/gu)); // [ '', '' ]

此方法用於自定義 RegExp 子類中的匹配行為。

此外,[Symbol.match] 屬性用於 檢查一個物件是否為正則表示式

示例

直接呼叫

此方法的使用方式與 String.prototype.match() 幾乎相同,只是 this 的值和引數順序不同。

js
const re = /\d+/g;
const str = "2016-01-02";
const result = re[Symbol.match](str);
console.log(result); // ["2016", "01", "02"]

在子類中使用 [Symbol.match]()

RegExp 的子類可以覆蓋 [Symbol.match]() 方法來修改預設行為。

js
class MyRegExp extends RegExp {
  [Symbol.match](str) {
    const result = RegExp.prototype[Symbol.match].call(this, str);
    if (!result) return null;
    return {
      group(n) {
        return result[n];
      },
    };
  }
}

const re = new MyRegExp("(\\d+)-(\\d+)-(\\d+)");
const str = "2016-01-02";
const result = str.match(re); // String.prototype.match calls re[Symbol.match]().
console.log(result.group(1)); // 2016
console.log(result.group(2)); // 01
console.log(result.group(3)); // 02

規範

規範
ECMAScript® 2026 語言規範
# sec-regexp.prototype-%symbol.match%

瀏覽器相容性

另見