Функциональный тип в C#. Делегаты

Наследование и полиморфизм - альтернатива обратному вызову

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

О полиморфизме говорилось достаточно много в предыдущих лекциях. Тем не менее, позволю напомнить суть дела. Родитель может объявить свой метод виртуальным, в этом случае в контракте на метод потомку разрешается переопределить реализацию, но он не имеет права изменять сигнатуру виртуального метода. Когда некоторый метод родителя Q вызывает виртуальный метод F, то, благодаря позднему связыванию, реализуется полиморфизм и реально будет вызван не метод родителя F, а метод F, который реализован потомком, вызвавшим родительский метод Q. Ситуация в точности напоминает раскрутку и вызов обратных функций. Родительский метод Q находится во внутреннем слое, а потомок с его методом F определен во внешнем слое. Когда потомок вызывает метод Q из внутреннего слоя, тот, в свою очередь, вызывает метод F из внешнего слоя. Сигнатура вызываемого метода F в данном случае задается не делегатом, а сигнатурой виртуального метода, которую, согласно контракту, потомок не может изменить. Давайте вернемся к задаче вычисления интеграла и создадим реализацию, основанную на наследовании и полиморфизме.

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

class FIntegral
{
	//базовый класс, в котором определен метод вычисления 
	//интеграла и виртуальный метод, задающий базовую
	//подынтегральную функцию
	public double EvaluateIntegral(double a, double b, 
		double eps)
	{
		int n=4;
		double I0=0, I1 = I( a, b, n);
		for( n=8; n < Math.Pow(2.0,15.0); n*=2)
		{
			I0 =I1; I1=I(a,b,n);
			if(Math.Abs(I1-I0)<eps)break;
		}
		if(Math.Abs(I1-I0)< eps)
			Console.WriteLine("Требуемая точность достигнута! "+
				" eps = {0}, достигнутая точность ={1}, n= {2}",
				eps,Math.Abs(I1-I0),n);
		else
			Console.WriteLine("Требуемая точность не достигнута! "+
				" eps = {0}, достигнутая точность ={1}, n= {2}",
				eps,Math.Abs(I1-I0),n);
		return(I1);			
	}
	private double I(double a, double b, int n)
	{
		//Вычисляет частную сумму по методу трапеций
		double x = a, sum = sif(x)/2, dx = (b-a)/n;
		for (int i= 2; i <= n; i++)
		{
			x += dx; sum += sif(x);
		}
		x = b; sum += sif(x)/2;
		return(sum*dx);
	}
	protected virtual double sif(double x)
	{return(1.0);}
	
}//FIntegral

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

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

class FIntegralSon:FIntegral
{
	protected override double sif(double x)
	{
		double a = 1.0; double b = 2.0; double c= 3.0;
		return (double)(a*x*x +b*x +c);
	}
}//FIntegralSon

Принципиально задача решена. Осталось только написать фрагмент кода, запускающий вычисления. Он оформлен в виде следующей процедуры:

public void TestPolymorphIntegral()
{
	FIntegral integral1 = new FIntegral();
	FIntegralSon integral2 = new FIntegralSon();
	double res1 = integral1.EvaluateIntegral(2.0,3.0,0.1e-5);
	double res2 = integral2.EvaluateIntegral(2.0,3.0,0.1e-5);
	Console.WriteLine("Father = {0}, Son = {1}", res1,res2);
}//PolymorphIntegral

Взгляните на результаты вычислений.

Делегаты как свойства

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

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

В этом классе будут определены операции над объектами. Среди операций нас, прежде всего, будет интересовать сортировка объектов, реализованная в виде функции высших порядков. Функциональный параметр будет задавать класс функций сравнения объектов, реализации которых находятся в классе Person. Делегат, определяющий класс функций сравнения, будет задан в классе Persons.

Теперь, когда задача ясна, приступим к ее реализации. Класс Person уже появлялся в наших примерах, поэтому он просто дополнен до нужной функциональности. Добавим методы сравнения двух объектов Person:

