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

Простой пример обобщений

Простой пример обобщений

Начнем рассмотрение обобщений с простого примера обобщенного класса. В приведенной ниже программе определяются два класса. Первым из них является обобщенный класс Gen, вторым — класс GenericsDemo, в котором используется класс Gen.

// Простой пример обобщенного класса,
using System;
//В приведенном ниже классе Gen параметр типа Т заменяется
// реальным типом данных при создании объекта типа Gen.
class Gen<T> {
  T ob; // объявить переменную типа Т
  // Обратите внимание на то, что у этого конструктора
  // имеется параметр типа T
  public Gen(T о) {
    ob = о;
  }
  // Возвратить переменную экземпляра ob,
  //которая относится к типу Т.
  public T GetOb() {
    return ob;
  }
  // Показать тип Т.
  public void ShowType() {
    Console.WriteLine("К типу T относится " + typeof (T));
  }
}
// Продемонстрировать применение обобщенного класса,
class GenericsDemo {
  static void Main() {
    // Создать переменную ссылки на объект Gen типа int.
    Gen<int> iOb;
    // Создать объект типа Gen<int> и
    // присвоить ссылку на него переменной
    iOb = new Gen<int>(102);
    // Показать тип данных, хранящихся в переменной iOb.
    iOb.ShowType();
    // Получить значение переменной iOb.
    int v = iOb.GetOb();
    Console.WriteLine("Значение: " + v);
    Console.WriteLine();
    // Создать объект типа Gen для строк.
    Gen<string> strOb = new Gen<string>("Обобщения повышают эффективность.");
    // Показать тип данных, хранящихся в переменной strOb.
    strOb.ShowType();
    // Получить значение переменной strOb.
    string str = strOb.GetOb();
    Console.WriteLine("Значение: " + str);
  }
}

Эта программа дает следующий результат.

К типу Т относится System.Int32
Значение: 102
К типу Т относится System.String
Значение: Обобщения повышают эффективность.

Внимательно проанализируем эту программу. Прежде всего обратите внимание на объявление класса Gen в приведенной ниже строке кода:

