C# 索引器的意义或好处是什么？

Question

阅读一些代码并偶然发现了这个我以前从未见过的片段：

public SomeClass {
  public someInterface this[String strParameter] {
    get {
      return SomeInternalMethod(strParameter);
    }
  }
}

它看起来像这样调用：

SomeClass _someClass = new SomeClass();
SomeInterface returnedValue = _someClass["someString"];

我感兴趣的是这个函数在哪里合适或者以这种风格编写的意图是什么。例如，为什么这比简单地调用函数更可取？

Answer 1

请参阅语言规范第 10.9 节，其中指出：

索引器 是一个成员，它使对象能够像数组一样被索引。

索引器和属性在概念上非常相似，但在以下方面有所不同：

• 属性由其名称标识，而索引器由其签名标识。
• 属性是通过简单名称（第 7.5.2 节）或成员访问（第 7.5.4 节）来访问的，而索引器元素是通过元素访问（第 7.5.6.2 节）来访问的。
• 属性可以是静态成员，而索引器始终是实例成员。
• 属性的 get 访问器对应于没有参数的方法，而索引器的 get 访问器对应于与索引器具有相同形式参数列表的方法。
• 属性的集合访问器对应于具有单个名为 value 的参数的方法，而索引器的集合访问器对应于具有与索引器相同的形式参数列表以及一个名为 value 的附加参数的方法。
• 对于索引器访问器来说，声明与索引器参数同名的局部变量是一个编译时错误。
• 在重写属性声明中，使用语法 base.P 访问继承的属性，其中 P 是属性名称。在重写索引器声明中，使用语法 base[E] 访问继承的索引器，其中 E 是逗号分隔的表达式列表。

Answer 2

似乎很多答案都集中在索引器是什么，而不是为什么要使用索引器。

就我而言，这是使用索引器的动机：

您正在开发一个具有某种集合的类，但您希望该类向用户（消费者）显示类）就好像它是一个集合。

我能想到的最好的例子是 ADO.NET 中的 DataRow 类。如果您想获取 DataRow 的第五个单元格的值，可以使用 DataRow.Item[4] 或 DataRow[4]。后一种形式是一种方便且合乎逻辑的快捷方式，它很好地展示了您想要使用索引器的原因。对于用户来说，DataRow 可以被认为只是单元格的集合（尽管它实际上不止于此），因此能够直接获取和设置单元格值是有意义的，而无需必须记住，您实际上正在获取/设置一个 Item。

希望有帮助。

Answer 3

在许多情况下，“索引”语法很有意义。如果 SomeClass 代表某种集合，则它特别有用。

Answer 4

正如您在问题中提到的那样，它允许您进行关联数组查找（又名“字典样式”）。

这就是重点。有些人喜欢这样，特别是来自内置它的语言的人，例如 Python 或 PHP

Answer 5

“this”关键字是

来自 http://msdn.microsoft.com 的 索引器/en-us/library/6x16t2tx.aspx

“索引器允许像数组一样对类或结构的实例进行索引。索引器类似于属性，只是它们的访问器采用参数。”

Answer 6

您之前可能已经偶然发现了类似的东西：

var myList = new List<string>();
myList.Add("One");
myList.Add("Two");
myList.Add("Three");

for(int i = 0; i < myList.Count; i++) {
    string s = myList[i];
}

索引器是实现集合的对象的“主键”。这只是编写 .GetValue(index) 这样的函数的一种简写方式 - 语法糖，如果你愿意的话。但这也表明了意图。

Answer 7

它是索引运算符[]的实现。

Answer 8

这是操作员过载。如果您正在编写一个集合类，例如使用数组表示法访问它是有意义的，例如集合[someIndex]，则很有用。

您当然可以编写一个等效的 collection.GetElement(someIndex) 函数，但这是一个样式/可读性的问题。

Answer 9

那么您可以在键值对类中使用此方法。

我不确定 c# 中的类似类是什么，但在 c++ STL 中，有一个映射类，您可以在其中使用 SomeObject["key"] 调用该方法，它将返回“值”与该键相关联。

Answer 10

这就是所谓的索引器，它们允许您使用 List<>、ArrayList、Dictionary<> 等。以及使用数组语法的所有其他集合。

它只是语法糖，但如果使用得当，它会提供一定的可读性。

Answer 11

在我看来，这只是语法上的便利。
你会在哪里不使用它：

public SomeClass {
  private int[] nums;
  public GetVal this[int ind] {
    get {
      return nums[ind]; // this is pointless since array is already indexed
    }
  }
}

你会在哪里受益：

public Matrix {
  private Dictionary<string, double> matrixData; // Matrix indecies, value
  public double this[int row, int col] {
    get {
      return matrixData[string.Format("{0},{1}", row, col)];
    }
  }
}

如你所见，由于某种原因，你的数据是一个用字符串键索引的字典，你希望使用两个整数不定数来调用它并且仍然不想更改您的数据类型：

Matrix m = new Matrix();
...
Console.WriteLine( m[1,2] );