PHP preg_replace 高级技巧：精确移除代码块间多余空行

本文深入探讨了在php中使用`preg_replace`函数处理多余空行时，正则表达式可能因字符消耗导致匹配不全的问题。通过分析原始正则表达式的局限性，文章详细介绍了两种高效解决方案：利用正向先行断言（lookahead）和`\k`元字符。这些高级技巧能确保正则表达式在不消耗关键字符的前提下，精确匹配并移除代码块（如javascript或php代码）之间不必要的换行和空白，从而优化代码格式，提高可读性。

在开发过程中，我们经常需要对代码或文本进行格式化，其中一个常见需求是移除多余的空行，尤其是在代码块之间。PHP的preg_replace函数结合正则表达式提供了强大的文本处理能力。然而，在处理这类问题时，如果不理解正则表达式的匹配机制，特别是字符消耗（consumption）的概念，可能会遇到匹配不全的问题。

1. 问题分析：正则表达式的字符消耗

考虑以下JavaScript代码片段，其中包含多余的空行：

for (let orange of oranges) {

  for (let apple of apples) {

    for (let banana of bananas) {

      obfuscatedArray[i] = obfuscatedArray[i].split('').reverse().join('');
      obfuscatedArray[i] = window.atob(obfuscatedArray[i]);

    }

  }

}

我们的目标是移除}和下一个}之间、或者;和下一个}之间的所有多余换行，使其变为：

for (let orange of oranges) {

  for (let apple of apples) {

    for (let banana of bananas) {

      obfuscatedArray[i] = obfuscatedArray[i].split('').reverse().join('');
      obfuscatedArray[i] = window.atob(obfuscatedArray[i]);
    }
  }
}

一个初看起来合理的正则表达式可能是 /(;|})(\n(\h*))+}/。在PHP中，我们可能会这样使用它：

立即学习“PHP免费学习笔记（深入）”；

$myString = preg_replace('/(;|})(\n(\h*))+}/', "$1\n$3}", $myString);

然而，这个模式在实际应用中并不能达到预期效果。它只会匹配并替换第一个和最后一个匹配项，而中间的换行却被遗漏了。例如，在上述JavaScript代码中，它可能只会移除第一个}后面的换行和最后一个}前面的换行，而中间的}后面的换行依然存在。

原因在于： 正则表达式在匹配成功后，会将匹配到的字符从输入字符串中“消耗”掉。原始模式 /(;|})(\n(\h*))+}/ 中的最后一个 } 会被匹配并消耗。这意味着，当正则表达式引擎尝试寻找下一个匹配时，这个已被消耗的 } 字符就不再可用了。因此，如果一个 } 后面紧跟着另一个 } 并且中间有多余的空行，第一个 } 会被模式的第一个捕获组 (;|}) 匹配，而第二个 } 则会被模式的最后一个 } 匹配并消耗，从而阻止了在两者之间进行第二次匹配。

2. 解决方案一：利用正向先行断言（Positive Lookahead）

正向先行断言 (?=...) 允许我们检查某个模式是否存在于当前位置的右侧，但不会消耗任何字符。这意味着，被断言匹配的字符仍然留在字符串中，可供后续的正则表达式匹配使用。

我们可以将原始模式的最后一个 } 替换为一个正向先行断言 (?=\n\h*})，表示我们期望在当前位置之后能看到一个换行符、可选的水平空白字符，以及一个 }，但这些字符本身不会被当前匹配消耗。

修正后的正则表达式：

/(;|})(\n(\h*))+(?=\n\h*})/

解析：

• (;|})：捕获一个分号或一个右花括号。这是匹配的起点。
• (\n(\h*))+：匹配一个或多个换行符，每个换行符后可以跟零个或多个水平空白字符。这是我们要移除的主要部分。
  • \n：匹配换行符。
  • \h*：匹配零个或多个水平空白字符（如空格、制表符）。
• (?=\n\h*})：正向先行断言。它断言当前位置后面紧跟着一个换行符、可选的水平空白字符和一个右花括号。这个 } 不会被当前匹配消耗。

PHP preg_replace 使用示例：

$myString = "for (let orange of oranges) {\n\n  for (let apple of apples) {\n\n    for (let banana of bananas) {\n\n      obfuscatedArray[i] = obfuscatedArray[i].split('').reverse().join('');\n      obfuscatedArray[i] = window.atob(obfuscatedArray[i]);\n\n    }\n\n  }\n\n}";

// 使用修正后的正则表达式
$myString = preg_replace('/(;|})(\n(\h*))+(?=\n\h*})/', "$1\n$3", $myString);

echo $myString;
/*
输出结果：
for (let orange of oranges) {
  for (let apple of apples) {
    for (let banana of bananas) {
      obfuscatedArray[i] = obfuscatedArray[i].split('').reverse().join('');
      obfuscatedArray[i] = window.atob(obfuscatedArray[i]);
    }
  }
}
*/

在替换字符串中， 引用了第一个捕获组（; 或 }），\n 确保保留一个换行符， 引用了 \h* 捕获组（用于保留可能的缩进）。

SONIFY.io

设计和开发音频优先的产品和数据驱动的解决方案

83

查看详情

3. 解决方案二：利用 \K 元字符重置匹配起始点

