本文深入探讨了纯javascript实现关键词高亮功能时，在处理连续多词匹配场景下出现的替换错误。通过分析原代码中对`split`结果的误用，并引入正则表达式捕获组的技巧，结合对数组长度的准确判断，提供了一种健壮且精确的解决方案，确保在复杂文本结构中也能正确高亮所有匹配词汇。
在网页开发中，实现一个轻量级、无框架、对大小写不敏感且能处理HTML标签内文本的关键词高亮功能是常见的需求。通常，我们会通过遍历DOM树，在文本节点中查找并替换匹配的词汇。然而，在处理连续多词匹配时，如果不恰当地使用字符串分割和替换逻辑，很容易引入难以察觉的错误。
问题描述
一个常见的关键词高亮实现可能如以下代码所示，它通过扩展HTMLElement.prototype来提供realcar方法：
HTMLElement.prototype.realcar = function(word) {
var el = this;
const wordss = word.trim().sanitiza().split(" ").filter(word1 => word1.length > 2);
const expr = new RegExp(wordss.join('|'), 'ig');
let expr00 = expr;
const RegExpUNICO = wordss;
const nodes = Array.from(el.childNodes);
for (let i = 0; i < nodes.length; i++) {
const node = nodes[i];
if (node.nodeType === 3) { // 文本节点
const nodeValue = node.nodeValue;
let matches = [];
while ((match = expr.exec((nodeValue).sanitiza())) !== null) {
matches.push(match[0]);
const palavrar = nodeValue.substring(match.index, match.index + match[0].length);
RegExpUNICO.push(palavrar);
}
expr00 = RegExpUNICO.join('|');
let expr0 = new RegExp(expr00, 'ig');
console.log("**" + expr00);
if (matches) { // 存在匹配项
const parts = nodeValue.split(expr0);
for (let n = 0; n < parts.length; n++) {
if (n) { // 非第一个部分，说明前面有一个匹配项
const xx = document.createElement("hightx");
xx.style.border = '1px solid blue';
xx.style.backgroundColor = '#ffea80';
// 错误点：尝试通过indexOf定位匹配词
const startIndex = nodeValue.indexOf(parts[n - 1]) + parts[n - 1].length;
const palavra = node.nodeValue.substr(startIndex, matches[n - 1].length);
xx.appendChild(document.createTextNode(palavra));
el.insertBefore(xx, node);
}
if (parts[n]) { // 非空文本部分
el.insertBefore(document.createTextNode(parts[n]), node);
}
}
el.removeChild(node);
}
} else { // 非文本节点，递归处理
node.realcar(word);
}
}
}当用户搜索连续的词语时，例如 "light nos" 在 "Highlight nossa!" 中，期望高亮 "light" 和 "nos"。然而，在某些情况下，第二个词会被错误地替换为句子中在最后一个空格之后出现的其他词语，而不是预期的搜索词。
问题分析
此代码中存在两个主要问题：
立即学习“Java免费学习笔记（深入）”；
-
indexOf 的不确定性： 核心问题在于这行代码：
const startIndex = nodeValue.indexOf(parts[n - 1]) + parts[n - 1].length;
它假设 parts[n - 1]（即非匹配文本部分）在 nodeValue 中只出现一次。然而，这并非总能保证。例如，如果 parts[n - 1] 是一个简单的空格，并且字符串中前面有多个空格，那么 indexOf 将会返回第一个空格的位置，导致计算出的 startIndex 错误，从而截取到错误的词语进行高亮。
if (matches) 的误用：if (matches) 这一条件判断始终为真，因为即使 matches 是一个空数组 []，它在 JavaScript 中也是一个“真值”（truthy value）。正确的判断方式应该是检查数组的长度，即 if (matches.length)。
解决方案
解决第一个问题的关键在于，我们需要一种方法来精确地知道 nodeValue 中下一个要提取的子字符串是什么，无论是匹配的关键词还是非匹配的文本。这可以通过在正则表达式中使用“捕获组”（capture group）来实现，并结合 String.prototype.split() 方法的特性。
当 split() 方法的正则表达式参数包含捕获组时，匹配到的分隔符（即捕获组捕获到的内容）也会被包含在返回的数组中。这意味着返回的数组将交替包含非匹配文本和匹配文本，从而无需再使用 indexOf 来定位。
以下是修复后的关键代码段：
if (matches.length) { // 必须检查 .length
// 将 expr0 的创建移到此处，并确保 RegExpUNICO 包含所有匹配词
// 创建一个捕获组，通过添加括号实现：
const expr00 = "(" + RegExpUNICO.join('|') + ")";
const expr0 = new RegExp(expr00, 'ig');
const parts = nodeValue.split(expr0); // parts 数组现在会包含匹配项
for (let n = 0; n < parts.length; n++) {
const textNode = document.createTextNode(parts[n]);
if (n % 2) { // 匹配项总是在奇数索引位置，因为捕获组会将其包含进来
const xx = document.createElement("hightx");
xx.style.border = '1px solid blue';
xx.style.backgroundColor = '#ffea80';
// 不再需要确定索引或长度：我们直接拥有精确的子字符串
xx.appendChild(textNode);
el.insertBefore(xx, node);
} else if (parts[n]) { // 非匹配的（非空）子字符串
el.insertBefore(textNode, node);
}
}
el.removeChild(node);
}修正后的 realcar 函数
将上述修正集成到完整的 realcar 函数中，如下所示：
HTMLElement.prototype.realcar = function(word) {
var el = this;
// 清理和分割搜索词，过滤掉长度小于等于2的词
const wordss = word.trim().sanitiza().split(" ").filter(word1 => word1.length > 2);
// 创建一个用于初步匹配的正则表达式
const expr = new RegExp(wordss.join('|'), 'ig');
// RegExpUNICO 用于收集所有匹配到的词，包括原始搜索词和在文本中实际匹配到的词
// 这样可以确保 split 时能匹配到所有相关词汇
let RegExpUNICO = [...wordss]; // 初始包含搜索词
const nodes = Array.from(el.childNodes);
for (let i = 0; i < nodes.length; i++) {
const node = nodes[i];
if (node.nodeType === 3) { // 处理文本节点
const nodeValue = node.nodeValue;
let matches = [];
let match;
// 使用 expr 查找所有匹配项，并收集到 matches 数组和 RegExpUNICO 中
while ((match = expr.exec((nodeValue).sanitiza())) !== null) {
matches.push(match[0]);
// 确保添加到 RegExpUNICO 的是实际匹配到的文本，而非原始搜索词
const actualMatchedWord = nodeValue.substring(match.index, match.index + match[0].length);
// 避免重复添加，如果实际匹配词已存在于 RegExpUNICO
if (!RegExpUNICO.includes(actualMatchedWord.toLowerCase())) { // 转换为小写进行比较，避免重复
RegExpUNICO.push(actualMatchedWord);
}
}
if (matches.length) { // 只有当有匹配项时才进行 DOM 操作
// 重新构建用于 split 的正则表达式，包含捕获组
// 确保 RegExpUNICO 中的词是唯一的，并进行排序（可选，但有助于调试）
const uniqueWords = Array.from(new Set(RegExpUNICO.map(w => w.toLowerCase()))).join('|');
const expr00 = "(" + uniqueWords + ")"; // 添加括号创建捕获组
const expr0 = new RegExp(expr00, 'ig');
// 使用带有捕获组的正则表达式进行分割
const parts = nodeValue.split(expr0);
for (let n = 0; n < parts.length; n++) {
const partText = parts[n];
if (partText === undefined || partText === null) continue; // 避免处理 undefined/null
const textNode = document.createTextNode(partText);
if (n % 2) { // 奇数索引是匹配到的词
const xx = document.createElement("hightx");
xx.style.border = '1px solid blue';
xx.style.backgroundColor = '#ffea80';
xx.appendChild(textNode);
el.insertBefore(xx, node);
} else if (partText.length > 0) { // 偶数索引是非匹配文本，且不为空
el.insertBefore(textNode, node);
}
}
el.removeChild(node); // 移除原始文本节点
}
} else { // 递归处理非文本子节点
node.realcar(word);
}
}
}注意事项：
- sanitiza() 方法未在提供的代码中定义，假设它是一个用于清理字符串的辅助函数。
- RegExpUNICO 的使用方式有所调整，以确保它只包含实际需要作为分隔符的词汇，并且在创建最终 expr0 时，通过 Set 去重并转换为小写，以避免正则表达式过长或重复匹配的问题。
- parts[n] 可能为 undefined 或 null，尤其是在字符串以匹配项开头或结尾时，因此在处理 partText 时添加了额外的检查。
总结
通过引入正则表达式捕获组并正确利用 String.prototype.split() 的行为，我们能够精确地将文本内容分割成匹配项和非匹配项的交替序列。这消除了对 indexOf 方法的不可靠依赖，从而解决了在多词连续匹配场景下高亮错误的问题。同时，修正 if (matches) 为 if (matches.length) 确保了逻辑的严谨性。在进行文本操作和DOM修改时，理解字符串方法和正则表达式的细微之处至关重要，以构建健壮且准确的功能。
