C# 4.0: полное руководство - Герберт Шилдт

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

Индексаторы

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

Рассмотрим сначала одномерные индексаторы.

Создание одномерных индексаторов

Ниже приведена общая форма одномерного индексатора:

тип_элемента this[int индекс] {

  // Аксессор для получения данных, get {

    // Возврат значения, которое определяет индекс.

  }

  // Аксессор для установки данных, set {

    // Установка значения, которое определяет индекс.

  }

}

где тип_элемента обозначает конкретный тип элемента индексатора. Следовательно, у каждого элемента, доступного с помощью индексатора, должен быть определенный тип_элемента. Этот тип соответствует типу элемента массива. Параметр индекс получает конкретный индекс элемента, к которому осуществляется доступ. Формально этот параметр совсем не обязательно должен иметь тип int, но поскольку индексаторы, как правило, применяются для индексирования массивов, то чаще всего используется целочисленный тип данного параметра.

В теле индексатора определены два аксессора (т.е. средства доступа к данным): get и set. Аксессор подобен методу, за исключением того, что в нем не объявляется тип возвращаемого значения или параметры. Аксессоры вызываются автоматически при использовании индексатора, и оба получают индекс в качестве параметра. Так, если индексатор указывается в левой части оператора присваивания, то вызывается аксессор set и устанавливается элемент, на который указывает параметр индекс. В противном случае вызывается аксессор get и возвращается значение, соответствующее параметру индекс. Кроме того, аксессор set получает неявный параметр value, содержащий значение, присваиваемое по указанному индексу.

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

// Использовать индексатор для создания отказоустойчивого массива.

using System;

class FailSoftArray {

  int[] a; // ссылка на базовый массив

  public int Length; //открытая переменная длины массива

  public bool ErrFlag; // обозначает результат последней операции

  // Построить массив заданного размера,

  public FailSoftArray(int size) {

    a = new int [size] ;

    Length = size;

  }

  // Это индексатор для класса FailSoftArray.

  public int this[int index] {

    // Это аксессор get.

    get {

      if (ok(index)) {

        ErrFlag = false;

        return a[index];

      }

      else {

        ErrFlag = true;

        return 0;

      }

    }

    // Это аксессор set.

    set {

      if(ok(index)) {

        a[index] = value;

        ErrFlag = false;

      }

      else

        ErrFlag = true;

    }

  }

  // Возвратить логическое значение true, если

  // индекс находится в установленных границах,

  private bool ok(int index) {

    if(index >= 0 & index < Length) return true;

    return false;

  }

}

// Продемонстрировать применение отказоустойчивого массива,

class FSDemo {

  static void Main() {

    FailSoftArray fs = new FailSoftArray(5);

    int x;

    // Выявить скрытые сбои.

    Console.WriteLine("Скрытый сбой.");

    for(int i=0; i < (fs.Length * 2); i++)

      fs[i] = i*10;

    for(int i=0; i < (fs.Length * 2); i++) {

      x = fs[i] ;

      if (x != -1) Console.Write(x + " ") ;

    }

    Console.WriteLine();

    //А теперь показать сбои.

    Console.WriteLine("nСбой с уведомлением об ошибках.");

    for(int i=0; i < (fs.Length * 2); i++) {

      fs[i] = i * 10;

      if(fs.ErrFlag)

        Console.WriteLine("fs[" + i + "] вне границ");

    }

    for(int i=0; i < (fs.Length * 2); i++) {

      x = fs [ i ] ;

      if(!fs.ErrFlag)

        Console.Write(x + " ");

      else

        Console.WriteLine("fs[" + i + "] вне границ");

    }

  }

}

Вот к какому результату приводит выполнение этой программы.

Скрытый сбой.

0 10 20 30 40 0 0 0 0 0

Сбой с уведомлением об ошибках.

fs[5] вне границ

fs[6] вне границ

fs[7] вне границ

fs[8] вне границ

fs[9] вне границ

0 10 20 30 40 fs[5] вне границ

fs[6] вне границ

fs[7] вне границ

fs[8] вне границ

fs[9] вне границ

Индексатор препятствует нарушению границ массива. Внимательно проанализируем каждую часть кода индексатора. Он начинается со следующей строки.

public int this[int index] {

В этой строке кода объявляется индексатор, оперирующий элементами типа int. Ему передается индекс в качестве параметра index. Кроме того, индексатор объявляется открытым (public), что дает возможность использовать этот индексатор в коде за пределами его класса.

Рассмотрим следующий код аксессора get.

get {

  if (ok(index) ) {

    ErrFlag = false;

    return a[index];

  }

  else {

    ErrFlag = true;

    return 0;

  }

}

Аксессор get предотвращает ошибки нарушения границ массива, проверяя в первую очередь, находится ли индекс в установленных границах. Эта проверка границ выполняется в методе ok(), который возвращает логическое значение true, если индекс правильный, а иначе — логическое значение false. Так, если указанный индекс находится в установленных границах, то по этому индексу возвращается соответствующий элемент. А если индекс оказывается вне установленных границ, то никаких операций не выполняется, но в то же время не возникает никаких ошибок переполнения. В данном варианте класса FailSoftArray переменная ErrFlag содержит результат каждой операции. Ее содержимое может быть проверено после каждой операции на предмет удачного или неудачного выполнения последней. (В главе 13 будет представлен более совершенный способ обработки ошибок с помощью имеющейся в C# подсистемы обработки исключительных ситуаций, а до тех пор можно вполне обойтись установкой и проверкой признака ошибки.)