class Gen<T> {

где Т — это имя параметра типа. Это имя служит в качестве метки-заполнителя конкретного типа, который указывается при создании объекта класса Gen. Следовательно, имя Т используется в классе Gen всякий раз, когда требуется параметр типа. Обратите внимание на то, что имя Т заключается в угловые скобки (< >). Этот синтаксис можно обобщить: всякий раз, когда объявляется параметр типа, он указывается в угловых скобках. А поскольку параметр типа используется в классе Gen, то такой класс считается обобщенным.

В объявлении класса Gen можно указывать любое имя параметра типа, но по традиции выбирается имя Т. К числу других наиболее употребительных имен параметров типа относятся V и Е. Вы, конечно, вольны использовать и более описательные имена, например TValue или ТКеу. Но в этом случае первой в имени параметра типа принято указывать прописную букву Т.

Далее имя Т используется для объявления переменной ob, как показано в следующей строке кода.

Т ob; // объявить переменную типа Т

Как пояснялось выше, имя параметра типа Т служит меткой-заполнителем конкретного типа, указываемого при создании объекта класса Gen. Поэтому переменная ob будет иметь тип, привязываемый к Т при получении экземпляра объекта класса Gen. Так, если вместо Т указывается тип string, то в экземпляре данного объекта переменная ob будет иметь тип string.

А теперь рассмотрим конструктор класса Gen.

public Gen(T о) {
  ob = о;
}

Как видите, параметр о этого конструктора относится к типу Т. Это означает, что конкретный тип параметра о определяется типом, привязываемым к Т при создании объекта класса Gen. А поскольку параметр о и переменная экземпляра ob относятся к типу Т, то после создания объекта класса Gen их конкретный тип окажется одним и тем же.

С помощью параметра типа Т можно также указывать тип, возвращаемый методом, как показано ниже на примере метода GetOb().

public Т GetOb()    {
  return ob;
}

Переменная ob также относится к типу Т, поэтому ее тип совпадает с типом, возвращаемым методом GetOb().

Метод ShowType() отображает тип параметра Т, передавая его оператору typeof. Но поскольку реальный тип подставляется вместо Т при создании объекта класса Gen, то оператор typeof получит необходимую информацию о конкретном типе.

В классе GenericsDemo демонстрируется применение обобщенного класса Gen. Сначала в нем создается вариант класса Gen для типа int.

Gen<int> iOb;

Внимательно проанализируем это объявление. Прежде всего обратите внимание на то, что тип int указывается в угловых скобках после имени класса Gen. В этом случае int служит аргументом типа, привязанным к параметру типа Т в классе Gen. В данном объявлении создается вариант класса Gen, в котором тип Т заменяется типом int везде, где он встречается. Следовательно, после этого объявления int становится типом переменной ob и возвращаемым типом метода GetOb().

В следующей строке кода переменной iOb присваивается ссылка на экземпляр объекта класса Gen для варианта типа int.

iOb = new Gen<int> (102);

Обратите внимание на то, что при вызове конструктора класса Gen указывается также аргумент типа int. Это необходимо потому, что переменная (в данном случае — iOb), которой присваивается ссылка, относится к типу Gen<int>. Поэтому ссылка, возвращаемая оператором new, также должна относиться к типу Gen<int>. В противном случае во время компиляции возникнет ошибка. Например, приведенное ниже присваивание станет причиной ошибки во время компиляции.

iOb = new Gen<double>(118.12); // Ошибка!

Переменная iOb относится к типу Gen<int> и поэтому не может использоваться для ссылки на объект типа Gen<double>. Такой контроль типов относится к одним из главных преимуществ обобщений, поскольку он обеспечивает типовую безопасность.

Затем в программе отображается тип переменной ob в объекте iOb — тип System.Int32. Это структура .NET, соответствующая типу int. Далее значение переменной ob получается в следующей строке кода.

int v = iOb.GetOb();

Возвращаемым для метода GetOb() является тип Т, который был заменен на тип int при объявлении переменной iOb, и поэтому метод GetOb() возвращает значение того же типа int. Следовательно, данное значение может быть присвоено переменной v типа int.

Далее в классе GenericsDemo объявляется объект типа Gen<string>.

Gen<string> strOb = new Gen<string>("Обобщения повышают эффективность.");

В этом объявлении указывается аргумент типа string, поэтому в объекте класса Gen вместо Т подставляется тип string. В итоге создается вариант класса Gen для типа string, как демонстрируют остальные строки кода рассматриваемой здесь программы.

Прежде чем продолжить изложение, следует дать определение некоторым терминам. Когда для класса Gen указывается аргумент типа, например int или string, то создается так называемый в C# закрыто сконструированный тип. В частности, Gen<int> является закрыто сконструированным типом. Ведь, по существу, такой обобщенный тип, как Gen<T>, является абстракцией. И только после того, как будет сконструирован конкретный вариант, например Gen<int>, создается конкретный тип. А конструкция, подобная Gen<T>, называется в C# открыто сконструированным типом, поскольку в ней указывается параметр типа Т, но не такой конкретный тип, как int.

В C# чаще определяются такие понятия, как открытый и закрытый типы. Открытым типом считается такой параметр типа или любой обобщенный тип, для которого аргумент типа является параметром типа или же включает его в себя. А любой тип, не относящийся к открытому, считается закрытым. Сконструированным типом считается такой обобщенный тип, для которого предоставлены все аргументы типов. Если все эти аргументы относятся к закрытым типам, то такой тип считается закрыто сконструированным. А если один или несколько аргументов типа относятся к открытым типам, то такой тип считается открыто сконструированным.

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

iOb = strOb; // Неверно!

Несмотря на то что обе переменные, iOb и strOb, относятся к типу Gen<T>, они ссылаются на разные типы, поскольку у них разные аргументы.

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

Для того чтобы стали более понятными преимущества обобщений, рассмотрим сначала программу, в которой создается необобщенный аналог класса Gen.

// Класс NonGen является полным функциональным аналогом
// класса Gen, но без обобщений.
using System;
class NonGen {
  object ob; // переменная ob теперь относится к типу object
  // Передать конструктору ссылку на объект типа object,
  public NonGen(object о) {
    ob = о;
  }
  // Возвратить объект типа object,
  public object GetOb() {
    return ob;
  }
  // Показать тип переменной ob.
  public void ShowType() {
    Console.WriteLine("Тип переменной ob: " + ob.GetType());
  }
}
// Продемонстрировать применение необобщенного класса,
class NonGenDemo {
  static void Main() {
    NonGen iOb;
    // Создать объект класса NonGen.
    iOb = new NonGen(102);
    // Показать тип данных, хранящихся в переменной iOb.
    iOb.ShowType();
    // Получить значение переменной iOb.
    //На этот раз потребуется приведение типов,
    int v = (int)iOb.GetOb();
    Console.WriteLine("Значение: " + v);
    Console.WriteLine();
    // Создать еще один объект класса NonGen и
    // сохранить строку в переменной it.
    NonGen strOb = new NonGen("Тест на необобщенность");
    // Показать тип данных, хранящихся в переменной strOb.
    strOb.ShowType();
    // Получить значение переменной strOb.
    //Ив этом случае требуется приведение типов.
    String str = (string)strOb.GetOb();
    Console.WriteLine("Значение: " + str);
    // Этот код компилируется, но он принципиально неверный!
    iOb = strOb;
    // Следующая строка кода приводит к исключительной
    // ситуации во время выполнения.
    // v = (int) iOb.GetObO; // Ошибка при выполнении!
  }
}

При выполнении этой программы получается следующий результат.

Тип переменной ob: System.Int32
Значение: 102
Тип переменной ob: System.String
Значение: Тест на необобщенность

Как видите, результат выполнения этой программы такой же, как и у предыдущей программы.

В этой программе обращает на себя внимание ряд любопытных моментов. Прежде всего, тип Т заменен везде, где он встречается в классе NonGen. Благодаря этому в классе NonGen может храниться объект любого типа, как и в обобщенном варианте этого класса. Но такой подход оказывается непригодным по двум причинам. Во-первых, для извлечения хранящихся данных требуется явное приведение типов. И во-вторых, многие ошибки несоответствия типов не могут быть обнаружены вплоть до момента выполнения программы. Рассмотрим каждую из этих причин более подробно.

Начнем со следующей строки кода.

int v = (int) iOb.GetOb();

Теперь возвращаемым типом метода GetOb() является object, а следовательно, для распаковки значения, возвращаемого методом GetOb(), и его последующего сохранения в переменной v требуется явное приведение к типу int. Если исключить приведение типов, программа не будет скомпилирована. В обобщенной версии этой программы приведение типов не требовалось, поскольку тип int указывался в качестве аргумента типа при создании объекта iOb. А в необобщенной версии этой программы потребовалось явное приведение типов. Но это не только неудобно, но и чревато ошибками.

А теперь рассмотрим следующую последовательность кода в конце анализируемой здесь программы.

// Этот код компилируется, но он принципиально неверный!
iOb = strOb;
// Следующая строка кода приводит к исключительной
// ситуации во время выполнения.
// v = (int) iOb.GetObO; // Ошибка при выполнении!

В этом коде значение переменной strOb присваивается переменной iOb. Но переменная strOb ссылается на объект, содержащий символьную строку, а не целое значение. Такое присваивание оказывается верным с точки зрения синтаксиса, поскольку все ссылки на объекты класса NonGen одинаковы, а значит, по ссылке на один объект класса NonGen можно обращаться к любому другому объекту класса NonGen. Тем не менее такое присваивание неверно с точки зрения семантики, как показывает следующая далее закомментированная строка кода. В этой строке тип, возвращаемый методом GetOb(), приводится к типу int, а затем предпринимается попытка присвоить полученное в итоге значение переменной int. К сожалению, в отсутствие обобщений компилятор не сможет выявить подобную ошибку. Вместо этого возникнет исключительная ситуация во время выполнения, когда будет предпринята попытка приведения к типу int. Для того чтобы убедиться в этом, удалите символы комментария в начале данной строки кода, скомпилируйте, а затем выполните программу. При ее выполнении возникнет ошибка.

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

В рассматриваемой здесь необобщенной версии программы имеется еще один любопытный момент. Обратите внимание на то, как тип переменной ob экземпляра класса NonGen создается с помощью метода ShowType() в следующей строке кода.

Console.WriteLine("Тип переменной ob: " + ob.GetType());

Как пояснялось в главе 11, в классе object определен ряд методов, доступных для всех типов данных. Одним из них является метод GetType(), возвращающий объект класса Туре, который описывает тип вызывающего объекта во время выполнения. Следовательно, конкретный тип объекта, на который ссылается переменная ob, становится известным во время выполнения, несмотря на то, что тип переменной ob указан в исходном коде как object. Именно поэтому в среде CLR будет сгенерировано исключение при попытке выполнить неверное приведение типов во время выполнения программы.

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