Блог

У меня есть некоторый код, и когда он выполняется , он выдает IndexOutOfRangeException сообщение,

Индекс находился за пределами массива.

Что это значит и что я могу с этим поделать?

В зависимости от используемых классов это также может быть ArgumentOutOfRangeException

Исключение типа » Система.Исключение ArgumentOutOfRangeException’ произошло в mscorlib.dll но не была обработана в пользовательском коде Дополнительная информация: индекс был вне диапазона. Должно быть неотрицательным и меньше размера коллекции.

что это?

Это исключение означает, что вы пытаетесь получить доступ к элементу коллекции по индексу, используя недопустимый индекс. Индекс недействителен, если он ниже нижней границы коллекции или больше или равен количеству содержащихся в нем элементов.

Когда Его Бросают

Учитывая массив, объявленный как:

 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;
    }
}
 

This code will then fail because array is 0-based and last (bottom-right) pixel in the image is pixels[imageWidth - 1, imageHeight - 1] :

 pixels[imageWidth, imageHeight] = Color.Black;
 

In another scenario you may get ArgumentOutOfRangeException for this code (for example if you’re using GetPixel method on a Bitmap class).

Arrays Do Not Grow
An array is fast. Very fast in linear search compared to every other collection. It is because items are contiguous in memory so memory address can be calculated (and increment is just an addition). No need to follow a node list, simple math! You pay this with a limitation: they can’t grow, if you need more elements you need to reallocate that array (this may take a relatively long time if old items must be copied to a new block). You resize them with Array.Resize<T>() , this example adds a new entry to an existing array:

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

Don’t forget that valid indices are from 0 to Length - 1 . If you simply try to assign an item at Length you’ll get IndexOutOfRangeException (this behavior may confuse you if you think they may increase with a syntax similar to Insert method of other collections).

Special Arrays With Custom Lower Bound
First item in arrays has always index 0. This is not always true because you can create an array with a custom lower bound:

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

In that example, array indices are valid from 1 to 4. Of course, upper bound cannot be changed.

Wrong Arguments
If you access an array using unvalidated arguments (from user input or from function user) you may get this error:

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

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

Unexpected Results
This exception may be thrown for another reason too: by convention, many search functions will return -1 (nullables has been introduced with .NET 2.0 and anyway it’s also a well-known convention in use from many years) if they didn’t find anything. Let’s imagine you have an array of objects comparable with a string. You may think to write this code:

 // 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")]);
 

This will fail if no items in myArray will satisfy search condition because Array.IndexOf() will return -1 and then array access will throw.

Next example is a naive example to calculate occurrences of a given set of numbers (knowing maximum number and returning an array where item at index 0 represents number 0, items at index 1 represents number 1 and so on):

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

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

    return resu<
}
 

Конечно, это довольно ужасная реализация, но я хочу показать, что она не сработает для отрицательных чисел и чисел выше maximum .

Как это относится к List<T> ?

Те же случаи, что и массив — диапазон допустимых индексов — 0 ( List индексы всегда начинаются с 0) для list.Count доступа к элементам за пределами этого диапазона, вызовут исключение.

Обратите внимание, что List<T> броски ArgumentOutOfRangeException выполняются для тех же случаев, когда используются массивы IndexOutOfRangeException .

В отличие от массивов, List<T> запускается пустым — поэтому попытка доступа к элементам только что созданного списка приводит к этому исключению.

 var list = new List<int>();
 

Распространенным случаем является заполнение списка индексированием (аналогично Dictionary<int, T> ), что приведет к исключению:

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

IDataReader и столбцы
Представьте, что вы пытаетесь прочитать данные из базы данных с помощью этого кода:

 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 потому что ваш набор данных содержит только два столбца, но вы пытаетесь получить значение из 3-го (индексы всегда основаны на 0).

Пожалуйста, обратите внимание, что это поведение является общим для большинства IDataReader реализаций ( SqlDataReader OleDbDataReader и так далее).

Вы также можете получить такое же исключение, если используете перегрузку IDataReader оператора индексатора, который принимает имя столбца и передает недопустимое имя столбца.
Предположим, например, что вы получили столбец с именем Column1, но затем пытаетесь получить значение этого поля с помощью

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

Это происходит потому, что оператор индексатора реализован при попытке получить индекс несуществующего поля Colum1. Метод GetOrdinal вызовет это исключение, когда его внутренний вспомогательный код вернет значение -1 в качестве индекса «Colum1».

Прочее
Существует еще один (задокументированный) случай, когда возникает это исключение: если DataView имя столбца данных, указанное в DataViewSort свойстве , недопустимо.

Как избежать

