正则表达式真的可以维护吗？

【问题标题】：Are regexes really maintainable?正则表达式真的可以维护吗？
【发布时间】：2008-09-29 21:27:42
【问题描述】：

我见过的任何使用正则表达式的代码都倾向于将它们用作黑盒：

  1. 输入字符串
  2. 魔术正则表达式
  3. 取出字符串

在生产代码中使用这似乎不是一个特别好的主意，因为即使是很小的更改也常常会导致完全不同的正则表达式。

除了标准是永久不变的情况外，正则表达式是做事的方式，还是尝试不同的方法更好？

【问题讨论】：

  • 任何代码结构都不是这样吗？ s/regex/arrays/ 这个问题同样有意义吗？还是我错过了什么？
  • 我想我正在理解一些较长的内容的不可穿透性 - 我已经看到正则表达式用于解析对我没有意义的上下文中的内容，例如从 html 中过滤 javscript -这似乎不是特别有用，因为该区域的情况经常发生变化。
  • @Rich，这些都是好点。但是，这些点中的任何一点如何更适用于正则表达式而不是任何代码？正则表达式是一种语言。适当地使用它，编写好的“程序”，你会没事的，滥用它，你会遇到麻烦。与 C++、Java 或 Python 没有什么不同。

标签： regex coding-style


【解决方案1】：

如果正则表达式冗长且难以理解，使它们难以维护，则应该对其进行注释。

许多正则表达式实现允许您用空格和 cmets 填充正则表达式。
见https://www.regular-expressions.info/freespacing.html#parenscomment
和编码恐怖：Regular Expressions: Now You Have Two Problems

我见过的任何使用正则表达式的代码都倾向于将它们用作黑盒：

如果你所说的黑盒是指抽象，那就是所有的编程，试图抽象出困难的部分（解析字符串），这样你就可以专注于问题域（我想匹配什么样的字符串）。

即使是很小的变化也常常会导致完全不同的正则表达式。

任何代码都是如此。只要您正在测试您的正则表达式以确保它与您期望的字符串匹配，理想情况下使用单元测试，那么您应该有信心更改它们。

编辑：另请阅读 Jeff 对此答案关于生产代码的评论。

【讨论】：

  • 确实！回复：单元测试。它们是活生生的意图记录。
  • 在生产代码中更改它们永远不会让您感到舒服。相反，它们应该在您的测试服务器上进行更改（它应该始终与您的生产服务器相同，除非您的测试代码不同）、测试并推送到您的产品服务器。更改产品代码：不好，Mkay？
  • 我认为您的 cmets 链接已损坏，也许您现在的意思是 regular-expressions.info/freespacing.html
【解决方案2】：

Obligatory.

这真的归结为正则表达式。如果是这个巨大的单体表达式，那么是的，这是一个可维护性问题。如果你能简洁地表达它们（也许通过分解它们），或者如果你有很好的 cmets 和工具来帮助你理解它们，那么它们可以成为一个强大的工具。

【讨论】：

  • 没有什么比一个好的评论更好的了，即使是一个简单的正则表达式。并非我的团队中的所有成员都理解它们，所以一个很好的评论解释它在做什么（有时用钥匙）对于维护是非常宝贵的。
【解决方案3】：

我不知道您使用的是哪种语言，但 Perl - 例如 - 支持 x 标志，因此除非转义，否则正则表达式中的空格将被忽略，因此您可以将其分成几行并内联注释所有内容： 

$foo =~ m{
    (some-thing)          # matches something
    \s*                   # matches any amount of spaces
    (match another thing) # matches something else
}x;

这有助于使长正则表达式更具可读性。

【讨论】：

  • Python 隐式执行此操作 :)
  • 对于知道正则表达式的人来说，那些 cmets 等价于 "i++; // 给 i 加一
  • 我怀疑 jkramer 是否建议将这些作为确切的 cmets，但只是指出了这样做的能力。 （太按字面意思举例）--
  • 嗯，是的，但我确实看到代码，尤其是 Perl，以这种方式注释。人们需要学习 Perl 语法，而不是使用 cmets 解释正则表达式基础知识或在关键字后使用“除非”或使用“或”的短路评估。
  • Perl 6 会/将隐式执行此操作。
【解决方案4】：

如果您不了解正则表达式，这似乎只是魔术。生产代码中的任何微小更改都可能导致重大问题，因此在我看来，这不是不使用正则表达式的好理由。彻底的测试应该指出任何问题。

