Перегрузка операторов и нестандартные преобразования

ГЛАВА 13
Перегрузка операторов и нестандартные преобразования

Перегрузка операторов. Синтаксис и пример. Перегружаемые операторы. Ограничения на перегрузку операторов. Правила разработки. Нестандартные преобразования.

Синтаксис и пример.

Из главы 7 вы узнали о применении оператора [] для индексации объектов, как если бы они были массивами. В этой главе мы рассмотрим две тесно связанные функции С# для создания интерфейсов структур и классов, упрощающих их понимание и применение: перегрузку операторов (operator overloading) и нестандартные, определенные пользователем преобразования. Я начну с общего обзора перегрузки операторов, чтобы были ясны ее преимущества, затем рассмотрю конкретный синтаксис переопределения поведения операторов по умолчанию, а также реальный пример приложения, в котором оператор + перегружается для объединения нескольких объектов Invoice. Потом вы увидите листинг с перегружаемыми бинарными и унарными операторами и применением некоторых ограничений. Обсуждение перегрузки операторов завершится рекомендациями по принятию решения о перегрузке операторов в ваших классах. Закончив с перегрузкой операторов, вы изучите новую концепцию — нестандартные преобразования. Я опять же начну с основ этой возможности, а затем углублюсь в описание класса, показав, как применять преобразования для структур и классов к другим структурам и классам или базисным типам С#.

Нестандартные преобразования

Ранее я упоминал, что оператор "скобки", применяемый при приведении типов, не может быть перегружен и вместо этого используется нестандартное преобразование. Если коротко, нестандартные преобразования позволяют объявить преобразования для структур и классов, так что эти struct или class могут быть преобразованы в другие структуры, классы или базисные типы С#. Когда и зачем это делать? Скажем, в вашем приложении нужны две температурные шкалы, Цельсия и Фаренгейта, чтобы быстро переводить температуру из одной шкалы в другую. В случае нестандартных преобразований придерживайтесь такого синтаксиса:

Fahrenheit f = 98.6F;

Celsius с = (Celsius)f; // Нестандартное преобразование.

По сравнению с синтаксисом, приведенным ниже, это не дает никаких функциональных преимуществ, но это проще писать и легче читать.

Fahrenheit f = 98.6F;

Celsius с = f.ConvertToCelsius();

Ограничения на перегрузку операторов

Оператор присваивания = перегрузить нельзя. Однако когда вы перегружаете бинарный оператор, оператор присваивания в его составном эквиваленте неявно перегружается. Например, если перегружается оператор +, оператор += неявно перегружается, так что вызывается определенный пользователем метод operator+.

Операторы [] можно перегружать, однако, как вы знаете из главы 7, индексация объектов, определенных пользователем, поддерживается посредством индексаторов.

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

Операторы, которые в настоящее время в языке С# не определены, также не перегружаются. Например, вы не можете определить ** как разновидность возведения в степень, поскольку в С# не определен оператор **. Кроме того, нельзя изменить синтаксис операторов. Вы не можете изменить бинарный оператор *, чтобы он принимал три аргумента, поскольку его синтаксис по определению подразумевает два аргумента. И, наконец, старшинство операторов тоже неизменяемо — правила старшинства неизменны (см. главу 10).

Перегружаемые операторы

Перегружаться могут только перечисленные ниже унарные и бинарные операторы.

Унарные операторы: +, -, !, ~, ++, —, true, false

Бинарные операторы: +, -, *, /, %, &, \, Л , ", ", ==, !=, >, <, >=, <=

Перегрузка операторов

Перегрузка операторов позволяет переопределить операторы С# для применения их к типам, определенным пользователем. Перегрузку oпeраторов назвали "синтаксическим сахаром" ("syntactic sugar"'), имея в виду, что это лишь другой способ вызова метода. Это также должно говорить о том, что эта возможность ничего фундаментального в язык не привносит. Хотя с формальной точки зрения это и так, перегрузка операторов связана с одним из важнейших аспектов ООП — абстракцией. Допустим, вы хотите просуммировать счета для конкретного заказчика. Применив перегрузку операторов, вы можете написать код, в котором оператор += перегружен:

Invoice summarylnvoice = new InvoiceO;

foreach (Invoice invoice in customer.GetlnvoicesQ)

