我有一个应该返回 IEnumerable<int> 的 C# 字符串扩展方法字符串中子字符串的所有索引。它完美地实现了预期目的，并返回了预期的结果(正如我的一个测试所证明的，尽管不是下面的那个)，但另一个单元测试发现了它的一个问题:它无法处理空参数。

这是我正在测试的扩展方法:

public static IEnumerable<int> AllIndexesOf(this string str, string searchText)
{
    if (searchText == null)
    {
        throw new ArgumentNullException("searchText");
    }
    for (int index = 0; ; index += searchText.Length)
    {
        index = str.IndexOf(searchText, index);
        if (index == -1)
            break;
        yield return index;
    }
}

这是标记问题的测试:

[TestMethod]
[ExpectedException(typeof(ArgumentNullException))]
public void Extensions_AllIndexesOf_HandlesNullArguments()
{
    string test = "a.b.c.d.e";
    test.AllIndexesOf(null);
}

当针对我的扩展方法运行测试时，它失败了，标准错误消息是该方法“没有抛出异常”。

这令人困惑:我显然已经通过了 null进入功能，但由于某种原因比较null == null正在返回 false .因此，不会抛出异常，代码继续。

我已经确认这不是测试的错误:在我的主项目中运行方法时调用 Console.WriteLine在空比较中 if block ，控制台上没有显示任何内容，并且任何 catch 都没有捕获到异常阻止我添加。此外，使用 string.IsNullOrEmpty而不是 == null有同样的问题。

为什么这种看似简单的比较会失败？

最佳答案

您正在使用 yield return。这样做时，编译器会将您的方法重写为一个函数，该函数返回一个实现状态机的生成类。

从广义上讲，它将局部变量重写为该类的字段，并且在 yield return 指令之间的算法的每个部分都变成了一个状态。您可以使用反编译器检查此方法在编译后会变成什么(确保关闭会产生 yield return 的智能反编译)。

但最重要的是:在您开始迭代之前，您的方法代码不会被执行。

检查先决条件的常用方法是将方法一分为二:

public static IEnumerable<int> AllIndexesOf(this string str, string searchText)
{
    if (str == null)
        throw new ArgumentNullException("str");
    if (searchText == null)
        throw new ArgumentNullException("searchText");

    return AllIndexesOfCore(str, searchText);
}

private static IEnumerable<int> AllIndexesOfCore(string str, string searchText)
{
    for (int index = 0; ; index += searchText.Length)
    {
        index = str.IndexOf(searchText, index);
        if (index == -1)
            break;
        yield return index;
    }
}

之所以可行，是因为第一个方法的行为与您预期的一样(立即执行)，并将返回由第二个方法实现的状态机。

请注意，您还应该检查 str 参数是否为 null，因为扩展方法可以在 null 上调用> 值，因为它们只是语法糖。

如果您对编译器对您的代码做了什么感到好奇，这是您的方法，使用显示编译器生成的代码选项使用 dotPeek 反编译。

public static IEnumerable<int> AllIndexesOf(this string str, string searchText)
{
  Test.<AllIndexesOf>d__0 allIndexesOfD0 = new Test.<AllIndexesOf>d__0(-2);
  allIndexesOfD0.<>3__str = str;
  allIndexesOfD0.<>3__searchText = searchText;
  return (IEnumerable<int>) allIndexesOfD0;
}

[CompilerGenerated]
private sealed class <AllIndexesOf>d__0 : IEnumerable<int>, IEnumerable, IEnumerator<int>, IEnumerator, IDisposable
{
  private int <>2__current;
  private int <>1__state;
  private int <>l__initialThreadId;
  public string str;
  public string <>3__str;
  public string searchText;
  public string <>3__searchText;
  public int <index>5__1;

  int IEnumerator<int>.Current
  {
    [DebuggerHidden] get
    {
      return this.<>2__current;
    }
  }

  object IEnumerator.Current
  {
    [DebuggerHidden] get
    {
      return (object) this.<>2__current;
    }
  }

  [DebuggerHidden]
  public <AllIndexesOf>d__0(int <>1__state)
  {
    base..ctor();
    this.<>1__state = param0;
    this.<>l__initialThreadId = Environment.CurrentManagedThreadId;
  }

  [DebuggerHidden]
  IEnumerator<int> IEnumerable<int>.GetEnumerator()
  {
    Test.<AllIndexesOf>d__0 allIndexesOfD0;
    if (Environment.CurrentManagedThreadId == this.<>l__initialThreadId && this.<>1__state == -2)
    {
      this.<>1__state = 0;
      allIndexesOfD0 = this;
    }
    else
      allIndexesOfD0 = new Test.<AllIndexesOf>d__0(0);
    allIndexesOfD0.str = this.<>3__str;
    allIndexesOfD0.searchText = this.<>3__searchText;
    return (IEnumerator<int>) allIndexesOfD0;
  }

  [DebuggerHidden]
  IEnumerator IEnumerable.GetEnumerator()
  {
    return (IEnumerator) this.System.Collections.Generic.IEnumerable<System.Int32>.GetEnumerator();
  }

  bool IEnumerator.MoveNext()
  {
    switch (this.<>1__state)
    {
      case 0:
        this.<>1__state = -1;
        if (this.searchText == null)
          throw new ArgumentNullException("searchText");
        this.<index>5__1 = 0;
        break;
      case 1:
        this.<>1__state = -1;
        this.<index>5__1 += this.searchText.Length;
        break;
      default:
        return false;
    }
    this.<index>5__1 = this.str.IndexOf(this.searchText, this.<index>5__1);
    if (this.<index>5__1 != -1)
    {
      this.<>2__current = this.<index>5__1;
      this.<>1__state = 1;
      return true;
    }
    goto default;
  }

  [DebuggerHidden]
  void IEnumerator.Reset()
  {
    throw new NotSupportedException();
  }

  void IDisposable.Dispose()
  {
  }
}

这是无效的 C# 代码，因为允许编译器执行语言不允许但在 IL 中合法的操作 - 例如，以无法避免名称冲突的方式命名变量。

但是如您所见，AllIndexesOf 仅构造并返回一个对象，其构造函数仅初始化一些状态。 GetEnumerator 只复制对象。真正的工作在您开始枚举时完成(通过调用 MoveNext 方法)。

关于c# - 为什么这个字符串扩展方法没有抛出异常？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/30176121/