//методы сравнения
private static int CompareName(Person obj1, Person obj2)
{
	return(string.Compare(obj1.name,obj2.name));
}
private static int CompareId(Person obj1, Person obj2)
{			
	if( obj1.id > obj2.id) return(1);
	else return(-1);
}
private static int CompareSalary(Person obj1, Person obj2)
{			
	if( obj1.salary > obj2.salary) return(1);
		else if(obj1.salary < obj2.salary)return(-1);
			else return(0);
}
private static int CompareSalaryName(Person obj1, Person obj2)
{
	if( obj1.salary > obj2.salary) return(1);
	else if(obj1.salary < obj2.salary)return(-1);
	else return(string.Compare(obj1.name,obj2.name));
}

Заметьте, методы закрыты и, следовательно, недоступны извне. Их четыре, но могло бы быть и больше, при возрастании сложности объекта растет число таких методов. Все методы имеют одну и ту же сигнатуру и удовлетворяют контракту, заданному делегатом, который будет описан чуть позже. Для каждого метода необходимо построить экземпляр делегата, который будет задавать ссылку на метод. Поскольку не все экземпляры нужны одновременно, то хотелось бы строить их динамически, в тот момент, когда они понадобятся. Это можно сделать, причем непосредственно в классе Person. Закрытые методы будем рассматривать как закрытые свойства и для каждого из них введем статическую процедуру-свойство, возвращающую в качестве результата экземпляр делегата со ссылкой на метод. Проще написать, чем объяснить на словах:

//делегаты как свойства
public static Persons.CompareItems SortByName
{
	get	{return(new Persons.CompareItems(CompareName));}
}
public static Persons.CompareItems SortById
{
	get	{return(new Persons.CompareItems(CompareId));}
}
public static Persons.CompareItems SortBySalary
{
	get	{return(new Persons.CompareItems(CompareSalary));}
}
public static Persons.CompareItems SortBySalaryName
{
	get	{return(new Persons.CompareItems(CompareSalaryName));}
}

Всякий раз, когда будет запрошено, например, свойство SortByName класса Person, будет возвращен объект функционального класса Persons.CompareItems, задающий ссылку на метод CompareName класса Person. Объект будет создаваться динамически в момент запроса.

Класс Person полностью определен, и теперь давайте перейдем к определению контейнера, содержащего объекты Person. Начну с определения свойств класса Persons:

class Persons
{	//контейнер объектов Person
	//делегат
	public delegate int CompareItems(Person obj1, Person obj2);
	private int freeItem = 0;
	const int  n = 100;	
	private Person[]persons = new Person[n];
}

В классе определен функциональный класс - делегат CompareItems, задающий контракт, которому должны удовлетворять функции сравнения элементов.

Контейнер объектов реализован простейшим образом в виде массива объектов. Переменная freeItem - указатель на первый свободный элемент массива. Сам массив является закрытым свойством, и доступ к нему осуществляется благодаря индексатору:

//индексатор
public Person this[int num]
{
	get { return(persons[num-1]); }
	set { persons[num-1] = value; }
}

Добавим классический для контейнеров набор методов - добавление нового элемента, загрузка элементов из базы данных и печать элементов:

public void AddPerson(Person pers)
{
	if(freeItem < n)
	{
		Person p = new Person(pers);
		persons[freeItem++]= p;
	}
	else Console.WriteLine("Не могу добавить Person");
}
public void LoadPersons()
{
	//реально загрузка должна идти из базы данных
	AddPerson(new Person("Соколов",123, 750.0));
	AddPerson(new Person("Синицын",128, 850.0));
	AddPerson(new Person("Воробьев",223, 750.0));
	AddPerson(new Person("Орлов",129, 800.0));
	AddPerson(new Person("Соколов",133, 1750.0));
	AddPerson(new Person("Орлов",119, 750.0));
}//LoadPersons
public void PrintPersons()
{
	for(int i =0; i<freeItem; i++)
	{
		Console.WriteLine("{0,10} {1,5} {2,5}",
		persons[i].Name, persons[i].Id, persons[i].Salary);
	}
}//PrintPersons

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

