C#“生成器”方法

Question

我来自 Python 世界，正在尝试在 C# 中创建一个“生成器”方法。我正在以特定缓冲区大小的块解析文件，并且只想一次读取和存储下一个块并在foreach 循环中生成它。到目前为止，这是我所拥有的（简化的概念证明）：

class Page
{
    public uint StartOffset { get; set; }
    private uint currentOffset = 0;

    public Page(MyClass c, uint pageNumber)
    {
        uint StartOffset = pageNumber * c.myPageSize;

        if (StartOffset < c.myLength)
            currentOffset = StartOffset;
        else
            throw new ArgumentOutOfRangeException("Page offset exceeds end of file");

        while (currentOffset < c.myLength && currentOffset < (StartOffset + c.myPageSize))
            // read data from page and populate members (not shown for MWE purposes)
            . . .
    }
}

class MyClass
{
    public uint myLength { get; set; }
    public uint myPageSize { get; set; }

    public IEnumerator<Page> GetEnumerator()
    {
        for (uint i = 1; i < this.myLength; i++)
        {
            // start count at 1 to skip first page
            Page p = new Page(this, i);
            try
            {
                yield return p;
            }
            catch (ArgumentOutOfRangeException)
            {
                // end of available pages, how to signal calling foreach loop?
            }
        }
    }
}

我知道这并不完美，因为它是一个最低限度的工作示例（我不允许公开设置其中的许多属性，但为了保持简单，我不想键入私有成员和属性）。

但是，我的主要问题是如何让使用 foreach 语句遍历 MyClass 的调用者知道没有更多的项目可以循环了？有没有我抛出的异常表明没有剩余元素？

Answer 1

如 cmets 中所述，您应该使用 IEnumerable<T> 而不是 IEnumerator<T>。枚举器是用于枚举某物的技术对象。那个东西——在很多情况下——是可枚举的。

C# 具有处理枚举的特殊能力。最突出的是，您可以将foreach 循环与可枚举（但不是枚举器；即使循环实际上使用可枚举的枚举器）一起使用。此外，可枚举允许您使用LINQ，这使其更易于使用。

所以你应该像这样改变你的班级：

class MyClass
{
    public uint myLength { get; set; }
    public uint myPageSize { get; set; }

    # note the modified signature
    public IEnumerable<Page> GetPages()
    {
        for (uint i = 1; i < this.myLength; i++)
        {
            Page p;
            try
            {
                p = new Page(this, i);
            }
            catch (ArgumentOutOfRangeException)
            {
                yield break;
            }
            yield return p;
        }
    }
}

最后，这允许您像这样使用它：

var obj = new MyClass();

foreach (var page in obj.GetPages())
{
    // do whatever
}

// or even using LINQ
var pageOffsets = obj.GetPages().Select(p => p.currentOffset).ToList();

当然，您还应该将方法的名称更改为有意义的东西。如果您要返回页面，GetPages 可能是朝着正确方向迈出的良好第一步。 GetEnumerator 这个名称是为实现 IEnumerable 的类型保留的，其中 GetEnumerator 方法应该返回对象所代表的集合的枚举数。

Answer 2

两种方法是让代码执行到 GetEnumerator 函数的末尾或在代码中放入 yield break;，这与在返回 void 的函数中的 return; 行为相同.

从调用者的角度来看，从GetEnumerator() 返回的枚举器将开始为MoveNext() 返回false，这就是他们告诉枚举器完成的方式。

---

要修复您的“无法在带有 catch 子句的 try 块的主体内产生值”，您将 try/catch 放在代码的错误部分，执行将被抛出 new not yield return。你的代码应该是这样的

public IEnumerator<Page> GetEnumerator()
{
    for (uint i = 1; i < this.myLength; i++)
    {
        // start count at 1 to skip first page
        Page p;
        try
        {
            p = new Page(this, i);
        }
        catch (ArgumentOutOfRangeException)
        {
            yield break;
        }
        yield return p;
    }
}

Answer 3

使用yield break; 语句结束您的迭代器方法正在生成的序列。