【讨论】：

  • >> 如果您不了解正则表达式，这似乎很神奇。
  • 同意 Mike B 的观点。一些编码大神可能会立即理解一页长的正则表达式，但是对于大多数普通开发人员来说，正则表达式的强大功能是有代价的 :)
  • 我认为您在这里得到的基本观点是大多数程序员不太了解正则表达式。它们是非常重要的工具。这是教育缺陷，而不是编码缺陷。
  • @Mike：任何复杂的代码都可以这样说。不同之处在于开发人员经过培训可以理解代码。他们还需要接受培训以理解正则表达式，这是一项类似的技能，所以应该不会太难。
【解决方案5】：

对 any 语言中的 any 代码的微小更改可能会导致 完全 不同的结果。其中一些甚至会阻止编译。

用“C”或“C#”或“Java”或“Python”或“Perl”或“SQL”或“Ruby”或“awk”或......任何东西替换正则表达式，真的，你会得到同样的结果问题。

正则表达式只是另一种语言，Huffman coded 可以有效地进行字符串匹配。就像 Java、Perl、PHP 或特别是 SQL 一样，每种语言都有优点和缺点，并且您需要在编写（或维护）它时了解您正在编写的语言，以便有希望提高生产力。

编辑：Mike，正则表达式是 Huffman 编码的，通常要做的事情比稀有的事情要短。文本的文字匹配通常是单个字符（您要匹配的字符）。存在特殊字符 - 常见字符很短。特殊构造，例如 (?:) 更长。这些与 Perl、C++ 等通用语言中常见的东西不同，因此 Huffman 编码针对的是这种专业化。

【讨论】：

  • 霍夫曼编码与正则表达式有什么关系？
【解决方案6】：

复杂的正则表达式对我来说是一劳永逸的。编写它，测试它，当它工作时，写一个评论它做了什么，我们很好。

但是，在许多情况下，您可以将正则表达式分解为更小的部分，也许可以编写一些文档齐全的代码来组合这些正则表达式。但是如果你在你的代码中发现了一个多行的正则表达式，你最好不要去维护它:)

听起来很熟悉？任何代码或多或少都是如此。你不想有很长的方法，你不想有很长的类，你也不想有很长的正则表达式，尽管方法和类更容易重构。但本质上是同一个概念。

【讨论】：

    【解决方案7】：

    正则表达式并不是做某事的唯一方法。您可以在代码中逻辑地执行正则表达式可以执行的所有操作。正则表达式只是

    1. 快速
    2. 经过测试和验证
    3. 功能强大

    【讨论】：

    • 正则表达式其实很贵..但你是对的，它们很强大。
    • 正则表达式的开销很大，除非您开始多次使用它们。处理字符串的任何事情都是昂贵的，但是正则表达式可能比遍历每个字符串，查看它是否包含文本，然后执行您想要匹配的下一件事更好。
    • 贵怎么办？如果您只需要匹配/不匹配响应，那么它们是 O(N)，否则它们可能是指数的，但搜索相同事物的等效非 RE 方式也是如此：en.wikipedia.org/wiki/…
    【解决方案8】：

    如果您利用 Perl 5.10 引入的新功能，

    RegEx 可以非常维护。我所指的功能是来自Perl 6 的反向移植功能。

    直接从perlretut复制的示例。

    定义命名模式

    一些正则表达式在多个地方使用相同的子模式。从 Perl 5.10 开始，可以在模式的一部分中定义命名的子模式，以便可以在模式中的任何地方通过名称调用它们。这个定义组的语法模式是(?(DEFINE)(?<name>pattern)...)。命名模式的插入写为(?&name)。

    下面的示例使用前面介绍的浮点数模式说明了此功能。多次使用的三个子模式是可选符号、整数的数字序列和小数部分。模式末尾的DEFINE 组包含它们的定义。请注意，小数模式是我们可以重用整数模式的第一个地方。

    /^
  (?&osg)\ * ( (?&int)(?&dec)? | (?&dec) )
        (?: [eE](?&osg)(?&int) )?
 $
 (?(DEFINE)
     (?<osg>[-+]?)         # optional sign
     (?<int>\d++)          # integer
     (?<dec>\.(?&int))     # decimal fraction
 )