//сортировка
public void SimpleSortPerson(CompareItems compare)
{
	Person temp = new Person();
	for(int i = 1; i<freeItem;i++)
		for(int j = freeItem -1; j>=i; j--)
			if (compare(persons[j],persons[j-1])==-1)
			{
				temp = persons[j-1];
				persons[j-1]=persons[j];
				persons[j] = temp;
			}
}//SimpleSortObject
}//Persons

Единственный аргумент метода SimpleSortPerson принадлежит классу CompareItems, заданному делегатом. Что касается метода сортировки, то реализован простейший алгоритм пузырьковой сортировки, со своей задачей он справляется. На этом проектирование классов закончено, нужная цель достигнута, показано, как можно в классе экземпляры делегатов задавать как свойства. Для завершения обсуждения следует продемонстрировать, как этим нужно пользоваться. Зададим, как обычно, тестирующую процедуру, в которой будут использоваться различные критерии сортировки:

public void TestSortPersons()
{
	Persons persons = new Persons();
	persons.LoadPersons();
	Console.WriteLine ("	Сортировка по имени: ");
	persons.SimpleSortPerson(Person.SortByName);
	persons.PrintPersons();
	Console.WriteLine ("	Сортировка по идентификатору: ");
	persons.SimpleSortPerson(Person.SortById);
	persons.PrintPersons();
	Console.WriteLine ("	Сортировка по зарплате: ");
	persons.SimpleSortPerson(Person.SortBySalary);
	persons.PrintPersons();
	Console.WriteLine ("	Сортировка по зарплате и имени: ");
	persons.SimpleSortPerson(Person.SortBySalaryName);
	persons.PrintPersons();
}//SortPersons

Результаты работы сортировки данных изображены на рис. 20.5.

Операции над делегатами. Класс Delegate

Давайте просуммируем то, что уже известно о функциональном типе данных. Ключевое слово delegate позволяет задать определение функционального типа (класса), фиксирующее контракт, которому должны удовлетворять все функции, принадлежащие классу. Функциональный класс можно рассматривать как ссылочный тип, экземпляры которого являются ссылками на функции. Заметьте, ссылки на функции - это безопасные по типу указатели, которые ссылаются на функции с жестко фиксированной сигнатурой, заданной делегатом. Следует также понимать, что это не простая ссылка на функцию. В том случае, когда экземпляр делегата инициирован динамическим методом, то экземпляр хранит ссылку на метод и на объект X, вызвавший этот метод.

Вместе с тем, объявление функционального типа не укладывается в синтаксис, привычный для C#. Хотелось бы писать, как принято:

Delegate FType = new Delegate(<определение типа>)

Но так объявлять переменные этого класса нельзя, и стоит понять, почему. Есть ли вообще класс Delegate? Ответ положителен - есть такой класс. При определении функционального типа, например:

public delegate int FType(int X);

переменная FType принадлежит классу Delegate. Почему же ее нельзя объявить привычным образом? Дело не только в синтаксических особенностях этого класса. Дело в том, что класс Delegate является абстрактным классом. Вот его объявление:

public abstract class Delegate: ICloneable, ISerializable

Для абстрактных классов реализация не определена, и это означает, что нельзя создавать экземпляры класса. Класс Delegate служит базовым классом для классов - наследников. Но создавать наследников могут только компиляторы и системные программы - этого нельзя сделать в программе на C#. Именно поэтому введено ключевое слово delegate, которое косвенно позволяет работать с классом Delegate, создавая уже не абстрактный, а реальный класс. Заметьте, при этом все динамические и статические методы класса Delegate становятся доступными программисту.

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

В чем суть комбинирования делегатов? Она прозрачна. К экземпляру делегату разрешается поочередно присоединять другие экземпляры делегата того же типа. Поскольку каждый экземпляр хранит ссылку на функцию, то в результате создается список ссылок. Этот список называется списком вызовов (invocation list). Когда вызывается экземпляр, имеющий список вызова, то поочередно, в порядке присоединения, начинают вызываться и выполняться функции, заданные ссылками. Так один вызов порождает выполнение списка работ.