В этом примере позвольте мне для простоты предположить, что массивы всегда одномерны и основаны на 0. Если вы хотите быть строгим (или вы разрабатываете библиотеку), вам, возможно, потребуется заменить 0 на GetLowerBound(0) и .Length с GetUpperBound(0) (конечно, если у вас есть параметры типа System.Arra y, это не применимо T[] ). Пожалуйста, обратите внимание, что в этом случае верхняя граница включена, тогда этот код:

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

Должно быть переписано вот так:

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

Пожалуйста, обратите внимание, что это запрещено (это приведет InvalidCastException к сбою), поэтому, если ваши параметры 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 }));
}
 

Validate Parameters
If index comes from a parameter you should always validate them (throwing appropriate ArgumentException or ArgumentOutOfRangeException ). In the next example, wrong parameters may cause IndexOutOfRangeException , users of this function may expect this because they’re passing an array but it’s not always so obvious. I’d suggest to always validate parameters for public functions:

 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 function is private you may simply replace if logic with Debug.Assert() :

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

Check Object State
Array index may not come directly from a parameter. It may be part of object state. In general is always a good practice to validate object state (by itself and with function parameters, if needed). You can use Debug.Assert() , throw a proper exception (more descriptive about the problem) or handle that like in this example:

 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];
        }
}
 

Validate Return Values
In one of previous examples we directly used Array.IndexOf() return value. If we know it may fail then it’s better to handle that case:

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

How to Debug

In my opinion, most of the questions, here on SO, about this error can be simply avoided. The time you spend to write a proper question (with a small working example and a small explanation) could easily much more than the time you’ll need to debug your code. First of all, read this Eric Lippert’s blog post about debugging of small programs, I won’t repeat his words here but it’s absolutely a must read.

You have source code, you have exception message with a stack trace. Go there, pick right line number and you’ll see:

 array[index] = newValue;
 

You found your error, check how index increases. Is it right? Check how array is allocated, is coherent with how index increases? Is it right according to your specifications? If you answer yes to all these questions, then you’ll find good help here on StackOverflow but please first check for that by yourself. You’ll save your own time!

A good start point is to always use assertions and to validate inputs. You may even want to use code contracts. When something went wrong and you can’t figure out what happens with a quick look at your code then you have to resort to an old friend: debugger. Just run your application in debug inside Visual Studio (or your favorite IDE), you’ll see exactly which line throws this exception, which array is involved and which index you’re trying to use. Really, 99% of the times you’ll solve it by yourself in a few minutes.

Если это произойдет в производстве, то вам лучше добавить утверждения в инкриминируемый код, вероятно, мы не увидим в вашем коде того, чего вы не видите сами (но вы всегда можете поспорить).

В 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 правило

Это исключение означает, что вы пытаетесь получить доступ к элементу коллекции по индексу, используя недопустимый индекс. Индекс недействителен, если он меньше нижней границы коллекции или больше, чем равно количеству содержащихся в нем элементов. максимально допустимый индекс, определенный в объявлении массива

Простое объяснение того, что такое исключение индекса из привязки:

Просто подумайте,что там есть один поезд,его купе D1, D2, D3. Один пассажир пришел, чтобы войти в поезд, и у него есть билет на D4. что теперь будет? пассажир хочет войти в купе, которого не существует, поэтому, очевидно, возникнет проблема.

Тот же сценарий: всякий раз, когда мы пытаемся получить доступ к списку массивов и т. Д. мы можем получить доступ только к существующим индексам в массиве. array[0] и array[1] существуют. Если мы попытаемся получить доступ array[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-loop повторяется 4 раза (0, 1, 2 и 3).
Поэтому, когда он пытается получить доступ за пределы (3), он создает исключение.

В стороне от очень длинного полного принятого ответа следует отметить важный момент по IndexOutOfRangeException сравнению со многими другими типами исключений, а именно:

Часто возникает сложное состояние программы, которое, возможно, трудно контролировать в определенной точке кода, например, соединение с БД отключается, поэтому данные для ввода не могут быть извлечены и т.д… Такого рода проблемы часто приводят к какому-либо Исключению, которое должно всплыть на более высокий уровень, потому что там, где это происходит, в этот момент нет способа справиться с этим.

IndexOutOfRangeException как правило, отличается тем, что в большинстве случаев довольно тривиально проверять наличие в точке, где возникает исключение. Как правило, такого рода исключения генерируются каким — либо кодом, который может очень легко решить проблему в том месте, где она возникает, — просто проверив фактическую длину массива. Вы не хотите «исправлять» это, обрабатывая это исключение выше, но вместо этого гарантируя, что оно не возникнет в первом случае, что в большинстве случаев легко сделать, проверив длину массива.

Другой способ выразить это заключается в том, что другие исключения могут возникать из-за подлинного отсутствия контроля над вводом или состоянием программы, но IndexOutOfRangeException чаще всего это просто ошибка пилота (программиста).