방법: .NET Framework 지침을 따르는 이벤트 게시(C# 프로그래밍 가이드)
업데이트: 2007년 11월
다음 절차에서는 사용자의 클래스와 구조체에 표준 .NET Framework 패턴을 따르는 이벤트를 추가하는 방법을 보여 줍니다. .NET Framework 클래스 라이브러리의 모든 이벤트는 다음과 같이 정의된 EventHandler 대리자를 기반으로 합니다.
public delegate void EventHandler(object sender, EventArgs e);
.gif "참고") 참고: |
|---|
.NET Framework 2.0에서는 이 대리자의 제네릭 버전인 EventHandler<TEventArgs>이 도입되었습니다. 다음 예제에서는 두 버전을 모두 사용하는 방법을 보여 줍니다. |
클래스의 이벤트를 정의할 때 값을 반환하는 대리자까지 포함하여 모든 올바른 대리자 형식을 기반으로 할 수 있지만 일반적으로는 다음 예제와 같이 EventHandler를 사용하여 .NET Framework 패턴을 기반으로 이벤트를 정의하는 것이 좋습니다.
EventHandler 패턴을 기반으로 하는 이벤트를 게시하려면
이벤트를 사용하여 사용자 지정 데이터를 보낼 필요가 없는 경우에는 이 단계를 건너뛰고 3a단계로 이동합니다. 게시자 클래스와 구독자 클래스 모두에 표시되는 범위에서 클래스를 선언하고 사용자 지정 이벤트 데이터를 보관하는 데 필요한 멤버를 추가합니다. 이 예제에서는 간단한 문자열이 반환됩니다.
public class CustomEventArgs : EventArgs { public CustomEventArgs(string s) { msg = s; } private string msg; public string Message { get { return msg; } } }제네릭 버전의 EventHandler<TEventArgs>을 사용하는 경우 이 단계를 건너뜁니다. 게시 클래스에서 대리자를 선언합니다. 대리자에 EventHandler로 끝나는 이름을 지정합니다. 두 번째 매개 변수는 사용자 지정 EventArgs 형식을 지정합니다.
public delegate void CustomEventHandler(object sender, CustomEventArgs a);다음 단계 중 하나를 사용하여 게시 클래스에 이벤트를 선언합니다.
사용자 지정 EventArgs 클래스가 없으면 이벤트 형식은 제네릭이 아닌 EventHandler 대리자가 됩니다. C# 프로젝트에 포함된 System 네임스페이스에는 이벤트 형식이 이미 선언되어 있으므로 이벤트 형식을 선언할 필요가 없습니다.
public event EventHandler RaiseCustomEvent;제네릭이 아닌 버전의 EventHandler를 사용하고 있고 EventArgs에서 파생된 사용자 지정 클래스가 있는 경우에는 게시 클래스 내에서 이벤트를 선언하고 대리자를 다음 형식으로 사용합니다.
class Publisher { public event CustomEventHandler RaiseCustomEvent; }제네릭 버전을 사용하는 경우에는 사용자 지정 대리자가 필요하지 않습니다. 대신 꺾쇠괄호 사이에서 사용자의 클래스 이름을 대체하여 이벤트 형식을 EventHandler<CustomEventArgs>로 지정합니다.
public event EventHandler<CustomEventArgs> RaiseCustomEvent;
예제
다음 예제에서는 사용자 지정 EventArgs 클래스를 사용하고 이벤트 형식으로 EventHandler<TEventArgs>을 사용하여 앞에서 설명한 단계를 보여 줍니다.
namespace DotNetEvents
{
using System;
using System.Collections.Generic;
// Define a class to hold custom event info
public class CustomEventArgs : EventArgs
{
public CustomEventArgs(string s)
{
message = s;
}
private string message;
public string Message
{
get { return message; }
set { message = value; }
}
}
// Class that publishes an event
class Publisher
{
// Declare the event using EventHandler<T>
public event EventHandler<CustomEventArgs> RaiseCustomEvent;
public void DoSomething()
{
// Write some code that does something useful here
// then raise the event. You can also raise an event
// before you execute a block of code.
OnRaiseCustomEvent(new CustomEventArgs("Did something"));
}
// Wrap event invocations inside a protected virtual method
// to allow derived classes to override the event invocation behavior
protected virtual void OnRaiseCustomEvent(CustomEventArgs e)
{
// Make a temporary copy of the event to avoid possibility of
// a race condition if the last subscriber unsubscribes
// immediately after the null check and before the event is raised.
EventHandler<CustomEventArgs> handler = RaiseCustomEvent;
// Event will be null if there are no subscribers
if (handler != null)
{
// Format the string to send inside the CustomEventArgs parameter
e.Message += String.Format(" at {0}", DateTime.Now.ToString());
// Use the () operator to raise the event.
handler(this, e);
}
}
}
//Class that subscribes to an event
class Subscriber
{
private string id;
public Subscriber(string ID, Publisher pub)
{
id = ID;
// Subscribe to the event using C# 2.0 syntax
pub.RaiseCustomEvent += HandleCustomEvent;
}
// Define what actions to take when the event is raised.
void HandleCustomEvent(object sender, CustomEventArgs e)
{
Console.WriteLine(id + " received this message: {0}", e.Message);
}
}
class Program
{
static void Main(string[] args)
{
Publisher pub = new Publisher();
Subscriber sub1 = new Subscriber("sub1", pub);
Subscriber sub2 = new Subscriber("sub2", pub);
// Call the method that raises the event.
pub.DoSomething();
// Keep the console window open
Console.WriteLine("Press Enter to close this window.");
Console.ReadLine();
}
}
}