Понятно, что, если есть операция присоединения делегатов, то должна быть и обратная операция, позволяющая удалять делегатов из списка.

Рассмотрим основные методы и свойства класса Delegate. Начнем с двух статических методов - Combine и Remove. Первый из них присоединяет экземпляры делегата к списку, второй - удаляет из списка. Оба метода имеют похожий синтаксис:

Combine(del1, del2)
Remove(del1, del2)

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

Класс Delegate относится к неизменяемым классам, поэтому оба метода возвращают ссылку на нового делегата. Возвращаемая ссылка принадлежит родительскому классу Delegate, поэтому ее необходимо явно преобразовать к нужному типу, которому принадлежат del1 и del2. Обычное использование этих методов имеет вид:

del1 = (<type>) Combine(del1, del2);
del1 = (<type>) Remove(del1, del2);

Метод GetInvocationList является динамическим методом класса - он возвращает список вызовов экземпляра, вызвавшего метод. Затем можно устроить цикл foreach, поочередно получая элементы списка. Чуть позже появится пример, поясняющий необходимость подобной работы со списком.

Два динамических свойства Method и Target полезны для получения подробных сведений о делегате. Чаще всего они используются в процессе отражения, когда делегат поступает извне и необходима метаинформация, поставляемая с делегатом. Свойство Method возвращает объект класса MethodInfo из пространства имен Reflection. Свойство Target возвращает информацию об объекте, вызвавшем делегата, в тех случаях, когда делегат инициируется не статическим методом класса, а динамическим, связанным с вызвавшим его объектом.

У класса Delegate, помимо методов, наследуемых от класса Object, есть еще несколько методов, но мы на них останавливаться не будем, они используются не столь часто.

Операции "+" и "-"

Наряду с методами, над делегатами определены и две операции: "+" и "-", которые являются более простой формой записи добавления делегатов в список вызовов и удаления из списка. Операции заменяют собой методы Combine и Remove. Выше написанные присваивания объекту del1 с помощью этих операций могут быть переписаны в виде:

del1 +=del2;
del1 -=del2;

Как видите, запись становится проще, исчезает необходимость в задании явного приведения к типу. Ограничения на del1 и del2, естественно, остаются те же, что и для методов Combine и Remove.

Пример "Комбинирование делегатов"

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

Начнем с построения класса с именем Combination, где, следуя уже описанной технологии, введем делегатов как закрытые свойства, доступ к которым идет через процедуру-свойство get. Три делегата одного класса будут описывать действия трех городских служб. Класс будет описываться ранее введенным делегатом MesToPers, размещенным в пространстве имен проекта. Вот программный код, в котором описаны функции, задающие действия служб:

class Combination
{
	private static void policeman(string mes)
	{
		//анализ сообщения
		if(mes =="Пожар!")
			Console.WriteLine(mes + " Милиция ищет виновных!");
		else	
			Console.WriteLine(mes +" Милиция здесь!");
	}
	private static void ambulanceman(string mes)
	{
		if(mes =="Пожар!")
			Console.WriteLine(mes + " Скорая спасает пострадавших!");
		else
			Console.WriteLine(mes + " Скорая помощь здесь!");
	}
	private static void fireman(string mes)
	{
		if(mes =="Пожар!")
			Console.WriteLine(mes + " Пожарные тушат пожар!");
		else
			Console.WriteLine( mes + " Пожарные здесь!");
	}
}

Как видите, все три функции имеют не только одинаковую сигнатуру, но и устроены одинаково. Они анализируют приходящее к ним сообщение, переданное через параметр mes, а затем, в зависимости от результата, выполняют ту или иную работу, которая в данном случае сводится к выдаче соответствующего сообщения. Сами функции закрыты, и мы сейчас организуем к ним доступ:

public static MesToPers Policeman
{
	get {return (new MesToPers(policeman));}
}
public static MesToPers Fireman
{
	get {return (new MesToPers(fireman));}
}
public static MesToPers Ambulanceman
{
	get {return (new MesToPers(ambulanceman));}
}

Три статических открытых свойства - Policeman, Fireman, Ambulanceman - динамически создают экземпляры класса MesToPers, связанные с соответствующими закрытыми функциями класса.

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

public void TestSomeServices()
{
	MesToPers Comb;
	Comb = (MesToPers)Delegate.Combine(Combination.Ambulanceman,
			Combination.Policeman);
	Comb = (MesToPers)Delegate.Combine(Comb,Combination.Fireman);
			Comb("Пожар!");

Вначале объявляется без инициализации функциональная переменная Comb, которой в следующем операторе присваивается ссылка на экземпляр делегата, созданного методом Combine, чей список вызова содержит ссылки на экземпляры делегатов Ambulanceman и Policeman. Затем к списку вызовов экземпляра Comb присоединяется новый кандидат Fireman. При вызове делегата Comb ему передается сообщение "Пожар!". В результате вызова Comb поочередно запускаются все три экземпляра входящие в список, каждому из которых передается сообщение.

Давайте теперь начнем поочередно отключать делегатов, вызывая затем Comb с новыми сообщениями:

Comb = (MesToPers)Delegate.Remove(Comb,Combination.Policeman);
//Такое возможно: попытка отключить не существующий элемент
Comb = (MesToPers)Delegate.Remove(Comb,Combination.Policeman);
Comb("Через 30 минут!");
Comb = (MesToPers)Delegate.Remove(Comb,Combination.Ambulanceman);
Comb("Через час!");
Comb = (MesToPers)Delegate.Remove(Comb,Combination.Fireman);
//Comb("Через два часа!"); // Comb не определен

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

Покажем теперь, что ту же работу можно выполнить, используя не методы, а операции:

//операции + и -
			Comb = Combination.Ambulanceman;
			Console.WriteLine( Comb.Method.Name);
			Comb+= Combination.Fireman;
			Comb+= Combination.Policeman;
			Comb("День города!");
			Comb -= Combination.Ambulanceman;
			Comb -= Combination.Fireman;
			Comb("На следующий день!");
		}//TestSomeServices

Обратите внимание, здесь демонстрируется вызов свойства Method, возвращающее объект, свойство Name которого выводится на печать. Результаты, порожденные работой этой процедуры, изображены на рис. 20.6.

Пример "Плохая служба"

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

Добавим в класс Combination "плохого" кандидата, который пытается делить на ноль:

//метод, вызывающий исключительную ситуацию
public static void BadService(string mes)
{
	int i =7, j=5, k=0;
	Console.WriteLine("Bad Service: Zero Divide");
	j=i/k;
}

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

public void TestBadJob()
{
	MesToPers Comb;
	Comb = (MesToPers)Delegate.Combine(Combination.Ambulanceman,
		Combination.Policeman);
	Comb = (MesToPers)Delegate.Combine(Comb,
		new MesToPers(Combination.BadService));
	Comb = (MesToPers)Delegate.Combine(Comb,Combination.Fireman);
	foreach(MesToPers currentJob in Comb.GetInvocationList())
	{
		try
		{
			currentJob("Пожар!");
		}
		catch(Exception e)
		{
			Console.WriteLine(e.Message);
			Console.WriteLine(currentJob.Method.Name);
		}
	}
}//BadJob

Поясню, как будет работать эта процедура при ее вызове. Вначале две службы нормально отработают, но при вызове третьей службы возникнет исключительная ситуация "деление на ноль". Универсальный обработчик Exception перехватит эту ситуацию и напечатает как свойство Message объекта e, так и имя метода, вызвавшего исключительную ситуацию, используя свойство Method объекта, вызвавшего ситуацию. После завершения работы блока обработчика ситуации выполнение программы продолжится, выполнится следующий шаг цикла, и служба пожарных благополучно выполнит свою работу. Вот результаты вывода:

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