public event AssociatedDelegate ИмяСобытия;
…
}
События типа Car будут иметь те же имена, что и предыдущие делегаты (AboutToBlow и Exploded). Новому делегату, с которым будут ассоциироваться события, будет назначено имя CarEventHandler. Вот начальные изменения, вносимые в определение типа Car.
public class Car {
// Этот делегат работает в связке с событиями Car
public delegate void CarEventHandler(string msg);
// Объект Car может посылать эти события.
public event CarEventHandler Exploded;
public event CarEventHandler AboutToBlow;
…
}
Отправка событий вызывающей стороне выполняется с помощью простого указания имени события и всех обязательных параметров, предусмотренных в определении соответствующего делегата. Вы должны проверить событие на значение null перед тем, как вызывать набор методов делегата, чтобы гарантировать регистрацию события вызывающей стороной. С учетом этого предлагается новый вариант метода Accelerate() для типа Car.
public void Accelerate(int delta) {
// Если машина сломана, генерируется событие Exploded.
if (carIsDead) {
if (Exploded!= null) Exploded("Извините, машина сломалась…");
} else {
currSpeed += delta;
// Вот-вот сломается?
if (10 == maxSpeed – currSpeed && AboutToBlow != null) {
AboutToBlow ("Осторожно! Могу сломаться!");
}
// Пока все OK!
if (currSpeed ›= maxSpeed) carIsDead = true;
else Console.WriteLine("-›CurrSpeed = {0}", currSpeed);
}
}
Мы наделили автомобиль способностью посылать два типа пользовательских событии, избавив себя от необходимости определять пользовательские функции регистрации. Немного позже мы приведем пример использования нашего нового автомобили, но сначала более подробно рассмотрим архитектуру событий.
Глубинный механизм событий
Событие в C# представляется двумя скрытыми общедоступными методами, один из которых имеет префикс add_, а другой – префикс remove_. За этими префиксами следует имя события. Например, событие Exploded транслируется в пару CIL-методов с именами add_Exploded() и remove_Exploded(). Кроме приведения к методам add_XXX() и remove_XXX(), определение события на уровне CIL связывает данное событие с соответствующим делегатом.
Взгляните на CIL-инструкции для add_AboutToBlow(), и вы обнаружите программный код, почти идентичный программному коду вспомогательного метода OnAboutToBlow() из рассмотренного выше примера CarDelegate (обратите внимание на строку с вызовом Delegate.Combine()).
.method public hidebysig specialname instance void add_AboutToBlow(class CarEvents.Car/CarEventHandler 'value') cil managed synchronized {
.maxstack 8
ldarg.0
ldarg.0
ldfld class CarEvents.Car/CarEventHandler CarEvents.Car::AboutToBlow
ldarg.1
call class [mscorlib]System.Delegate [mscorlib] System.Delegate::Combine(class [mscorlib]System.Delegate, class [mscorlib]System.Delegate)
castclass CarEvents.Car/CarEventHandler
stfld class CarEvents.Car/CarEventHandler
CarEvents.Car::AboutToBlow
ret
}
В соответствии с ожиданиями, метод remove_AboutToBlow() неявно (опосредованно) вызывает Delegate.Remove() и приблизительно соответствует определенному выше вспомогательному методу RemoveAboutToBlow().
.method public hidebysig specialname instance void remove_AboutToBlow(class CarEvents.Car/CarEventHandler 'value') cil managed synchronized {
.maxstack 8
ldarg.0
ldarg.0
ldfld class CarEvents.Car/CarEventHandler CarEvents.Car::AboutToBlow
ldarg.1
call class [mscorlib]System.Delegate [mscorlib]System.Delegate::Remove(class [mscorlib]System.Delegate, class [mscorlib]System.Delegate)
castclass CarEvents.Car/CarEventHandler
stfld class CarEvents.Car/CarEventHandler CarEvents.Car::AboutToBlow
ret
}
Наконец, программный код CIL, представляющий само событие, использует директивы .addon и .removeon для отображения имен в соответствующие имена вызываемых методов add_XXX() и remove_XXX().
.event CarEvents.Car/EngineHandler AboutToBlow {
.addon void CarEvents.Car::add_AboutToBlow(class CarEvents.Car/CarEngineHandler)
.removeon void CarEvents.Car::remove_AboutToBlow(class CarEvents.Car/CarEngineHandler)
}
Теперь, когда вы знаете, как строить классы, способные посылать события в C# (и знаете о том, что соответствующая событиям синтаксическая конструкция – это просто сокращение, позволяющее уменьшить объем вводимых с клавиатуры данных), мы должны выяснить, как осуществляется "прием" поступающих событий с точки зрения вызывающей стороны.
Прием поступающих событий
Использование событий в C# позволяет также упростить регистрацию обработчиков событий вызывающей стороны. Вместо необходимости указывать пользовательские вспомогательные методы, вызывающая сторона просто использует операции += и -= (которые в фоновом режиме "подключают" add_XXX() или remove_XXX()). Если вы хотите регистрировать событие, то следуйте показанному ниже шаблону.
// ОбъектнаяПеременная.ИмяСобытия +=
// new СоответствующийДелегат(вызываемаяФункция);
Car.EngineHandler d = new Car.EngineHandler(CarExplodedEventHandler) myCar.Exploded += d;
Чтобы отменить привязку к источнику событий, используйте операцию -=.
// ОбъектнаяПеременная.ИмяСобытия -= объектДелегата;
myCar.Exploded -= d;
С учетом этих соответствующих ожиданиям шаблонов, вот как должен выглядеть модифицированный метод Main(), в котором используется синтаксис регистрации событий C#.
class Program {
statiс vоid Main(string[] args) {
Console.WriteLine("***** События *****");
Car c1 = new Car("SlugBug", 100, 10);
// Регистрация обработчиков событий.
сl.AboutToBlow += new Car.CarEventHandler(CarIsAlmostDoomed);
cl.AboutToBlow += new Car.CarEventHandler(CarAbautToBlow);
Car.CarEventHandler d = new Car.CarEventHandler(CarExploded);
cl.Exploded += d;
Console.WriteLine("n***** Ускорение *****);
for(int i = 0; i ‹ 6; i++) cl.Accelerate(20);
// Удаление метода CarExploded из списка вызовов.
cl.Exploded -= d;
Console.WriteLine("n***** Ускорение *****");
for(int i = 0; i ‹ 6; i++) cl.Accelerate(20);
Console.ReadLine();
}
public static void CarAboutToBlow(string msg) { Console.WriteLine(msg); }
public static void CarIsAlmostDoomed(string msg) { Console.WriteLine("Critical Message from Car: {0}", msg); }
public static void CarExploded(string msg) { Console.WriteLine(msg); }
}
Исходный код. Проект CarEvents размещен в подкаталоге, соответствующем главе 8.
Упрощенная регистрация событий в Visual Studio 2005
В Visual Studio .NET 2003 и Visual Studio 2005 предлагается помощь в процессе регистрации обработчиков событий. При вводе += в окне программного кода появляется окно IntelliSense, предлагающее назвать клавишу ‹Tab›, чтобы автоматически ввести соответствующий экземпляр делегата (рис. 8.7).
Рис. 8.7. Выбор делегата IntelliSense
После нажатия клавиши ‹Tab› будет предложено ввести имя генерируемого обработчика события (или согласиться использовать имя, предлагаемое по умолчанию), как показано на рис. 8.8.
Рис. 8.8. Формат целевого объекта делегата IntelliSense
Если снова нажать клавишу ‹Tab›, вы получите программный код "заглушки" в нужном формате целевого объекта делегата (обратите внимание на то, что соответствующий метод объявляется статическим, поскольку событие было зарегистрировано с помощью статического метода).
static void cl_AboutToBlow(string msg) {
// Add your code!
}
Эта возможность IntelliSense доступна для всех событий .NET из библиотек базовых классов. Данная особенность интегрированной среды разработки позволяет разработчику существенно экономить время, поскольку избавляет от необходимости искать по справке .NET подходящие делегаты (и выяснять их форматы) для использования их с конкретными событиями.
"Разборчивые" события
Есть еще одно усовершенствование, которое можно внести в наш пример с CarEvents и которое соответствует шаблону событий, рекомендуемому разработчиками из Microsoft. При исследовании событий, посылаемых данным типом из библиотек базовых классов, вы обнаружите, что первым параметром соответствующего делегата является System.Object, а вторым – тип, производный от System.EventArgs.
Аргумент System.Object представляет ссылку на объект, посылающий событие (такой как, например, Car), а второй параметр представляет информацию о соответствующем событии. Базовый класс System.EventArgs представляет событие и не передает никакой пользовательской информации.
public class EventArgs {
public static readonly System.EventArgs Empty;
public EventArgs();
}
Для простых событий вы можете просто передать экземпляр EventArgs. Но если вы хотите передать и пользовательские данные, вы должны построить подходящий класс, производный от EventArgs. Для нашего примера мы предположим, что у нас есть класс CarEventArgs, который содержит строку с сообщением, отправляемым получателю.
