120

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

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

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.WriteLinenull-comparisonif块时，控制台上没有显示任何内容，并且catch我添加的任何块都没有捕获到异常。此外，使用string.IsNullOrEmpty代替== null也有同样的问题。

为什么这个所谓的简单比较失败了？

4

3 回答 3

160

您正在使用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 使用Show Compiler-generated Code选项进行反编译。

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 中是合法的 - 例如以您无法避免名称冲突的方式命名变量。

但是正如你所看到的，AllIndexesOfonly 构造并返回一个对象，其构造函数只初始化一些状态。GetEnumerator只复制对象。当您开始枚举（通过调用MoveNext方法）时，真正的工作就完成了。

于 2015-05-11T19:38:27.533 回答
34

你有一个迭代器块。MoveNext该方法中的任何代码都不会在对返回的迭代器的调用之外运行。调用该方法不会记录但会创建状态机，并且永远不会失败（除了内存不足错误、堆栈溢出或线程中止异常等极端情况）。

当您实际尝试迭代序列时，您将获得异常。

这就是为什么 LINQ 方法实际上需要两个方法来获得所需的错误处理语义。他们有一个私有方法，它是一个迭代器块，然后是一个非迭代器块方法，它只做参数验证（以便它可以急切地完成，而不是被延迟），同时仍然延迟所有其他功能。

所以这是一般模式：

public static IEnumerable<T> Foo<T>(
    this IEnumerable<T> souce, Func<T, bool> anotherArgument)
{
    //note, not an iterator block
    if(anotherArgument == null)
    {
        //TODO make a fuss
    }
    return FooImpl(source, anotherArgument);
}

private static IEnumerable<T> FooImpl<T>(
    IEnumerable<T> souce, Func<T, bool> anotherArgument)
{
    //TODO actual implementation as an iterator block
    yield break;
}
于 2015-05-11T19:36:40.860 回答
0

正如其他人所说，枚举器直到它们开始被枚举（即IEnumerable.GetNext方法被调用）时才会被评估。因此这

List<int> indexes = "a.b.c.d.e".AllIndexesOf(null).ToList<int>();

在您开始枚举之前不会被评估，即

foreach(int index in indexes)
{
    // ArgumentNullException
}
于 2015-06-01T14:07:36.667 回答