什么是 IndexOutOfRangeException / ArgumentOutOfRangeException 以及如何修复它？

Question

我有一些代码，当它执行时，它会抛出一个 IndexOutOfRangeException ，说：

索引超出了数组的范围。

这是什么意思？我能做什么？

根据所使用的类，它也可以是ArgumentOutOfRangeException

mscorlib.dll 中发生“System.ArgumentOutOfRangeException”类型的异常，但未在用户代码中处理其他信息：索引超出范围。必须为非负数且小于集合的大小。

Answer 1

它是什么？

此异常意味着您尝试使用无效索引通过索引访问集合项。当索引低于集合的下限或大于或等于其包含的元素数时，索引无效。

何时抛出

给定一个声明为的数组：

byte[] array = new byte[4];

您可以从 0 到 3 访问此数组，超出此范围的值将导致抛出 IndexOutOfRangeException。创建和访问数组时请记住这一点。

数组长度
在 C# 中，数组通常是从 0 开始的。这意味着第一个元素的索引为 0，最后一个元素的索引为 Length - 1（其中 Length 是数组中的项目总数），因此此代码不起作用：

array[array.Length] = 0;

此外请注意，如果您有一个多维数组，则不能对两个维度都使用 Array.Length，您必须使用 Array.GetLength()：

int[,] data = new int[10, 5];
for (int i=0; i < data.GetLength(0); ++i) {
    for (int j=0; j < data.GetLength(1); ++j) {
        data[i, j] = 1;
    }
}

不包含上限
在下面的示例中，我们创建一个 Color 的原始二维数组。每一项代表一个像素，索引从 (0, 0) 到 (imageWidth - 1, imageHeight - 1)。

Color[,] pixels = new Color[imageWidth, imageHeight];
for (int x = 0; x <= imageWidth; ++x) {
    for (int y = 0; y <= imageHeight; ++y) {
        pixels[x, y] = backgroundColor;
    }
}

然后，此代码将失败，因为数组是从 0 开始的，并且图像中的最后一个（右下角）像素是 pixels[imageWidth - 1, imageHeight - 1]：

pixels[imageWidth, imageHeight] = Color.Black;

在另一种情况下，您可能会得到 此代码的 ArgumentOutOfRangeException（例如，如果您在 Bitmap 类上使用 GetPixel 方法）。

数组不会增长
数组速度很快。与其他所有集合相比，线性搜索速度非常快。这是因为项目在内存中是连续的，因此可以计算内存地址（增量只是加法）。无需遵循节点列表，简单的数学运算！您付出的代价是有限制的：它们不能增长，如果您需要更多元素，您需要重新分配该数组（如果必须将旧项目复制到新块，这可能需要相对较长的时间）。您可以使用 Array.Resize() 调整它们的大小，此示例向现有数组添加一个新条目：

Array.Resize(ref array, array.Length + 1);

不要忘记有效索引是从 0 到 <代码>长度 - 1。如果您只是尝试在Length处分配一个项目，您将得到IndexOutOfRangeException（如果您认为它们可能会使用类似于Insert的语法增加，那么这种行为可能会让您感到困惑 其他集合的方法）。

具有自定义下界的特殊数组
数组中的第一项始终索引为 0。这并不总是正确的，因为您可以创建具有自定义下限的数组：

var array = Array.CreateInstance(typeof(byte), new int[] { 4 }, new int[] { 1 });

在该示例中，数组索引的有效范围是 1 到 4。当然，上限不能更改。

错误的论点
如果您使用未经验证的参数（来自用户输入或函数用户）访问数组，您可能会收到此错误：

private static string[] RomanNumbers =
    new string[] { "I", "II", "III", "IV", "V" };

public static string Romanize(int number)
{
    return RomanNumbers[number];
}

