WCF - PerSession에서의 클라이언트 연결 관리
일단, 오늘의 주제는 아마도 많은 분들이 관심있으신 사항이었을 거라 봅니다. PerCall 모드에서야 별로 관심 없을 사항이겠지만, PerSession에서는 클라이언트 연결 관리가 꽤나 중요한 요구 사항으로 대두됩니다. 일례로, PerSession에서 "Callback"을 쓰려고 해도 현재 제대로 연결된 클라이언트를 알아야만 효율적인 콜백 호출을 할 수가 있기 때문입니다.
어디... 코드와 함께 조금씩 문제를 파헤쳐 볼까요? ^^
대개의 경우, WCF (세션 가능한) 서비스 코드는 다음과 같은 구조를 이룹니다.
///// 서버 측 코드 //////
[ServiceContract(SessionMode = SessionMode.Required)]
public interface IService1
{
[OperationContract]
void StarDust();
}
[ServiceBehavior(InstanceContextMode=InstanceContextMode.PerSession)]
public class Service1 : IService1
{
public void StarDust()
{
}
}
클라이언트는, 다음과 같이 인스턴스 변수로 관리를 할 테지요!
Service1Client svc;
private void Form1_Load(object sender, EventArgs e)
{
svc = new Service1Client("NetTcpBinding_IService1");
}
private void Form1_Close(object sender, EventArgs e)
{
svc.Close();
}
뭐... 대충, 위와 같은 선에서 서비스가 제작될 것입니다. 여기까지는 별다른 이상이 없어 보입니다. 하지만, 여기서 콜백이 들어가면 상황이 달라집니다.
우선, 서버 측 코드는 다음과 같이 바뀔 테고.
// 콜백 인터페이스
public interface IMyServiceCallback
{
[OperationContract(IsOneWay = true)]
void FallingStar();
}
// 콜백 인터페이스를 지정
[ServiceContract( SessionMode = SessionMode.Required, CallbackContract=typeof(IMyServiceCallback))]
public interface IService1
{
[OperationContract]
void StarDust();
}
// 콜백을 추가
[ServiceBehavior(InstanceContextMode=InstanceContextMode.PerSession)]
public class Service1 : IService1, IDisposable
{
static Dictionary<string, IMyServiceCallback> callbacks
= new Dictionary<string, IMyServiceCallback>();
public void StarDust()
{
string id = OperationContext.Current.SessionId;
IMyServiceCallback callback = OperationContext.Current.GetCallbackChannel<IMyServiceCallback>();
if (Service1.callbacks.ContainsKey(id) == false)
{
// 새로 연결된 세션의 콜백을 추가
Service1.callbacks.Add(id, callback);
}
}
}
클라이언트 측에서는 콜백 인터페이스 구현 및 관련 메서드를 호출하도록 구성합니다.
public partial class Form1 : Form
, IService1Callback
// 프록시 코드 생성 시, 서버 측의 IMyServiceCallback 이름이
// [서비스 이름] + "Callback" 형태로 바뀝니다.
{
Service1Client svc;
private void Form1_Load(object sender, EventArgs e)
{
InstanceContext instance = new InstanceContext(this);
svc = new Service1Client(instance, "NetTcpBinding_IService1");
try
{
svc.Open();
svc.StarDust();
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
}
}
public void FallingStar()
{
Debug.WriteLine("To Become an woman.");
}
서비스 측 코드를 보시면, ... 뭔가 이상한 것을 발견할 수 있습니다. 서버 측의 콜백 관리가 Add만 있을 뿐, Remove가 없습니다. ^^;
그렇습니다. 문제는, 해당 콜백의 remove를 언제 하느냐는 것입니다.
개인적으로, 이 부분에 고민을 하면서 ... 예상했던 것과는 달리 그와 관련된 자료가 거의 없다는 것을 알았습니다. 어떤 토픽을 읽어보니, 콜백 함수 호출 시에 명시적으로 오류가 발생하면, 그것을 연결이 끊겼다고 판단하고 콜백에서 지우는 것을 보았습니다.... 음... ^^; 언뜻 봐도 그것은 비이성적인 방법이라고 밖에는 볼 수 없습니다.
그러다가, 아래의 토픽에서 좀 더 나은 방법을 발견했습니다.
2006년 12월호 닷넷 칼럼 :: WCF Instance Management
; http://www.simpleisbest.net/articles/1731.aspx
위의 토픽에는, 아래와 같이 아주 "기본"적인 내용의 해결책이 담겨져 있었습니다. (역시, 기본에 충실해야 합니다. ^^)
[ServiceBehavior(InstanceContextMode = InstanceContextMode.PerSession)]
public class PerSessionService : IEchoService, IDisposable
{
private int _CallCount = 0;
public PerSessionService()
{
Console.WriteLine("PerSessionService Created...");
}
public void Dispose()
{
Console.WriteLine("PerSessionService Disposing...");
}
}
처음엔, 위의 코드를 발견하고 굉장히 ^^ 좋아했습니다. 하지만, 조금 있다가 이것도 뭔가 부족하다는 것을 알게 되었습니다. 예를 들어, 현재의 연결이 "비정상 종료"인지, Close를 통한 정상적인 종료인지를 알 방법이 없다는 것입니다. 또는 현재 Dispose가 실행되는 연결 상태의 정보를 알 수가 없다는 것입니다. (물론, 적절한 인스턴스 변수를 보관해 두면 가능하지만.)
그래도 왠지... ^^ 이거 말고 다른 방법이 없을까... 하는 의문이 들었습니다.
검색을 제법 하다가,,, 드디어 그럴싸한 방법을 하나 발견했습니다.
Recover from Abort on ServiceChannel
; http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=1667130&SiteID=1
와... ^^ 꼭꼭 숨겨져 있는 기능을 찾은 기분입니다.
방법은, 간단합니다. OperationContext.Current.Channel.Faulted 이벤트와 OperationContext.Current.Channel.Closed 이벤트를 이용하는 것입니다. 이를 이용해서 서비스 측 코드를 다음과 같이 개선할 수 있습니다. (가만히 생각해 보면, 이것 역시 기본에 충실했으면 자연스럽게 알 수 있었을 내용이죠!)
public void StarDust()
{
IMyServiceCallback callback = OperationContext.Current.GetCallbackChannel<IMyServiceCallback>();
string id = OperationContext.Current.SessionId;
OperationContext.Current.Channel.Faulted += new EventHandler(Channel_Faulted);
OperationContext.Current.Channel.Closed += new EventHandler(Channel_Closed);
lock (Service1.callbacks)
{
if (Service1.callbacks.ContainsKey(id) == false)
{
Service1.callbacks.Add(id, callback);
}
}
}
void Channel_Closed(object sender, EventArgs e)
{
UnregistCallback(sender as IClientChannel, true);
}
void Channel_Faulted(object sender, EventArgs e)
{
UnregistCallback(sender as IClientChannel, false);
}
void UnregistCallback(IClientChannel channel, bool closedGracefully)
{
string txt = channel.SessionId;
lock (Service1.callbacks)
{
if (Service1.callbacks.ContainsKey(txt) == true)
{
Service1.callbacks.Remove(txt);
Console.WriteLine(txt + " : removed");
}
}
}
아쉽게도, Faulted/Closed 이벤트 핸들러에서의 OperationContext.Current는 null 값이지만, sender 값을 형변환해서 channel 정보를 받을 수 있기 때문에 해당 세션에 대한 다양한 정보를 구할 수가 있습니다. 또한, 비정상 종료를 하는 클라이언트 연결 개체까지도 모니터링 할 수 있기 때문에 경우에 따라서 클라이언트 측의 연결 중에 정상적으로 Close로 닫히지 않는 경우도 알아낼 수 있습니다.
참고로, 순서상으로 보면, Dispose 메서드가 먼저 실행되고 Closed/Faulted 이벤트 핸들러가 실행이 됩니다.
뭐... 이 정도면 되겠지요! ^^
[이 토픽에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]