[C# Async]Event-based Asynchronous Pattern - EAP(3) Async #5

C# Event-based Asynchronous Pattern - EAP(3)

이벤트 기반 비동기 프로그래밍 패턴

http://msdn.microsoft.com/en-us/library/ms228969.aspx

http://msdn.microsoft.com/ko-kr/library/ms228969.aspx

지난 포스트

2013/02/25 - [.Net Framework] - [Async]Event-based Asynchronous Pattern - EAP(2) Async #4

2013/02/21 - [.Net Framework] - [Async]Event-based Asynchronous Pattern - EAP(1) Async #3

2013/02/21 - [.Net Framework] - [Async]Asynchronous Programming Model - APM Async #2

2013/02/18 - [.Net Framework] - [Async] Asynchronous Programming Patterns - Async #1

 지난 포스트에서 EAP 라이브러리 만들기가 길어져서 중간 단계까지만 진행되었다. 이번에는 그 다음을 잰행해 보도록 하자. 

 이번 부터는 이전에 얘기 했던 delegate와 event를 가지고 Event를 발생시키는 클래스를 추가해야 한다. 이벤트 지향 프로그램은 UI가 있는 Platform에서 사용하기 쉽도록 하기 위해 Visual Basic에서 부터 도입이 된 방식이며 확장성 및 필터 개념처럼 수행되어 실행중에 이벤트를 이용해서 본래 데이터를 변경 및 추가 작업이 용이하게 할 수 있도록 지원한다. ASP.NET, Window, WPF의 기본 이벤트에서 "Loaded" 메소드가 있는 것을 알 수 있을 것이다. 이 메소드 또한 이벤트 방식으로 실행이 되며 우리는 이 이벤트에서 사용할 변수 초기화 또는 별도의 로직을 수행하는 코드를 작성하여 개발 한다. 이와 같이 현재는 이벤트 기반 개발 방식이 많은 Platform(ASP.NET, ASP.Net MVC, WinForm, WPF, Silverlight, ...)에서 사용되고 있는 방식이다.

 이제는 사용자 정의 event를 만드는 방법에 대해 간략하게 알아 보도록 하겠다. event는 delegate를 통해서 만들수 있으며 event를 코드에서 다시 선언 및 호출하여 사용자 정의 이벤트를 발생시킬 수 있다.

//delegate를 통해 입력 파라메터를 선언한다.
private delegate void ObjectCompletedEventHandler(object sender, AsyncCompletedEventArgs args);
//선언된 delegate를 통해 event를 선언한다.
private event ObjectCompletedEventHandler Completed;

[코드 1] delegate오 event 선언

"코드1"에서와 같이 선언하면 해당 클래스에서 "코드2"에서와 같이 사용할 수 있다.

//OnCompleted가 다른 곳에서 subscription되었는지 파악한다.
//subscription하는 방법은 "OnCompleted += ThinkingAsyncEAP_OnCompleted;" 이다.
if (Completed != null)
{
    //사용자 정의 이벤트일때 해당 파라메터를 세팅한다.
    //.Net에서 기본적으로 제공하는 파라메터이다.
    var args = new AsyncCompletedEventArgs(null, false, null);
    //Completed를 실행하면 연결된 이벤트 핸들러로 제어권이 넘어 간다.
    Completed(this, args);
}

[코드2] 사용자 정의 event 발생 시키기

 Completed의 선언된 이벤트는 Completed(this, args)와 같이 선언된 형식으로 호출 함으로써 발생 시킬 수 있으며 이벤트 변수는 꼭 null 체크를 해야 한다. 이벤트 객체는 클래스 외부에서 사용하도록 노출 시켜주는 특별한 delegate다. 그래서 해당 이벤트를 Subscription으로 등록하지 않으면 에러가 발생한다. 아래 "코드3"은 추가된 코드를 포함 한 전체 소스 코드이다.

/// <summary>
/// 생각하는 비동기 클래스 EAP
/// </summary>
/// <remarks>
/// EAP로 개발하기 준비 단계
/// 클래스 내부에서는 APM 형식으로 비동기를 수행하고
/// 클래스 외부에서는 Event 형식으로 수행이 되도록 지원해야 한다.
/// 현재 코드는 아직 Event를 연결하지 않고 비동기 수행이 되는지 여부만 구현 하였다.
/// </remarks>
public class ThinkingAsyncEAP
{
    //delegate를 통해 입력 파라메터를 선언한다.
    public delegate void ObjectCompletedEventHandler(object sender, AsyncCompletedEventArgs args);
    //선언된 delegate를 통해 event를 선언한다.
    public event ObjectCompletedEventHandler Completed;
 
    /// <summary>
    /// 비동기 수행 시작하기
    /// </summary>
    /// <param name="action">action, delegate parameter</param>
    /// <returns></returns>
    public IAsyncResult StartAsync(Action action)
    {
        //APM 형식처럼 비동기로 실행 한다.
        //delegate의 BeginInvoke와 동일 한다.
        var asyncHandlerPointer = action.BeginInvoke(new AsyncCallback(AsyncCompleted), action);
 
        //IAsyncResult를 반환 한다.
        //APM에서 사용하던 기존 코드와의 호환성을 유지하기 위해 반환한다.
        //호환성 유지가 필요 없으면 반환하지 않고 메소드를 void 형식으로 선언하면 된다.
        return asyncHandlerPointer;
    }
 
    /// <summary>
    /// 비동기 수행 종료하기
    /// </summary>
    /// <param name="result">IAsyncResult</param>
    public void AsyncCompleted(IAsyncResult result)
    {
        //Action action = (Action)result.AsyncState;
        //action.EndInvoke(result);
        ManualResetEvent manualResetEvent = (ManualResetEvent)result.AsyncWaitHandle;
 
        //OnCompleted가 다른 곳에서 subscription되었는지 파악한다.
        //subscription하는 방법은 "OnCompleted += ThinkingAsyncEAP_OnCompleted;" 이다.
        if (Completed != null)
        {
            //사용자 정의 이벤트일때 해당 파라메터를 세팅한다.
            //.Net에서 기본적으로 제공하는 파라메터이다.
            var args = new AsyncCompletedEventArgs(null, false, null);
            //Completed를 실행하면 연결된 이벤트 핸들러로 제어권이 넘어 간다.
            Completed(this, args);
        }
        manualResetEvent.Set(); //위치 변경
    }
}

[코드3] ThinkingAsyncEAP 업데이트 된 소스 코드

 "코드3"에서 음영 표시된이 이전코드에서 갱신된 코드다. 비 동기 수행이 완료가 되었을 때 클래스 외부로 사용자 정의 이벤트를 노출 시켜주는 기능을 추가 하였다. 이제 수정된 코드를 사용하는 법을 테스트 코드를 통해서 알아 보도록 하자.

/// <summary>
/// 이벤트 기반 비동기 테스트
/// </summary>
[TestMethod]
public void Thinking_Event_Base_EAP_ASync_UnitTest()
{
    //Arrange step
    //테스트 확인용 변수
    int tempI = 0, tempJ = 100;
 
    //Act step
    ThinkingAsyncEAP thinkingAsync = new ThinkingAsyncEAP();
    //비 동기 수행 완료가 되었을 때 호출 할 이벤트
    thinkingAsync.Completed += thinkingAsync_Completed;
    var result = thinkingAsync.StartAsync(() =>
    {
        for (int i = 1; i <= 100; i++)
        {
            //50 밀리초씩 생각 한다.
            Thread.Sleep(50);
            Debug.WriteLine(i);
            tempI = i;
        }
    });
 
    //테스트를 확인하기 위해 비동기가 완료 할 때까지 대기. IAsyncResult를 리턴하도록 APM 환되도록 하여 사용할 수 있는 방안이다.
    result.AsyncWaitHandle.WaitOne();
 
    //Assert step
    //값이 맞는지 테스트
    Assert.AreEqual(tempI, tempJ);
}
 
void thinkingAsync_Completed(object sender, AsyncCompletedEventArgs args)
{
    //비 동기 수행이 완료가 되었습니다.
 
}

[코드4] 이벤트 기반 비동기 수행 테스트 코드

 "코드4" 추가된 이벤트 기능을 이용해 테스트를 하는 코드이며 thinkingAync.Completed += handlerMethod를 통해 완료할 때 실행될 핸들러를 등록 하였다. 수행 후 완료가 되면 해당 메소드를 실행하고 완료가 된다. 테스트 메소드에서의 코딩은 하나의 메소드에서 실행 및 테스트를 하기 위해 위와 같이 WaitOne() 메소드를 하출 하도록 하였지만 실제 코딩에서는 Completed 핸들러 메소드에서만 실행이 되도록 하면 되겠다.

 이번에도 코드가 너무 길어 지고 장황스럽게 되어 다음 포스트에서 이어 가도록 하겠다.