意外结果
抛出此异常也可能是由于另一个原因：按照惯例，许多搜索函数将返回 -1（nullables 已随 .NET 2.0 引入，无论如何，它也是多年来使用的众所周知的约定）如果他们没有找到任何东西。假设您有一个与字符串相当的对象数组。您可能会考虑编写以下代码：

// Items comparable with a string
Console.WriteLine("First item equals to 'Debug' is '{0}'.",
    myArray[Array.IndexOf(myArray, "Debug")]);

// Arbitrary objects
Console.WriteLine("First item equals to 'Debug' is '{0}'.",
    myArray[Array.FindIndex(myArray, x => x.Type == "Debug")]);

如果 myArray 中没有项目满足搜索条件，则会失败，因为 Array.IndexOf() 将返回 -1，然后数组访问将抛出异常。

下一个示例是一个简单的示例，用于计算给定数字集的出现次数（知道最大数字并返回一个数组，其中索引 0 处的项目代表数字 0，索引 1 处的项目代表数字 1 等等）：

static int[] CountOccurences(int maximum, IEnumerable<int> numbers) {
    int[] result = new int[maximum + 1]; // Includes 0

    foreach (int number in numbers)
        ++result[number];

    return result;
}

当然，这是一个漂亮的例子糟糕的实现，但我想展示的是，对于负数和高于最大值的数字，它会失败。

如何应用于列表< ;T>？

与数组相同 - 有效索引范围 - 0（List 的索引始终以 0 开头）到list.Count - 访问此范围之外的元素将导致异常。

请注意，对于数组使用 IndexOutOfRangeException 的相同情况，List 会抛出 ArgumentOutOfRangeException。

与数组不同，List 开头为空 - 因此尝试访问刚刚创建的列表中的项目会导致此异常。

var list = new List<int>();

常见情况是使用索引填充列表（类似于 Dictionary）会导致异常：

list[0] = 42; // exception
list.Add(42); // correct

IDataReader 和 Columns
想象一下，您尝试使用以下代码从数据库读取数据：

using (var connection = CreateConnection()) {
    using (var command = connection.CreateCommand()) {
        command.CommandText = "SELECT MyColumn1, MyColumn2 FROM MyTable";

        using (var reader = command.ExecuteReader()) {
            while (reader.Read()) {
                ProcessData(reader.GetString(2)); // Throws!
            }
        }
    }
}

GetString() 将抛出 IndexOutOfRangeException 因为您的数据集只有两列，但您试图从第三个获取一个值（索引始终从0开始）。

请注意，大多数 IDataReader 实现（SqlDataReader、OleDbDataReader 等）都具有此行为。

如果您使用索引器运算符的 IDataReader 重载（该运算符采用列名并传递无效的列名），您也会遇到相同的异常。
例如，假设您检索了名为 Column1 的列，但随后尝试检索该字段的值，则会

 var data = dr["Colum1"];  // Missing the n in Column1.

发生这种情况，因为索引器运算符是在尝试检索 Colum1< 的索引时实现的。 /em> 不存在的字段。当 GetOrdinal 方法的内部帮助程序代码返回 -1 作为“Colum1”的索引时，该方法将引发此异常。

其他
抛出此异常时还有另一种（已记录）情况：如果在 DataView 中，提供给 DataViewSort 属性的数据列名称无效。

如何避免

在本例中，为简单起见，让我假设数组始终是单维且从 0 开始的。如果您想要严格（或者您正在开发库），则可能需要将 0 替换为 GetLowerBound(0) 和 .Length > 与 GetUpperBound(0) （当然，如果您有 System.Array 类型的参数，则它不适用于 T[] ）。请注意，在这种情况下，上限是包含在内的，那么此代码：

for (int i=0; i < array.Length; ++i) { }

应该像这样重写：

for (int i=array.GetLowerBound(0); i <= array.GetUpperBound(0); ++i) { }

请注意，这是不允许的（它将抛出 InvalidCastException），这就是为什么如果您的参数是 < code>T[] 您对自定义下界数组是安全的：

void foo<T>(T[] array) { }

