Использование индексаторов (Руководство по программированию в C#)Using Indexers (C# Programming Guide)

Применение индексаторов упрощает работу с синтаксисом, позволяя создавать классы, структуры и интерфейсы, к которым клиентские приложения могут обращаться так же, как к массиву.Indexers are a syntactic convenience that enable you to create a class, struct, or interface that client applications can access just as an array. Индексаторы чаще всего реализуются в типах, предназначенных преимущественно для инкапсуляции внутренней коллекции или массива.Indexers are most frequently implemented in types whose primary purpose is to encapsulate an internal collection or array. Допустим, у вас есть класс TempRecord, представляющий журнал с 10 измерениями температуры по шкале Фаренгейта за 24 часа.For example, suppose you have a class named TempRecord that represents the temperature in Farenheit as recorded at 10 different times during a 24 hour period. В этом классе содержится массив temps типа float, представляющий значения температуры, а также DateTime, содержащий даты соответствующих измерений.The class contains an array named "temps" of type float to represent the temperatures, and a DateTime that represents the date the temperatures were recorded. Реализация индексатора в этом классе позволит клиентам получать доступ к значениям температуры в экземпляре TempRecord, используя синтаксис float temp = tr[4] вместо float temp = tr.temps[4].By implementing an indexer in this class, clients can access the temperatures in a TempRecord instance as float temp = tr[4] instead of as float temp = tr.temps[4]. Это позволяет не только упростить синтаксис клиентских приложений, но и облегчить понимание кода класса и его предназначения другими разработчиками.The indexer notation not only simplifies the syntax for client applications; it also makes the class and its purpose more intuitive for other developers to understand.

Чтобы объявить индексатор для класса или структуры, используйте ключевое слово this, как показано в следующем примере:To declare an indexer on a class or struct, use the this keyword, as in this example:

public int this[int index]    // Indexer declaration  
{  
    // get and set accessors  
}  

ПримечанияRemarks

Тип индексатора и типы его параметров должны иметь по крайней мере такой же уровень доступности, как и сам индексатор.The type of an indexer and the type of its parameters must be at least as accessible as the indexer itself. Дополнительные сведения об уровнях доступа см. в разделе Модификаторы доступа.For more information about accessibility levels, see Access Modifiers.

Дополнительные сведения об использовании индексаторов с интерфейсом см. в разделе Индексаторы интерфейса.For more information about how to use indexers with an interface, see Interface Indexers.

Сигнатура индексатора определяет число и типы его формальных параметров.The signature of an indexer consists of the number and types of its formal parameters. В ней не указываются тип индексатора или имена его формальных параметров.It does not include the indexer type or the names of the formal parameters. Если для одного класса объявляется несколько индексаторов, они должны иметь разные сигнатуры.If you declare more than one indexer in the same class, they must have different signatures.

Значение индексатора не классифицируется как переменная и, соответственно, не может передаваться в качестве параметра ref или out.An indexer value is not classified as a variable; therefore, you cannot pass an indexer value as a ref or out parameter.

Чтобы присвоить индексатору имя, которое можно использовать на других языках, используйте в объявлении атрибут name.To provide the indexer with a name that other languages can use, use a name attribute in the declaration. Пример:For example:

[System.Runtime.CompilerServices.IndexerName("TheItem")]  
public int this [int index]   // Indexer declaration  
{  
}  

Этот индексатор будет иметь имя TheItem.This indexer will have the name TheItem. Без атрибута имени по умолчанию будет использоваться имя Item.Not providing the name attribute would make Item the default name.

Пример 1Example 1

Описание:Description

В следующем примере показано, как объявить частное поле массива temps и индексатор.The following example shows how to declare a private array field, temps, and an indexer. Индексатор обеспечивает прямой доступ к экземпляру tempRecord[i].The indexer enables direct access to the instance tempRecord[i]. Вместо использования индексатора можно объявить массив как элемент public и осуществлять доступ к его элементам напрямую (tempRecord.temps[i]).The alternative to using the indexer is to declare the array as a public member and access its members, tempRecord.temps[i], directly.

Обратите внимание, что при определении прав доступа индексатора, например в инструкции Console.Write, вызывается метод доступа get.Notice that when an indexer's access is evaluated, for example, in a Console.Write statement, the get accessor is invoked. Таким образом, если метод доступа get отсутствует, возникает ошибка времени компиляции.Therefore, if no get accessor exists, a compile-time error occurs.

КодCode

class TempRecord
{
    // Array of temperature values
    private float[] temps = new float[10] { 56.2F, 56.7F, 56.5F, 56.9F, 58.8F, 
                                            61.3F, 65.9F, 62.1F, 59.2F, 57.5F };

    // To enable client code to validate input 
    // when accessing your indexer.
    public int Length
    {
        get { return temps.Length; }
    }
    // Indexer declaration.
    // If index is out of range, the temps array will throw the exception.
    public float this[int index]
    {
        get
        {
            return temps[index];
        }

        set
        {
            temps[index] = value;
        }
    }
}

class MainClass
{
    static void Main()
    {
        TempRecord tempRecord = new TempRecord();
        // Use the indexer's set accessor
        tempRecord[3] = 58.3F;
        tempRecord[5] = 60.1F;

        // Use the indexer's get accessor
        for (int i = 0; i < 10; i++)
        {
            System.Console.WriteLine("Element #{0} = {1}", i, tempRecord[i]);
        }

        // Keep the console window open in debug mode.
        System.Console.WriteLine("Press any key to exit.");
        System.Console.ReadKey();

    }
}
/* Output:
        Element #0 = 56.2
        Element #1 = 56.7
        Element #2 = 56.5
        Element #3 = 58.3
        Element #4 = 58.8
        Element #5 = 60.1
        Element #6 = 65.9
        Element #7 = 62.1
        Element #8 = 59.2
        Element #9 = 57.5
    */

Индексирование с использованием других значенийIndexing Using Other Values

В C# тип индекса не ограничивается целочисленными значениями.C# does not limit the index type to integer. Например, в качестве индексатора могут использоваться строки.For example, it may be useful to use a string with an indexer. Такой индексатор можно реализовать путем поиска строки в коллекции с возвратом соответствующего значения.Such an indexer might be implemented by searching for the string in the collection, and returning the appropriate value. Поскольку методы доступа можно перегружать, строковые и целочисленные версии могут сосуществовать.As accessors can be overloaded, the string and integer versions can co-exist.

Пример 2Example 2

Описание:Description

В этом примере объявляется класс, в котором хранятся дни недели.In this example, a class is declared that stores the days of the week. Также объявляется метод доступа get, который принимает название дня и возвращает соответствующее ему целое число.A get accessor is declared that takes a string, the name of a day, and returns the corresponding integer. Например, для воскресенья будет возвращаться значение 0, для понедельника 1 и т. д.For example, Sunday will return 0, Monday will return 1, and so on.

КодCode

// Using a string as an indexer value
class DayCollection
{
    string[] days = { "Sun", "Mon", "Tues", "Wed", "Thurs", "Fri", "Sat" };

    // This method finds the day or returns -1
    private int GetDay(string testDay)
    {

        for (int j = 0; j < days.Length; j++)
        {
            if (days[j] == testDay)
            {
                return j;
            }
        }

        throw new System.ArgumentOutOfRangeException(testDay, "testDay must be in the form \"Sun\", \"Mon\", etc");
    }

    // The get accessor returns an integer for a given string
    public int this[string day]
    {
        get
        {
            return (GetDay(day));
        }
    }
}

class Program
{
    static void Main(string[] args)
    {
        DayCollection week = new DayCollection();
        System.Console.WriteLine(week["Fri"]);

        // Raises ArgumentOutOfRangeException
        System.Console.WriteLine(week["Made-up Day"]);

        // Keep the console window open in debug mode.
        System.Console.WriteLine("Press any key to exit.");
        System.Console.ReadKey();
    }
}
// Output: 5

ОтказоустойчивостьRobust Programming

Повысить безопасность и надежность индексаторов можно двумя способами:There are two main ways in which the security and reliability of indexers can be improved:

  • Реализуйте стратегию обработки ошибок, предусматривающую действия в ситуациях, когда из клиентского кода передается недопустимое значение индекса.Be sure to incorporate some type of error-handling strategy to handle the chance of client code passing in an invalid index value. В первом примере из этого раздела класс TempRecord содержит свойство Length, с помощью которого клиентский код проверяет введенное значение, прежде чем передать его в индексатор.In the first example earlier in this topic, the TempRecord class provides a Length property that enables the client code to verify the input before passing it to the indexer. Кроме того, код обработки ошибок можно поместить в сам индексатор.You can also put the error handling code inside the indexer itself. Не забудьте задокументировать исключения, которые будут вызываться в методе доступа индексатора, для других пользователей.Be sure to document for users any exceptions that you throw inside an indexer accessor.

  • Настройте максимально ограничивающие уровни доступа для методов get и set.Set the accessibility of the get and set accessors to be as restrictive as is reasonable. Особенно важно сделать это для метода доступа set.This is important for the set accessor in particular. Дополнительные сведения см. в разделе Доступность методов доступа.For more information, see Restricting Accessor Accessibility.

См. такжеSee Also

Руководство по программированию на C#C# Programming Guide
ИндексаторыIndexers
СвойстваProperties