如何使正则表达式操作超时以防止在 .NET 4.5 中挂起？

Question

有时，能够限制正则表达式操作的模式匹配持续时间可能会很有用。特别是，当使用用户提供的模式来匹配数据时，由于嵌套量词和过多的回溯，该模式可能会表现出较差的性能（请参阅灾难性回溯）。应用超时的一种方法是异步运行正则表达式，但这可能很乏味并且会使代码混乱。

根据 .NET Framework 4.5 开发人员中的新增功能预览 看起来有一个新的内置方法来支持这一点：

能够限制正则表达式引擎尝试的时间长度 在超时之前解析正则表达式。

我该如何使用此功能？另外，使用时需要注意什么？

_{注意：我问并回答这个问题，因为这是受到鼓励的。}

Answer 1

我最近研究了这个主题，因为它让我感兴趣，并将在此介绍要点。相关的 MSDN 文档位于此处您可以查看 Regex 类来查看新的重载构造函数和静态方法。代码示例可以使用 Visual Studio 11 开发人员预览版< /a>.

Regex 类接受 TimeSpan< /code> 指定超时时间。您可以在应用程序中在宏观和微观级别上指定超时，并且它们可以一起使用：

• 使用 "REGEX_DEFAULT_MATCH_TIMEOUT" 属性。 com/en-us/library/system.appdomain.setdata%28v=VS.110%29.aspx" rel="noreferrer">AppDomain.SetData method（宏观应用程序范围）
• 传递matchTimeout参数（微观本地范围）

当设置AppDomain属性时，所有Regex 操作将使用该值作为默认超时。要覆盖应用程序范围的默认值，您只需将 matchTimeout 值传递给正则表达式构造函数或静态方法即可。如果未设置 AppDomain 默认值，并且未指定 matchTimeout，则模式匹配不会超时（即原始 .NET 4.5 之前的行为）。

有 2 个主要异常需要处理：

• RegexMatchTimeoutException：超时时抛出。
• ArgumentOutOfRangeException：当“matchTimeout 为负数或大于大约 24 天”时抛出。此外，TimeSpan 值为零将导致抛出此错误。

尽管不允许使用负值，但有一个例外：接受 -1 毫秒的值。在内部，Regex 类接受 -1 毫秒，这是 Regex.InfiniteMatchTimeout 字段，指示匹配不应超时（即，.NET 4.5 之前的原始行为）。

使用 matchTimeout 参数

在下面的示例中，我将演示有效和无效的超时场景以及如何处理它们：

string input = "The quick brown fox jumps over the lazy dog.";
string pattern = @"([a-z ]+)*!";
var timeouts = new[]
{
    TimeSpan.FromSeconds(4),     // valid
    TimeSpan.FromSeconds(-10)    // invalid
};

foreach (var matchTimeout in timeouts)
{
    Console.WriteLine("Input: " + matchTimeout);
    try
    {
        bool result = Regex.IsMatch(input, pattern,
                                    RegexOptions.None, matchTimeout);
    }
    catch (RegexMatchTimeoutException ex)
    {
        Console.WriteLine("Match timed out!");
        Console.WriteLine("- Timeout interval specified: " + ex.MatchTimeout);
        Console.WriteLine("- Pattern: " + ex.Pattern);
        Console.WriteLine("- Input: " + ex.Input);
    }
    catch (ArgumentOutOfRangeException ex)
    {
        Console.WriteLine(ex.Message);
    }
    Console.WriteLine();
}

使用 Regex 类的实例时，您可以访问 MatchTimeout 属性：

string input = "The English alphabet has 26 letters";
string pattern = @"\d+";
var matchTimeout = TimeSpan.FromMilliseconds(10);
var sw = Stopwatch.StartNew();
try
{
    var re = new Regex(pattern, RegexOptions.None, matchTimeout);
    bool result = re.IsMatch(input);
    sw.Stop();

    Console.WriteLine("Completed match in: " + sw.Elapsed);
    Console.WriteLine("MatchTimeout specified: " + re.MatchTimeout);
    Console.WriteLine("Matched with {0} to spare!",
                         re.MatchTimeout.Subtract(sw.Elapsed));
}
catch (RegexMatchTimeoutException ex)
{
    sw.Stop();
    Console.WriteLine(ex.Message);
}

使用 AppDomain 属性