void test() {
    // This will throw InvalidCastException, cannot convert Int32[] to Int32[*]
    foo((int)Array.CreateInstance(typeof(int), new int[] { 1 }, new int[] { 1 }));
}

验证参数
如果索引来自参数，您应该始终验证它们（抛出适当的 ArgumentException 或 ArgumentOutOfRangeException）。在下一个示例中，错误的参数可能会导致 IndexOutOfRangeException，此函数的用户可能会期望这种情况，因为他们传递的是数组，但并不总是那么明显。我建议始终验证公共函数的参数：

static void SetRange<T>(T[] array, int from, int length, Func<i, T> function)
{
    if (from < 0 || from>= array.Length)
        throw new ArgumentOutOfRangeException("from");

    if (length < 0)
        throw new ArgumentOutOfRangeException("length");

    if (from + length > array.Length)
        throw new ArgumentException("...");

    for (int i=from; i < from + length; ++i)
        array[i] = function(i);
}

如果函数是私有的，您可以简单地将 if 逻辑替换为 Debug.Assert()：

Debug.Assert(from >= 0 && from < array.Length);

检查对象状态< /strong>
数组索引可能不直接来自参数。它可能是对象状态的一部分。一般来说，验证对象状态始终是一个好习惯（如果需要，可以单独验证对象状态，也可以使用函数参数）。您可以使用 Debug.Assert()，抛出适当的异常（对问题更具描述性）或像此示例中那样处理：

class Table {
    public int SelectedIndex { get; set; }
    public Row[] Rows { get; set; }