\K 是一个非常有用的元字符，它会“忘记”到目前为止所有匹配到的字符，并将当前匹配的起始点重置到 \K 所在的位置。这意味着，\K 之前匹配的任何内容都不会成为最终匹配结果的一部分，但它们仍然是匹配成功的必要条件。这在需要基于某个前缀进行匹配，但又不想替换掉该前缀时非常有用。

使用 \K 可以使正则表达式更加简洁，因为我们不再需要使用捕获组来保留前缀。

修正后的正则表达式（版本1）：

/[;}]\K(?:\R\h*)*(?=\R\h*})/

解析：

• [;}]：匹配一个分号或一个右花括号。
• \K：重置匹配起始点。此时，[;}] 匹配到的字符被“忘记”，不会包含在最终的匹配结果中。
• (?:\R\h*)*：匹配零个或多个非捕获组，每个组包含一个通用换行符 \R（可以匹配 \n, \r, \r\n 等）和零个或多个水平空白字符 \h*。这是我们要移除的多余空行和空白。
• (?=\R\h*})：正向先行断言，确保后面跟着一个换行符、可选的水平空白字符和一个右花括号，但这些字符不被消耗。

PHP preg_replace 使用示例：

由于 \K 之前的字符已被“忘记”，并且 (?=\R\h*}) 中的字符也没有被消耗，所以我们实际上匹配并替换的是 [;}] 和 } 之间的所有空行和空白。因此，替换字符串可以是一个空字符串。

$myString = "for (let orange of oranges) {\n\n  for (let apple of apples) {\n\n    for (let banana of bananas) {\n\n      obfuscatedArray[i] = obfuscatedArray[i].split('').reverse().join('');\n      obfuscatedArray[i] = window.atob(obfuscatedArray[i]);\n\n    }\n\n  }\n\n}";

// 使用 \K 的正则表达式
$myString = preg_replace('/[;}]\K(?:\R\h*)*(?=\R\h*})/', "\n", $myString); // 替换为一个换行符以保持格式

echo $myString;
/*
输出结果：
for (let orange of oranges) {
  for (let apple of apples) {
    for (let banana of bananas) {
      obfuscatedArray[i] = obfuscatedArray[i].split('').reverse().join('');
      obfuscatedArray[i] = window.atob(obfuscatedArray[i]);
    }
  }
}
*/

注意： 在这个例子中，如果替换为空字符串，会把所有的换行都移除。为了保持一个换行，我们替换为 \n。

4. 解决方案三：简化 \K 模式

我们可以进一步简化 (?:\R\h*)* 部分，因为它本质上是匹配任意数量的空白字符。

修正后的正则表达式（版本2）：

/[;}]\K\s*(?=\R\h*})/

解析：

• [;}]\K：与之前相同，匹配 ; 或 }，然后重置匹配起始点。
• \s*：匹配零个或多个任意空白字符（包括换行符、空格、制表符等）。这比 (?:\R\h*)* 更简洁，且通常能达到相同的效果。
• (?=\R\h*})：正向先行断言，确保后面跟着一个换行符、可选的水平空白字符和一个右花括号。

PHP preg_replace 使用示例：

$myString = "for (let orange of oranges) {\n\n  for (let apple of apples) {\n\n    for (let banana of bananas) {\n\n      obfuscatedArray[i] = obfuscatedArray[i].split('').reverse().join('');\n      obfuscatedArray[i] = window.atob(obfuscatedArray[i]);\n\n    }\n\n  }\n\n}";

// 使用简化的 \K 正则表达式
$myString = preg_replace('/[;}]\K\s*(?=\R\h*})/', "\n", $myString); // 替换为一个换行符

echo $myString;
/*
输出结果与之前相同。
*/

总结与注意事项

• 字符消耗的理解：在编写复杂的正则表达式时，理解哪些字符会被匹配消耗，哪些不会（如在先行断言中），是避免意外行为的关键。
• 先行断言 (?=...)：当需要检查某个模式是否存在于当前位置的右侧，但不希望将其包含在当前匹配结果中时，先行断言是理想选择。它允许我们基于上下文进行匹配。
• \K 元字符：\K 提供了一种简洁的方式来重置匹配的起始点，特别适用于需要匹配某个前缀但又不想替换该前缀的场景。它能有效减少捕获组的使用。
• \R vs \n：\R 是一个通用的换行符匹配，可以匹配 \n (LF), \r (CR), \r\n (CRLF) 等，在处理跨平台文本时更为健壮。如果确定只处理特定类型的换行，使用 \n 也可以。
• \h* vs \s*：\h* 匹配零个或多个水平空白字符，而 \s* 匹配零个或多个任何空白字符（包括换行符）。根据具体需求选择更合适的。
• 测试工具：在编写和调试正则表达式时，强烈推荐使用在线工具如 Regex101 或 RegExr。它们能直观地展示匹配过程、捕获组内容，并解释正则表达式的各个部分，极大地提高了开发效率。

通过掌握这些高级正则表达式技巧，我们可以更精确、高效地利用 preg_replace 函数进行文本处理和格式化，从而编写出更健壮、更专业的PHP代码。

以上就是PHP preg_replace 高级技巧：精确移除代码块间多余空行的详细内容，更多请关注php中文网其它相关文章！