/x

    【讨论】：

      【解决方案9】：

      当有意识地使用正则表达式时，它是一种强大的机制，可以使您免于对可能的文本解析行和行。当然，它们应该被正确记录并有效地跟踪，以验证初始假设是否仍然有效，并相应地更新它们。关于维护恕我直言，更改一行代码（正则表达式模式）比理解解析代码的行和行或任何正则表达式的目的更好。

      【讨论】：

        【解决方案10】：

        正则表达式是做事的方式吗？这取决于任务。

        与所有编程事物一样，没有固定的正确或错误答案。

        如果正则表达式快速简单地解决特定任务，那么它可能比更冗长的解决方案更好。

        如果一个正则表达式试图完成一项复杂的任务，那么更冗长的东西可能更容易理解并因此维护。

        【讨论】：

          【解决方案11】：

          关于正则表达式的名言：

          “有些人在遇到问题时会想 “我知道，我会使用正则表达式。”现在他们有两个问题。”——Jamie Zawinski

          当我使用正则表达式时，我发现它们是可维护的，但它们在特殊情况下使用。通常有一种更好的非正则表达式方法可以处理几乎所有事情。

          【讨论】：

            【解决方案12】：

            有很多可能性可以使 RegEx 更易于维护。最后，它只是（好的？）程序员在进行重大（或有时甚至是次要）更改时必须学习的技术。当没有一些真正优秀的专业人士时，没有人会因为它们复杂的语法而打扰他们。但它们在工作中快速、紧凑且非常灵活。

            对于 .NET 用户，可能会有“Linq to RegEx”库更糟糕的外观或“Readable Regular Expressions Library”。它使它们更易于维护且更易于编写。我在自己的项目中使用了它们，我知道我用它们分析的 html 源代码可以随时更改。

            但请相信我：当您对他们有所了解时，他们甚至可以在写作和阅读方面取笑。 :)

            【讨论】：

              【解决方案13】：

              我有一个彻底评论非平凡正则表达式的政策。这意味着描述和证明每个与自身不匹配的原子。某些语言（例如 Python）提供忽略空格并允许 cmets 的“冗长”正则表达式；尽可能使用它。否则，请在正则表达式上方的评论中逐个原子地进行。

              【讨论】：

                【解决方案14】：

                问题不在于正则表达式本身，而在于它们被视为黑匣子。与任何编程语言一样，可维护性更多地与编写它的人和阅读它的人有关，而不是与语言本身有关。

                使用正确的工具完成工作还有很多要说的。在您在对原始帖子的评论中提到的示例中，正则表达式是用于解析 HTML 的错误工具，正如在 PerlMonks 上经常提到的那样。如果您尝试仅使用正则表达式以类似于一般方式的任何方式解析 HTML，那么您最终将要么以不正确且脆弱的方式进行解析，要么编写一个可怕且无法维护的正则表达式怪物，或者（很可能）两者都有。

                【讨论】：

                • StackOverflow 上也经常提到这一点。
                【解决方案15】：

                您的问题似乎与正则表达式本身无关，而仅与通常用于表达正则表达式的语法有关。在许多铁杆程序员中，这种语法已经被认为非常简洁和强大，但对于更长的正则表达式，它实际上是不可读和不可维护的。

                有些人已经在 Perl 中提到了“x”标志，这有点帮助，但没有多大帮助。

                我非常喜欢正则表达式，但不喜欢语法。能够从可读的、有意义的方法名称构造正则表达式会很好。例如，而不是这个 C# 代码：

                foreach (var match in Regex.Matches(input, @"-?(?<number>\d+)"))
{
    Console.WriteLine(match.Groups["number"].Value);
}

                你可以有更冗长但更易读和可维护的东西：

                int number = 0;
Regex r = Regex.Char('-').Optional().Then(
    Regex.Digit().OneOrMore().Capture(c => number = int.Parse(c))
);
foreach (var match in r.Matches(input))
{
    Console.WriteLine(number);
}

                这只是一个快速的想法；我知道还有其他不相关的可维护性问题（尽管我认为它们越来越少）。这样做的一个额外好处是编译时验证。

                当然，如果您认为这太过分并且过于冗长，您仍然可以使用介于两者之间的正则表达式语法，也许...

                instead of:   -?(?<number>\d+)