    public Row SelectedRow {
        get {
            if (Rows == null)
                throw new InvalidOperationException("...");

            // No or wrong selection, here we just return null for
            // this case (it may be the reason we use this property
            // instead of direct access)
            if (SelectedIndex < 0 || SelectedIndex >= Rows.Length)
                return null;

            return Rows[SelectedIndex];
        }
}

验证返回值
在前面的示例之一中，我们直接使用了 Array.IndexOf() 返回值。如果我们知道它可能会失败，那么最好处理这种情况：

int index = myArray[Array.IndexOf(myArray, "Debug");
if (index != -1) { } else { }

如何调试

在我看来，大多数关于此错误的问题都可以简单地避免。您花在编写正确问题（带有一个小工作示例和一个小解释）上的时间很容易比调试代码所需的时间多得多。首先，阅读 Eric Lippert 的关于调试小型程序的博客文章程序，我不会在这里重复他的话，但这绝对是必读。

您有源代码，您有带有堆栈跟踪的异常消息。转到那里，选择正确的行号，您会看到：

array[index] = newValue;

您发现错误，检查 index 如何增加。对吗？检查数组是如何分配的，与index如何增加一致？是否符合您的规格？如果您对所有这些问题的回答都是是，那么您会在 StackOverflow 上找到很好的帮助，但请先自行检查。您将节省自己的时间！

一个好的起点是始终使用断言并验证输入。您甚至可能想使用代码契约。当出现问题并且您无法通过快速查看代码来弄清楚发生了什么时，您必须求助于老朋友：调试器。只需在 Visual Studio（或您最喜欢的 IDE）内调试运行您的应用程序，您将准确地看到哪一行抛出此异常、涉及哪个数组以及您尝试使用哪个索引。确实，99% 的情况下你都会在几分钟内自己解决这个问题。

如果这种情况发生在生产中，那么您最好在受控代码中添加断言，可能我们不会在您的代码中看到您自己看不到的东西（但您总是可以打赌）。

故事的 VB.NET 方面

我们在 C# 答案中所说的所有内容都适用于 VB.NET，但有明显的语法差异，但在处理 VB.NET 数组时有一个需要考虑的重要点。

在 VB.NET 中，声明数组时设置数组的最大有效索引值。它不是我们要存储在数组中的元素的数量。

' declares an array with space for 5 integer 
' 4 is the maximum valid index starting from 0 to 4
Dim myArray(4) as Integer

因此，此循环将用 5 个整数填充数组，而不会导致任何 IndexOutOfRangeException

For i As Integer = 0 To 4
    myArray(i) = i
Next

VB.NET 规则

此异常意味着您尝试使用无效索引按索引访问集合项。当索引低于集合的下限或大于 等于其包含的元素数时，索引无效。 数组声明中定义的允许的最大索引

Answer 2

关于什么是索引越界异常的简单解释：

假设有一列火车在那里，它的车厢是 D1、D2、D3。
一名乘客上车，他持有D4的车票。
现在会发生什么。乘客想要进入一个不存在的车厢，显然会出现问题。

同样的情况：每当我们尝试访问数组列表等时，我们只能访问数组中现有的索引。 array[0] 和 array[1] 已存在。如果我们尝试访问array[3]，它实际上并不存在，因此会出现索引越界异常。

Answer 3

为了容易理解这个问题，假设我们编写了这段代码：

static void Main(string[] args)
{
    string[] test = new string[3];
    test[0]= "hello1";
    test[1]= "hello2";
    test[2]= "hello3";

    for (int i = 0; i <= 3; i++)
    {
        Console.WriteLine(test[i].ToString());
    }
}

结果将是：

hello1
hello2
hello3

Unhandled Exception: System.IndexOutOfRangeException: Index was outside the bounds of the array.

数组的大小为 3（索引 0、1 和 2），但 for 循环循环 4 次（0、1、2 和 3）。
因此，当它尝试使用 (3) 访问边界之外时，它会抛出异常。

Answer 4

与许多其他异常类型相比，从非常长的完整接受答案的角度来看，有一个重要的点需要说明 IndexOutOfRangeException ，那就是：

通常存在可能难以控制的复杂程序状态代码中的特定点，例如数据库连接断开，因此无法检索输入的数据等...此类问题通常会导致某种异常，该异常必须上升到更高级别，因为它发生的位置没有那时的处理方式。

IndexOutOfRangeException 通常有所不同，因为在大多数情况下，在引发异常的位置进行检查非常简单。一般来说，这种异常是由一些代码抛出的，这些代码可以很容易地在问题发生的地方处理问题——只需检查数组的实际长度。您不想通过更高层处理此异常来“修复”此问题 - 而是通过确保它不会在第一个实例中抛出 - 在大多数情况下，通过检查数组长度很容易做到。

另一种说法是，由于真正缺乏对输入或程序状态的控制，可能会出现其他异常，但 IndexOutOfRangeException 通常只是飞行员（程序员）错误。

Answer 5

这两种异常在各种编程语言中都很常见，正如其他人所说，这是当您访问索引大于数组大小的元素时。例如：

var array = [1,2,3];
/* var lastElement = array[3] this will throw an exception, because indices 
start from zero, length of the array is 3, but its last index is 2. */ 

这背后的主要原因是编译器通常不会检查这些东西，因此它们只会在运行时表达自己。

与此类似：
为什么不呢现代编译器会捕获对数组进行越界访问的尝试吗？

Answer 6

对于数组和 IEnumerable 等所有内容，我使用 ElementAt 和 ElementAtOrDefault LINQ 扩展方法来防止超出范围异常。但请考虑 ElementAtOrDefault 方法返回对象类型默认值，并且在可为 null 的类型中，如果数组中不存在给定的任何值的索引，则返回 null 作为结果。我的意思是，如果您尝试获取索引 -1 处的元素，ElementAtOrDefault 返回默认值，对于可为 null 的类型你会得到null。
示例：

using System.Linq;
...
var arTest = new int[] {0,1,2,3};
var elmAt0 = arTest.ElementAtOrDefault(0); //Gives 0
var elmAt3 = arTest.ElementAtOrDefault(3); //Gives 3
var elmAt6 = arTest.ElementAtOrDefault(6); //Gives 0:Default int

并且...