学懂C#编程：C# 索引器（Indexer）的概念及用法

时间：2024-07-10 16:05:02

C#中的索引器（Indexer）是一种特殊的成员，它允许类或结构的实例像数组那样通过索引来访问其内部的数据。索引器提供了一种灵活的方式来暴露集合或数组类型的内部数据，使得客户端代码可以使用类似于数组下标的语法来访问类的成员，而不需要知道或关心底层的数据结构。

概念

索引器通过定义一个或多个索引参数（通常是整数，但也可是其他类型）来实现，这些参数在索引器的方法体中被用来定位实际要访问的数据。索引器的声明类似于属性，但它使用关键字 this 来指示索引器，并在方括号中定义索引参数。

用法

索引器的基本语法如下：

public ElementType this[ParameterType parameterName]
{
    get
    {
        // 访问和返回数据的逻辑
    }
    set
    {
        // 设置数据的逻辑
    }
}
  • ElementType 是索引器返回的数据类型。
  • ParameterType 是索引参数的类型，可以是任何类型，不仅仅是整数。
  • parameterName 是索引参数的名称。

示例

假设有一个表示图书集合的类 BookCollection，想要通过书的索引（例如，出版顺序编号）来访问其中的书籍，可以这样定义索引器：

public class BookCollection
{
    private List<Book> books = new List<Book>();

    public Book this[int index]
    {
        get
        {
            // 检查索引是否有效
            if (index >= 0 && index < books.Count)
            {
                return books[index];
            }
            else
            {
                throw new ArgumentOutOfRangeException(nameof(index), "索引超出范围");
            }
        }
        set
        {
            // 设置对应索引位置的书籍
            if (index >= 0 && index < books.Count)
            {
                books[index] = value;
            }
            else
            {
                throw new ArgumentOutOfRangeException(nameof(index), "索引超出范围");
            }
        }
    }

    // 其他方法，如AddBook, RemoveBook等...
}

public class Book
{
    public string Title { get; set; }
    public string Author { get; set; }
    // 其他属性...
}

在这个例子中，BookCollection 类通过定义一个索引器，允许用户像操作数组一样，通过索引访问和设置书籍。例如：

BookCollection collection = new BookCollection();
collection.Add(new Book { Title = "C# 入门", Author = "张三" });
collection[0].Title = "C# 编程指南"; // 使用索引器修改第一本书的标题

注意事项

  • 索引器不是必须的，只有当类或结构需要提供类似数组的访问方式时才应考虑使用。
  • 索引器可以有多个参数，但通常不超过两个，以避免使用上的复杂性。
  • 索引器的 get 访问器用于获取数据，set 访问器用于设置数据。可以根据需要选择性地实现它们。
  • 确保对索引参数进行有效性检查，以避免数组越界等错误。

相关文章