could have:   ("-" or "") + (number = digit * [1..])

                这仍然是可读性的一百万倍，而长度只有两倍。这样的语法可以很容易地与普通的正则表达式具有相同的表达能力，并且它当然可以集成到编程语言的编译器中进行静态分析。

                我真的不知道为什么即使重新考虑整个编程语言（例如 Perl 6 或 C# 是新的），重新考虑正则表达式的语法也会有如此多的反对意见。此外，上述非常冗长的想法甚至与“旧”正则表达式不兼容；该 API 可以很容易地实现为一种在底层构造旧式正则表达式的 API。

                【讨论】：

                  【解决方案16】：

                  Regex 确实被称为“只写”编程语言。但是，我不认为这意味着你应该避免它们。我只是认为您应该出于他们的意图发表评论。我通常不喜欢解释 what 一行的 cmets，我可以阅读它的代码，但 Regex 是个例外。评论一切！

                  【讨论】：

                    【解决方案17】：

                    我通常会编写扫描仪规范文件。扫描仪或“扫描仪生成器”本质上是优化的文本解析器。由于我通常使用 Java，因此我首选的方法是 JFlex (http://www.jflex.de)，但还有 Lex、YACC 和其他几种方法。

                    扫描程序处理可以定义为宏的正则表达式。然后当正则表达式匹配部分文本时实现回调。

                    当涉及到代码时，我有一个包含所有解析逻辑的规范文件。我通过选择的扫描仪生成器工具运行它，以选择语言生成源代码。然后我只是将所有这些包装到解析器函数或某种类中。这种抽象使得管理所有的正则表达式逻辑变得容易，而且性能非常好。当然，如果你只使用一两个正则表达式，那就太过分了，而且至少需要 2-3 天的时间来了解到底发生了什么，但如果你曾经使用过 5 或 6 或 30 个其中，它变成了一个非常好的特性，实现解析逻辑开始只需几分钟，而且它们易于维护和记录。

                    【讨论】：

                      【解决方案18】：

                      我一直将这个问题视为一个构建块问题。

                      您不只是编写一些 3000 个字符的正则表达式并希望获得最好的结果。你写了一堆小块，然后加在一起。

                      例如，要匹配一个 URI，你有协议、权限、子域、域、tld、路径、参数（至少）。其中一些是可选的！

                      我相信你可以编写一个怪物来处理它，但是编写块并将它们添加在一起更容易。

                      【讨论】：

                        【解决方案19】：

                        我通常用 cmets 将正则表达式分成几部分，然后将它们放在一起进行最后的推动。片段可以是子字符串或数组元素

                        两个 PHP PCRE 示例（细节或特定用途并不重要）：

                        1)
  $dktpat = '/^[^a-z0-9]*'. // skip any initial non-digits
    '([a-z0-9]:)?'. // division within the district
    '(\d+)'. // year
    '((-)|-?([a-z][a-z])-?)'. // type of court if any - cv, bk, etc.
    '(\d+)'. // docket sequence number
    '[^0-9]*$/i'; // ignore anything after the sequence number
  if (preg_match($dktpat,$DocketID,$m)) {

2)
    $pat= array (
      'Row'        => '\s*(\d*)',
      'Parties'    => '(.*)',
      'CourtID'    => '<a[^>]*>([a-z]*)</a>',
      'CaseNo'     => '<a[^>]*>([a-z0-9:\-]*)</a>',
      'FirstFiled' => '([0-9\/]*)',
      'NOS'        => '(\d*)',
      'CaseClosed' => '([0-9\/]*)',
      'CaseTitle'  => '(.*)',
    );
    // wrap terms in table syntax
    $pat = '#<tr>(<td[^>]*>'.
      implode('</td>)(</tr><tr>)?(<td[^>]*>',$pat).
      '</td>)</tr>#iUx';
    if (preg_match_all ($pat,$this->DocketText,$matches, PREG_PATTERN_ORDER))

                        【讨论】：

                          【解决方案20】：

                          我在我的应用程序中使用它们，但我将实际的正则表达式保留在配置文件中，因此如果我正在解析的源文本（例如电子邮件）由于某种原因更改格式，我可以快速更新配置以处理更改无需重新构建应用程序。

                          【讨论】：

                            猜你喜欢
                            • 1970-01-01
                            • 2012-08-28
                            • 2013-12-23
                            • 2015-03-21
                            • 2013-06-06
                            • 2015-11-28
                            • 1970-01-01
                            • 1970-01-01
                            相关资源
                            最近更新 更多
                            热门标签
                            Java Python linux javascript Mysql C# Docker 算法 前端 SpringBoot Redis Vue spring 设计模式 .net core .net kubernetes c++ 数据库 数据结构 大数据 js 机器学习 微服务 Android Go 程序员 面试 JVM ASP.net core 云原生 人工智能 后端 PHP git CSS golang k8s Nginx Django mybatis 深度学习 多线程 React 架构 devops 爬虫 云计算 Spring Boot LeetCode