"REGEX_DEFAULT_MATCH_TIMEOUT" 属性用于设置应用程序范围的默认值：

AppDomain.CurrentDomain.SetData("REGEX_DEFAULT_MATCH_TIMEOUT",
                                TimeSpan.FromSeconds(2));

如果设置了此属性无效的 TimeSpan 值或无效的对象，TypeInitializationException 将在尝试使用时抛出一个正则表达式。

具有有效属性值的示例：

// AppDomain default set somewhere in your application
AppDomain.CurrentDomain.SetData("REGEX_DEFAULT_MATCH_TIMEOUT",
                                TimeSpan.FromSeconds(2));

// regex use elsewhere...
string input = "The quick brown fox jumps over the lazy dog.";
string pattern = @"([a-z ]+)*!";

var sw = Stopwatch.StartNew();
try
{
    // no timeout specified, defaults to AppDomain setting
    bool result = Regex.IsMatch(input, pattern);
    sw.Stop();
}
catch (RegexMatchTimeoutException ex)
{
    sw.Stop();
    Console.WriteLine("Match timed out!");
    Console.WriteLine("Applied Default: " + ex.MatchTimeout);
}
catch (ArgumentOutOfRangeException ex)
{
    sw.Stop();
}
catch (TypeInitializationException ex)
{
    sw.Stop();
    Console.WriteLine("TypeInitializationException: " + ex.Message);
    Console.WriteLine("InnerException: {0} - {1}",
        ex.InnerException.GetType().Name, ex.InnerException.Message);
}
Console.WriteLine("AppDomain Default: {0}",
    AppDomain.CurrentDomain.GetData("REGEX_DEFAULT_MATCH_TIMEOUT"));
Console.WriteLine("Stopwatch: " + sw.Elapsed);

将上面的示例与无效（负）值一起使用将导致引发异常。处理它的代码将以下消息写入控制台：

TypeInitializationException：类型初始值设定项
“System.Text.RegularExpressions.Regex”引发异常。

InnerException：ArgumentOutOfRangeException - 指定的参数是
超出有效值范围。参数名称：AppDomain数据
“REGEX_DEFAULT_MATCH_TIMEOUT”包含无效值或对象
指定默认匹配超时
System.Text.RegularExpressions.Regex。

在这两个示例中，都不会抛出ArgumentOutOfRangeException。为了完整起见，代码显示了使用新的 .NET 4.5 Regex 超时功能时可以处理的所有异常。

覆盖 AppDomain 默认值

覆盖 AppDomain 默认值是通过指定 matchTimeout 值来完成的。在下一个示例中，匹配将在 2 秒内超时，而不是默认的 5 秒。

AppDomain.CurrentDomain.SetData("REGEX_DEFAULT_MATCH_TIMEOUT",
                                TimeSpan.FromSeconds(5));

string input = "The quick brown fox jumps over the lazy dog.";
string pattern = @"([a-z ]+)*!";

var sw = Stopwatch.StartNew();
try
{
    var matchTimeout = TimeSpan.FromSeconds(2);
    bool result = Regex.IsMatch(input, pattern,
                                RegexOptions.None, matchTimeout);
    sw.Stop();
}
catch (RegexMatchTimeoutException ex)
{
    sw.Stop();
    Console.WriteLine("Match timed out!");
    Console.WriteLine("Applied Default: " + ex.MatchTimeout);
}

Console.WriteLine("AppDomain Default: {0}",
    AppDomain.CurrentDomain.GetData("REGEX_DEFAULT_MATCH_TIMEOUT"));
Console.WriteLine("Stopwatch: " + sw.Elapsed);

结束语

MSDN 建议在所有正则表达式模式匹配操作中设置超时值。但是，它们不会让您注意这样做时需要注意的问题。我不建议设置 AppDomain 默认值然后就到此为止。您需要了解您的输入并了解您的模式。如果输入很大，或者模式很复杂，则应使用适当的超时值。这可能还需要测量您关键执行的正则表达式的使用情况以分配合理的默认值。如果该值不够长，则为曾经工作正常的正则表达式任意分配一个超时值可能会导致它崩溃。如果您认为可能会过早中止匹配尝试，请在分配值之前测量现有的使用情况。

此外，此功能在处理用户提供的模式时非常有用。然而，学习如何编写性能良好的正确模式很重要。通过超时来弥补对正确模式构建知识的缺乏并不是一个好的做法。