大网数据广告活动
Web 标准与前端开发

RegExp.prototype[Symbol.split]()

· 52CE 我爱测

**`Symbol.split`** 是 RegExp 实例的方法,它指定了当正则表达式作为分隔符传入 `String.prototype.split` 时,字符串应如何被分割。

[Symbol.split]() 是 RegExp 实例的方法,它指定了当正则表达式作为分隔符传入 String.prototype.split 时,字符串应如何被分割。

JavaScript Demo: RegExp.prototypeSymbol.split

class RegExp1 extends RegExp {
  [Symbol.split](str, limit) {
    const result = RegExp.prototype[Symbol.split].call(this, str, limit);
    return result.map((x) => `(${x})`);
  }
}

console.log("2016-01-02".split(new RegExp1("-")));
// 预期输出:Array ["(2016)", "(01)", "(02)"]

console.log("2016-01-02".split(/-/));
// 预期输出:Array ["2016", "01", "02"]

语法

regexp[Symbol.split](str)
regexp[Symbol.split](str, limit)

参数

  • str
    • : 分割操作的目标。
  • limit
    • : 一个指定要查找的分割次数的上限的整数。[Symbol.split]() 方法仍然会对 this 正则表达式模式(或上述语法中的 regexp)的每个匹配项进行分割,直到分割的元素数量达到 limit 限制,或者字符串中不再匹配该模式。

返回值

一个包含子字符串作为元素的 Array。捕获组也会被包含在内。

描述

此方法用于在 RegExp 子类中自定义 split() 的行为。当 RegExp 作为分隔符传入时,String.prototype.split() 会在内部调用此方法。例如,下面的两个示例返回相同的结果。

"a-b-c".split(/-/);

/-/[Symbol.split]("a-b-c");

与 [Symbol.matchAll]() 类似,[Symbol.split]() 首先使用 [Symbol.species] 构造一个新的正则表达式,从而避免以任何方式修改原始正则表达式。构造函数接收 this 和原始标志;如果原始标志中没有 y(“粘性”)标志,还会添加该标志。g(“全局”)标志与此方法的行为无关。由于 RegExp() 构造函数的行为,lastIndex 默认从 0 开始。

如果目标字符串是空字符串,且正则表达式可以匹配空字符串(例如 /a?/),则返回空数组。否则,如果正则表达式无法匹配空字符串,则返回 [""]。

正则表达式的 exec() 方法会被重复调用,每次调用都会推进 lastIndex,直到到达字符串末尾。如果当前匹配为空字符串,或者正则表达式(由于启用了粘性)在当前位置无法匹配,那么 lastIndex 仍会被推进——如果正则是支持 Unicode 的,则推进一个 Unicode 码位;否则,推进一个 UTF-16 码元。

console.log("😄".split(/(?:)/g)); // [ '\ud83d', '\ude04' ]
console.log("😄".split(/(?:)/gu)); // [ '😄' ]

对于每一次匹配,首先将上一个匹配结束位置与当前匹配开始位置之间的子字符串添加到结果数组中。然后,将当前匹配中的捕获组值逐个添加进去。返回的数组长度不会超过提供的 limit 参数(如果有的话),同时会尽可能接近该限制。因此,如果数组已满,最后一个匹配项及其捕获组可能不会全部出现在返回的数组中。

如果整个字符串中没有成功匹配,则返回原始字符串本身,并将其包裹在一个数组中。

示例

直接调用

该方法的用法几乎与 String.prototype.split() 相同,不同之处在于 this 对象不同且参数顺序也有所区别。

const re = /-/g;
const str = "2016-01-02";
const result = re[Symbol.split](str);
console.log(result); // ["2016", "01", "02"]

在子类中使用 [Symbol.split]()

RegExp 的子类可以重写 [Symbol.split]() 方法,以修改默认行为。

class MyRegExp extends RegExp {
  [Symbol.split](str, limit) {
    const result = RegExp.prototype[Symbol.split].call(this, str, limit);
    return result.map((x) => `(${x})`);
  }
}

const re = new MyRegExp("-");
const str = "2016-01-02";
const result = str.split(re); // String.prototype.split 会调用 re[Symbol.split]()。
console.log(result); // ["(2016)", "(01)", "(02)"]

规范

浏览器兼容性

参见

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。