WCF - DataContract와 KnownType 특성
일단, 오늘의 주제인 KnownType 특성을 설명하기에 앞서 기존 웹 서비스에서 비슷한 기능을 제공하는 XmlInclude 특성을 먼저 설명해보겠습니다.
경험으로 볼때, 웹 서비스에서 XmlInclude 특성이 필요한 경우가 다음과 같이 크게 2가지 정도가 있었던 것 같습니다.
- 상속받은 데이터 컨테이너의 기반 클래스를 사용할 때.
- object 형의 속성을 포함하는 경우.
역시 코드로 설명하는 것이 더 낫겠지요? ^^
첫 번째 경우에 대한 코드 유형은 대강 다음과 같은 식입니다.
// 서버 측 코드
public class BaseClassT
{
public string Name;
}
public class MyClassT : BaseClassT
{
public int My;
}
public class YourClassT : BaseClassT
{
public int Your;
}
[WebMethod]
public BaseClassT GetData()
{
MyClassT myData = new MyClassT();
myData.Name = "myData";
myData.My = 1;
return myData;
}
// 클라이언트 측 코드
localhost.Service clnt = new localhost.Service();
localhost.BaseClassT data = clnt.GetData();
위와 같은 경우에, 일반적으로 MyClassT와 YourClassT는 WSDL 문서에 나오지 않게 되어 클라이언트 측에서는 해당 데이터 컨테이너를 사용할 수가 없습니다. 이 때문에 웹 메서드가 반환하는 Soap 패킷에는 "xsi:type=MyClassT"가 명시되지만 클라이언트 .NET 실행 모듈에서는 MyClassT 데이터 컨테이너 형을 찾을 수 없어서 예외가 발생하게 됩니다.
이러한 문제를 해결하기 위해서는 다음과 같이 스텁 메서드를 만들어 두는 식으로 해결할 수도 있지만,
[WebMethod] public MyClassT GetData_MyClassT() { return new MyClassT(); }
[WebMethod] public YourClassT GetData_YourClassT() { return new YourClassT(); }
다음과 같이 XmlInclude를 BaseClassT에 지정하는 것으로 해결해 줄 수도 있습니다.
[XmlInclude(typeof(MyClassT))]
[XmlInclude(typeof(YourClassT))]
public class BaseClassT
{
public string Name;
}
두 번째 예로, object 형을 포함하는 경우는 다음과 같은 식입니다.
public class BaseClassT
{
public string Name;
public object Anyone;
}
public class MyClassT
{
public int My;
}
public class YourClassT
{
public int Your;
}
[WebMethod]
public BaseClassT GetData()
{
BaseClassT data = new BaseClassT();
data.Anyone = new MyClassT();
data.Name = "test";
return data;
}
역시 이런 경우에도, 클라이언트 측에 내려가는 SOAP 응답 패킷에는 xsi:type="MyClassT"인 타입이 명시되어 내려가지만 해당 타입을 찾을 수가 없어 "System.Web.Services.Protocols.SoapException" 예외가 발생하게 됩니다.
해결 방법도 첫 번째 경우와 마찬가지입니다. MyClassT, YourClassT를 클라이언트 측에 내려주도록 더미 웹 메서드를 만들던가, XmlInclude 특성을 BaseClassT에 적용시켜 주면 됩니다.
자... 이제 VS.NET 2008 + WCF의 시대가 다가왔습니다. WCF에서는 XmlSerializer뿐만 아니라 DataContract / NetDataContract 직렬화도 지원하고 있습니다. 게다가 VS.NET 2008 통합환경에서는 이전보다 더 편리하게 데이터 컨테이너를 재활용해주는 방법도 제공해 주고 있습니다. 이에 대해서는 다음의 토픽을 참고하십시오.
Serialization in Windows Communication Foundation
- 3가지 직렬화 방식에 대한 설명
; https://docs.microsoft.com/en-us/archive/msdn-magazine/2006/august/service-station-serialization-in-windows-communication-foundation
VS.NET 2008 - 서비스 참조 시 기존 데이터 컨테이너 DLL 사용
; https://www.sysnet.pe.kr/2/0/523
비교를 위해서 위에서 설명했던 예제 코드와 유사하게 WCF로 다뤄보도록 하겠습니다.
// 서버 측 코드
public class BaseClassT
{
public string Name;
}
public class MyClassT : BaseClassT
{
public int My;
}
public class YourClassT : BaseClassT
{
public int Your;
}
[XmlSerializerFormat]
[ServiceContract]
public interface IService1
{
[OperationContract]
BaseClassT GetData();
}
[ServiceBehavior]
public class Service1 : IService1
{
public BaseClassT GetData()
{
MyClassT myData = new MyClassT();
myData.Name = "myData";
myData.My = 1;
return myData;
}
}
// 클라이언트 측 코드
Service1Client svc = new Service1Client("WSHttpBinding_IService1");
svc.Open();
BaseClassT myClass = svc.GetData();
이 프로그램을 실행해 보면, 웹 서비스 예제에서와 같이, WCF + XmlSerializerFormat에서도 동일하게 GetData 메서드 호출 부분에서 예외가 발생합니다. 아쉽게도, 아래에서 보는 것처럼 예외 메시지는 그다지 분명하지 않습니다.
System.ServiceModel.CommunicationException was caught
Message="An error occurred while receiving the HTTP response to http://localhost:13000/Service1.
This could be due to the service endpoint binding not using the HTTP protocol.
This could also be due to an HTTP request context being aborted by the server (possibly due to the service shutting down).
See server logs for more details."
[... 이하 생략 ...]
해결 방법도 같습니다. MyClassT 타입을 반환하는 더미 Operation을 추가하든가, XmlInclude 특성을 BaseClassT에 적용시켜 주면 됩니다.
그렇다면, 위의 WCF 서비스를 XmlSerializer가 아닌 DataContract를 쓰면 어떻게 될까요? 이를 위해 XmlSerializerFormat 특성을 제거하고, BaseClassT/MyClassT 등에는 "Serializable" 특성을 적용시켜 주면 됩니다. 대강 다음과 같이 소스 코드를 수정해 줄 수 있습니다. (물론, Serializable 특성이 아닌, 명시적으로 DataContract/DataMember 특성을 적용시킬 수도 있습니다.)
// 서버 측 코드
[Serializable]
public class BaseClassT
{
public string Name;
}
[Serializable]
public class MyClassT : BaseClassT
{
public int My;
}
[Serializable]
public class YourClassT : BaseClassT
{
public int Your;
}
[ServiceContract]
public interface IService1
{
[OperationContract]
BaseClassT GetData();
}
[ServiceBehavior]
public class Service1 : IService1
{
public BaseClassT GetData()
{
MyClassT myData = new MyClassT();
myData.Name = "myData";
myData.My = 1;
return myData;
}
}
// 클라이언트 측 코드
Service1Client svc = new Service1Client("WSHttpBinding_IService1");
svc.Open();
BaseClassT myClass = svc.GetData();
이번에는 좀 특이합니다. 이전 XmlSerializer와는 달리, BaseClassT/MyClassT에 대한 더미 Opeartion을 정의해도 예외가 발생합니다. 해결하는 방법은 단 하나, BaseClassT에 MyClassT와 YourClassT에 대한 정보를 다음과 같이 KnownType 특성을 이용해서 명시적으로 알려주어야 합니다.
[Serializable]
[KnownType(typeof(MyClassT))]
[KnownType(typeof(YourClassT))]
public class BaseClassT
{
public string Name;
}
어느새, 여기까지 해서 KnownType에 대한 설명은 완료된 것 같습니다.
참고로, KnownType 특성은 .NET Framework 3.0에서 제공되는 "System.Runtime.Serialization" 어셈블리에 있으므로, 명시적으로 그에 대해 참조를 추가해 주어야 합니다.
[이 토픽에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]