Книга: C# 4.0: полное руководство

Свойства

Свойства

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

Свойства очень похожи на индексаторы. В частности, свойство состоит из имени и аксессоров get и set. Аксессоры служат для получения и установки значения переменной. Главное преимущество свойства заключается в том, что его имя может быть использовано в выражениях и операторах присваивания аналогично имени обычной переменной, но в действительности при обращении к свойству по имени автоматически вызываются его аксессоры get и set. Аналогичным образом используются аксессоры get и set индексатора.

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

ТИП имя{
get {
// код аксессора для чтения из поля
}
set {
// код аксессора для записи в поле
}

где тип обозначает конкретный тип свойства, например int, а имя — присваиваемое свойству имя. Как только свойство будет определено, любое обращение к свойству по имени приведет к автоматическому вызову соответствующего аксессора. Кроме того, аксессор set принимает неявный параметр value, который содержит значение, присваиваемое свойству.

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

Ниже приведен простой пример программы, в которой определяется свойство MyProp, предназначенное для доступа к полю prop. В данном примере свойство допускает присваивание только положительных значений.

// Простой пример применения свойства.
using System;
class SimpProp {
  int prop; // поле, управляемое свойством MyProp
  public SimpProp() { prop = 0; }
  /* Это свойство обеспечивает доступ к закрытой переменной экземпляра prop. Оно допускает присваивание только положительных значений. */
  public int MyProp {
    get {
      return prop;
    }
    set {
      if(value >= 0) prop = value;
    }
  }
}
// Продемонстрировать применение свойства,
class PropertyDemo {
  static void Main() {
    SimpProp ob = new SimpProp();
    Console.WriteLine("Первоначальное значение ob.MyProp: " + ob.MyProp);
    ob.MyProp = 100; // присвоить значение
    Console.WriteLine("Текущее значение ob.MyProp: " + ob.MyProp);
    // Переменной prop нельзя присвоить отрицательное значение.
    Console.WriteLine("Попытка присвоить значение " +
           "-10 свойству ob.MyProp");
    ob.MyProp = -10;
    Console.WriteLine("Текущее значение ob.MyProp: " + ob.MyProp);
  }
}

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

Первоначальное значение ob.MyProp: 0
Текущее значение ob.MyProp: 100
Попытка присвоить значение -10 свойству ob.MyProp
Текущее значение ob.MyProp: 100

Рассмотрим приведенный выше код более подробно. В этом коде определяется одно закрытое поле prop и свойство МуРгор, управляющее доступом к полю prop. Как пояснялось выше, само свойство не определяет место в памяти для хранения поля, а только управляет доступом к полю. Кроме того, поле prop является закрытым, а значит, оно доступно только через свойство МуРгор.

Свойство МуРгор указано как public, а следовательно, оно доступно из кода за пределами его класса. И в этом есть своя логика, поскольку данное свойство обеспечивает доступ к полю prop, которое является закрытым. Аксессор get этого свойства просто возвращает значение из поля prop, тогда как аксессор set устанавливает значение в поле prop в том и только в том случае, если это значение оказывается положительным. Таким образом, свойство МуРгор контролирует значения, которые могут храниться в поле prop. В этом, собственно, и состоит основное назначение свойств.

Тип свойства МуРгор определяется как для чтения, так и для записи, поскольку оно позволяет читать и записывать данные в базовое поле. Тем не менее свойства можно создавать доступными только для чтения или только для записи. Так, если требуется создать свойство, доступное только для чтения, то достаточно определить единственный аксессор get. А если нужно создать свойство, доступное только для записи, то достаточно определить единственный аксессор set.

Воспользуемся свойством для дальнейшего усовершенствования отказоустойчивого массива. Как вам должно быть уже известно, у всех массивов имеется соответствующее свойство длины (Length). До сих пор в классе FailSoftArray для этой цели использовалось открытое целочисленное поле Length. Но это далеко не самый лучший подход, поскольку он допускает установку значений, отличающихся от длины отказоустойчивого массива. (Например, программист, преследующий злонамеренные цели, может умышленно ввести неверное значение в данном поле.) Для того чтобы исправить это положение, превратим поле Length в свойство "только для чтения", как показано в приведенном ниже, измененном варианте класса FailSoftArray.

// Добавить свойство Length в класс FailSoftArray.
using System;
class FailSoftArray {
  int[] a; // ссылка на базовый массив
  int len; // длина массива — служит основанием для свойства Length
  public bool ErrFlag; // обозначает результат последней операции
  // Построить массив заданного размера,
  public FailSoftArray(int size) {
    a = new int[size]; len = size;
  }
  // Свойство Length только для чтения,
  public int Length {
    get {
      return len;
    }
  }
  // Это индексатор для класса 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 ImprovedFSDemo {
  static void Main() {
    FailSoftArray fs = new FailSoftArray(5);
    int x;
    // Разрешить чтение свойства Length,
    for (int i=0; i < fs.Length; i++) fs[i] = i*10;
    for (int i=0; i < fs.Length; i++) {
      x = fs[i] ;
      if(x != -1) Console.Write(x + " ");
    }
    Console.WriteLine();
    // fs.Length = 10; // Ошибка, запись запрещена!
  }
}

Теперь Length — это свойство, в котором местом для хранения данных служит закрытая переменная lеn. А поскольку в этом свойстве определен единственный аксессор get, то оно доступно только для чтения. Это означает, что значение свойства Length можно только читать, но не изменять. Для того чтобы убедиться в этом, попробуйте удалить символы комментария в начале следующей строки из приведенного выше кода.

// fs.Length =10; // Ошибка, запись запрещена!

При попытке скомпилировать данный код вы получите сообщение об ошибке, уведомляющее о том, что Length является свойством, доступным только для чтения.

Добавлением свойства Length в класс FailSoftArray усовершенствование рассматриваемого здесь примера кода с помощью свойств далеко не исчерпывается. Еще одним членом данного класса, подходящим для превращения в свойство, служит переменная ErrFlag, поскольку ее применение должно быть ограничено только чтением. Ниже приведен окончательно усовершенствованный вариант класса FailSoftArray, в котором создается свойство Error, использующее в качестве места для хранения данных исходную переменную ErrFlag, ставшую теперь закрытой.

// Превратить переменную ErrFlag в свойство.
using System;
class FailSoftArray {
  int[] a; // ссылка на базовый массив
  int len; // длина массива
  bool ErrFlag; // теперь это частная переменная,
  // обозначающая результат последней операции
  // Построить массив заданного размера,
  public FailSoftArray(int size) {
    a = new int[size];
    len = size;
  }
  // Свойство Length только для чтения,
  public int Length {
    get {
      return len;
    }
  }
  // Свойство Error только для чтения,
  public bool Error {
    get {
      return ErrFlag;
    }
  }
  // Это индексатор для класса 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 FinalFSDemo {
  static void Main() {
    FailSoftArray fs = new FailSoftArray(5);
    // Использовать свойство Error,
    for(int i=0; i < fs.Length + 1; i++) {
      fs[i] = i * 10;
      if(fs.Error)
        Console.WriteLine("Ошибка в индексе " + i);
    }
  }
}

Создание свойства Error стало причиной двух следующих изменений в классе FailSoftArray. Во-первых, переменная ErrFlag была сделана закрытой, поскольку теперь она служит базовым местом хранения данных для свойства Error, а следовательно, она не должна быть доступна непосредственно. И во-вторых, было введено свойство Error "только для чтения". Теперь свойство Error будет опрашиваться в тех программах, где требуется организовать обнаружение ошибок. Именно это и было продемонстрировано выше в методе Main(), где намеренно сгенерирована ошибка нарушения границ массива, а для ее обнаружения использовано свойство Error.

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

тип имя { get; set; }

где тип обозначает конкретный тип свойства, а имя — присваиваемое свойству имя. Обратите внимание на то, что после обозначений аксессоров get и set сразу же следует точка с запятой, а тело у них отсутствует. Такой синтаксис предписывает компилятору создать автоматически переменную, иногда еще называемую поддерживающим полем, для хранения значения. Такая переменная недоступна непосредственно и не имеет имени. Но в то же время она может быть доступна через свойство.

Ниже приведен пример объявления свойства, автоматически реализуемого под именем UserCount.

public int UserCount { get; set; }

Как видите, в этой строке кода переменная явно не объявляется. И как пояснялось выше, компилятор автоматически создает анонимное поле, в котором хранится значение. А в остальном автоматически реализуемое свойство UserCount подобно всем остальным свойствам.

Но в отличие от обычных свойств автоматически реализуемое свойство не может быть доступным только для чтения или только для записи. При объявлении этого свойства в любом случае необходимо указывать оба аксессора — get и set. Хотя добиться желаемого (т.е. сделать автоматически реализуемое свойство доступным только для чтения или только для записи) все же можно, объявив ненужный аксессор как private (подробнее об этом — в разделе "Применение модификаторов доступа в аксессорах").

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

Как пояснялось в главе 8, инициализатор объекта применяется в качестве альтернативы явному вызову конструктора при создании объекта. С помощью инициализаторов объектов задаются начальные значения полей или свойств, которые требуется инициализировать. При этом синтаксис инициализаторов объектов оказывается одинаковым как для свойств, так и для полей. В качестве примера ниже приведена программа из главы 8, измененная с целью продемонстрировать применение инициализаторов объектов в свойствах. Напомним, что в версии этой программы из главы 8 использовались поля, а приведенная ниже версия отличается лишь тем, что в ней поля Count и Str превращены в свойства. В то же время синтаксис инициализаторов объектов не изменился.

// Применить инициализаторы объектов в свойствах
using System;
// Применить инициализаторы объектов в свойствах.
class MyClass {
  // Теперь это свойства,
  public int Count { get; set; }
  public string Str { get; set; }
}
class ObjlnitDemo {
  static void Main() {
    // Сконструировать объект типа MyClass с помощью инициализаторов объектов.
    MyClass obj = new MyClass {
             Count = 100, Str = "Тестирование" };
    Console.WriteLine (obj.Count + " " + obj.Str);
  }
}

Как видите, свойства Count и Str устанавливаются в выражениях с инициализатором объекта. Приведенная выше программа дает такой же результат, как и программа из главы 8, а именно:

100 Тестирование

Как пояснялось в главе 8, синтаксис инициализатора объекта оказывается наиболее пригодным для работы с анонимными типами, формируемыми в LINQ-выражениях. А в остальных случаях чаще всего используется синтаксис обычных конструкторов.

Свойствам присущ ряд существенных ограничений. Во-первых, свойство не определяет место для хранения данных, и поэтому не может быть передано методу в качестве параметра ref или out. Во-вторых, свойство не подлежит перегрузке. Наличие двух разных свойств с доступом к одной и той же переменной допускается, но это, скорее, исключение, чем правило. И наконец, свойство не должно изменять состояние базовой переменной при вызове аксессора get. И хотя это ограничительное правило не соблюдается компилятором, его нарушение считается семантической ошибкой. Действие аксессора get не должно носить характер вмешательства в функционирование переменной.

Оглавление книги