{

summarylnvoice += invoice; >

Достоинства такого кода в том, что здесь используется очень естественный синтаксис и что пользователю не нужно понимать детали реализации объединения счетов. Словом, перегрузка операторов помогает создавать менее дорогие для написания и сопровождения программы.

Подведем итоги

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

Правила разработки

Вы увидели, что собой представляет перегрузка операторов и как она применяется в С#. Теперь рассмотрим один аспект этой полезной возможности, который часто упускают из виду — руководящие принципы, применяемые при разработке. Чего следует избегать, так это известной тенденции использовать какую-то возможность ради нее самой, или "решения ради решения". Между тем при правильном подходе к проектированию нужно помнить поговорку "Код сложнее читать, чем писать". Не забывайте о пользователях своего класса, когда решаете, нужно ли и где перегружать операторы. Вот практическое правило: оператор нужно перегружать, только если в результате интерфейс класса станет более интуитивно понятным. Например, есть определенный смысл предоставить возможность суммировать счета.

Кроме того, не забывайте поставить себя на место пользователя вашего класса. Например, вы пишете класс Invoice для счетов и хотите, чтобы для них могла предоставляться скидка. Нам с вами может быть известно, что в счет добавлена строка, учитывающая кредит, но суть инкапсуляции в том, что пользователю класса не нужно ничего знать о подробностях его реализации. Следовательно, неплохой идеей может быть перегрузка оператора * (как показано ниже), поскольку это сделает интерфейс класса Invoice естественнее и понятнее:

invoice *= .95; // Скидка 5Х.

Запятая здесь разделяет различные перегружаемые

Примечание

Запятая здесь разделяет различные перегружаемые операторы. Сам оператор "запятая", применяемый в операторе for и в вызовах методов, перегружаться не может.

Синтаксис и пример

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

public static возвращаемое_значение operator"/? (объект! [, объект2\) При перегрузке операторов учитывайте следующие факты.

Все методы, представляющие перегружаемые операторы, должны быть определены как public и static. Формально возвращаемое^значение может быть любого типа. Однако общая практика — возвращать тип, для которого определяется метод (кроме операторов true и false — они должны всегда возвращать булево значение). Число передаваемых аргументов (объект!, объект!) зависит от типа перегружаемого оператора. Для унарных (т. е. с одним операндом) операторов должен указываться один аргумент. Для перегрузки бинарного (т. е. с двумя операндами) оператора передаются два аргумента. В случае унарных операторов аргумент этого метода должен быть того же типа, что и включенный в него класс или структура. Иначе говоря, если вы переопределяете унарный оператор "!" для класса Foo,

1 В английском языке по звучанию напоминает "синтетический сахар". — Прим. перев.

этот метод в качестве аргумента должен принимать только переменные типа Foo.

Если перегружается бинарный оператор, тип первого аргумента должен совпадать с типом вложенного класса, а второй может быть любого типа.

В псевдокоде предыдущего раздела я использовал оператор += с классом Invoice. По причинам, которые скоро будут вам понятны, такие составные операторы на самом деле перегрузить нельзя. Переопределить можно только "базовый" оператор, в данном случае +. Вот синтаксис определения метода operator+ метода Invoice:

public static Invoice operator+ (Invoice invoice!, Invoice invoice2) <

// Создаем новый объект Invoice.

// Добавляем необходимое содержимое из

// invoice! в новый объект Invoice.

// Добавляем необходимое содержимое из

// invoice2 в новый объект Invoice.

// Возвращаем новый объект Invoice. >

Теперь рассмотрим пример, более приближенный к действительности, с двумя классами: Invoice и InvoiceDetailLine. Invoice имеет член-переменную типа Array List, который представляет совокупность позиций из всех счетов. Чтобы можно было суммировать позиции из нескольких счетов, я перегрузил оператор + (см. метод operator+). Метод Invoice.оре-rator+ создает новый объект Invoice и проходит по массивам обоих объектов, добавляя каждую позицию к новому объекту Invoice. Затем этот объект возвращается вызывающему методу. Разумеется, в реальном приложении все будет значительно сложней, а здесь я лишь.показываю, как на самом деле могут перегружаться операторы.

using System;

using System.Collections;

class InvoiceDetailLine {

double lineTotal; public double LineTotal {

get {

return this.lineTotal;

} }

public InvoiceDetailLine(double LineTotal) {

this.lineTotal = LineTotal; } }

class Invoice {

public ArrayList DetailLines;

public InvoiceO {

DetailLines = new ArrayListQ; }

public void Printlnvoice() {

Console.WriteLine("\nn,03vmKfl Nbr\tBcero");

int i = 1;

double total = 0;

foreach(InvoiceDetailLine detailLine in DetailLines)

{

Console.WriteLine("{0}\t\t{1}", i++, detailLine.LineTotal);

total += detailLine.LineTotal; }

Console.WriteLine("=====\t\t==="); Console.WriteLine("Bcero\t\t{1}", i++, total); }

public static Invoice operator* (Invoice invoicel,

Invoice invoice2) {

Invoice returnlnvoice = new InvoiceO;

foreach (InvoiceDetailLine detailLine in

invoicel.DetailLines) {

returnlnvoice.DetailLines.Add(detailLine); >

foreach (InvoiceDetailLine detailLine in

invoice2.DetailLines) {

returnlnvoice.DetailLines.Add(detailLine); }

return returnlnvoice; } }

class InvoiceAddApp {

public static void Main() {

Invoice 11 = new InvoiceO; for (int i = 0; i < 2; i++) {

11.DetailLines.Add(new InvoiceDetailLine(i + 1)); }

Invoice i2 = new InvoiceO; for (int i = 0; i < 2; i++) <

12.DetailLines.Add(new InvoiceDetailLine(i + 1)); }

Invoice summarylnvoice = it + 12; summarylnvoice.PrintlnvoiceO; } }

Синтаксис и пример

В синтаксисе нестандартного преобразования применяется ключевое слово operator.

public static implicit operator резулътирующий_тип ( исх_тип операнд); public"static explicit operator результирующий_mun ( ucxjnun операнд).

Правил, связанных с синтаксисом преобразований, немного.

Любой метод преобразования для struct или class (вы можете определить их сколько хотите) должен быть static. Преобразование должно быть определено или как неявное, или как явное. Ключевое слово implicit означает, что клиенту не нужно будет приводить тип — это будет сделано автоматически (неявно). Ключевое слово explicit указывает, что клиент должен явно привести значение к желаемому типу. Все преобразования должны или принимать (как аргумент) тип, который определит преобразование, или возвращать этот тип. Как и при перегрузке операторов в методах преобразования применяется ключевое слово operator, но без добавленного к нему оператора.

Когда я впервые читал эти правила, у меня было смутное представление о том, что делать дальше. Чтобы в этом разобраться, рассмотрим пример. У нас есть две структуры (Celsius и Fahrenheit), позволяющие клиенту преобразовывать значение типа float в любую температурную шкалу. Сначала я представлю структуру Celsius и сделаю несколько замечаний, а затем вы увидите законченное работающее приложение.

struct Celsius {

public Celsius(float temp)

{

this.temp = temp;

}

public static implicit operator Celsius(float temp) {

Celsius c;

с = new Celsius(temp);

return(c); }

public static implicit operator float(Celsius c) {

return((((c.temp - 32) / 9) * 5)); }

public float temp; }

Первое, на что нужно обратить внимание, — использование структуры вместо класса. У меня не было на это особых причин, если не считать, что применение классов обходится дороже (если говорить о выделяемых ресурсах) и что здесь нет особой нужды в использовании класса, так как структуре Celsius не нужны какие-то специфические функции, присущие классам С#, например, наследование.

Далее. Я объявил конструктор с единственным аргументом типа float. Это значение хранится в члене-переменной temp. А теперь посмотрите на оператор преобразования, следующий за конструктором структуры.

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

Вот законченное приложение, включая структуру Fahrenheit.

using System;

struct Celsius {

public Celsius(float temp)

{

this.temp = temp;

}

public static implicit operator Celsius(float temp) {

Celsius c;

с = new Celsius(temp);

return(c); }

public static implicit operator float(Celsius c)

{

return((((c.temp - 32) / 9) * 5)); }

public float temp; }

struct Fahrenheit {

public Fahrenheit(float temp)

this.temp = temp; >

public static implicit operator Fahrenheit(float temp) {

Fahrenheit f; f = new Fahrenheit(temp); return(f); }

public static implicit operator float(Fahrenheit f)

{

return((((f.temp • 9) / 5) + 32));

public float temp; }

class TemplApp

{

public static void Main()

float t;

t=98.6F;

Console.Мг11е("Преобразование {0} в градусы Цельсия = ", t);

Console.WriteLine((Celsius)t);

t=OF;

Console.Write("npeo6pa3oeaHne {0} в градусы

Фаренгейта = ", t); Console.WriteLine((Fahrenheit)t); > }

Скомпилировав и запустив это приложение, вы получите:

Преобразование 98.6 в градусы Цельсия = 37 Преобразование 0 в градусы Фаренгейта = 32

Все это неплохо работает, и выражение (Celsius)98.6F понятней, чем вызов статического метода класса. Но учтите, что преобразующему методу можно передавать только значения типа float. Например, этот код скомпилирован не будет:

Celsius с = new Celsius(55); Console.WriteLine((Fahrenheit)c);

Кроме того, поскольку отсутствует метод для преобразования в шкалу Цельсия, который принимал бы структуру Fahrenheit (и наоборот), код предполагает, что полученное значение требует преобразования. Словом, если я вызову (Celsius)98.6F, я получу значение 37. Однако если значение затем снова передать преобразующему методу, он не будет знать, что оно уже преобразовано и логически уже представляет температуру по Цельсию — для преобразующего метода это всего лишь число с плавающей точкой. В результате значение снова будет преобразовано. Следовательно, нам нужно изменить приложение, чтобы каждая из структур принимала в качестве допустимого аргумента другую структуру.

Когда я задумал это сделать, мне стало страшно: я подумал, что это очень сложная задача. И зря! Смотрите, как все просто:

using System;

class Temperature {

public Temperature(float Temp)

this.temp = Temp;

}

protected float temp; public float Temp <

get {

return this.temp; } } }

class Celsius ; Temperature {

public Celsius(float Temp) : base(Temp) {}

public static implicit operator Celsius(float Temp) {

return new Celsius(Temp); }

public static implicit operator Celsius(Fahrenheit F) {

return new Celsius(F.Temp);

}

public static implicit operator float(Celsius C)

{

return((((C.temp - 32) / 9) * 5));

} }

class Fahrenheit : Temperature

{

public Fahrenheit(float Temp) : base(Temp) {}

public static implicit operator Fahrenheit(float Temp)

{

return new Fahrenheit(Temp);

}

public static implicit operator Fahrenheit(Celsius C)

{

return new Fahrenheit(C.Temp);

}

public static implicit operator float(Fahrenheit F)

{

return((((F.temp * 9) / 5) + 32));

} }

class Temp2App

{

public static void DisplayTemp(Celsius Temp)

{

Console.Write("Преобразование {0} {1} в градусы "+ "Фаренгейта = ", Temp.ToStringO, Temp.Temp); Console.WriteLine((Fah renheit)Temp); }

public static void DisplayTemp(Fahrenheit Temp)

{

Console.Write("Преобразование {0} {1} в градусы Цельсия = ",

Temp.ToStringO, Temp.Temp); Console.WriteLine((Celsius)Temp); }

public static void Main() {

Fahrenheit f = new Fahrenheit(98.6F);

DisplayTemp(f);

Celsius с = new Celsius(OF); DisplayTemp(c); } }

Обратите внимание: я изменил типы Celsius и Fahrenheit из struct в class. Это сделано только для того, чтобы иметь два примера: один со структурами, другой — с классами. Но более важная причина — возможность совместного использования члена temp, имея классы Celsius и Fahrenheit, производные от одного базового класса Temperature. При выводе я здесь применяю унаследованный от System. Object метод ToString.

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

public static implicit operator Celsius(float temp) {

Celsius c;

с = new Celsius(temp);

return(c); }

public static implicit operator Celsius(Fahrenheit f) {

Celsius c;

с = new Celsius(f.temp);

return(c); }

Все, что нужно было сделать, — изменить передаваемый аргумент и получать температуру из передаваемого объекта, а не из жестко заданного значения типа float. Теперь вы видите, насколько просты и стереотипны методы преобразования.