.NET 4 WCF를 이용하여 REST 컴포넌트 개발하기

WCF 4.0으로 REST 서비스 구현하기

윈도폰 7 스터디 하다가, 다음 단계로 서버와 연결하려는 걸 하려고 생각하다 보니, REST 컴포넌트가 필요해서 어찌어찌하다가 .NET으로 REST 컴포넌트 를 구현해봤는데, 자바쪽에서 JAX-RS (Jersey)로 구현해봤던 경험때문인지 약 2일 정도만에 상당히 완성도 있는 REST 컴포넌트를 구현해낼 수 있었다.

REST의 개념과 디자인 방법에 대해서는 다른 문서를 참고하고. .NET에서 REST 구현 방법에 대해서 알아보도록 하자

기본 REST 서비스 구현

만들고자 하는 애플리케이션은 간단하다. 이메일을 KEY로하고, 이름과 전화번호를 저장하는 REST서비스를 만들것이다.

Visual Studio 2010에서는 WCF(Windows Communication Framework) 4.0 기반의 REST 구현 템플릿이 추가되었다.
New > Project에서 Visual C# 선택한 후 Web > WCF REST Service Application을 선택한다.

자동으로 만들어진 SampleItem 클래스는 Refactor해서 CotactVo로 이름을 변경한다. 파일명도 ContactVo.cs로 변경한다.

ContactVo.cs의 내용은 다음과 같다.

    [DataContract(Name="Contact")]
    public class ContactVo
    {

        public ContactVo(string email, string name, string phone)
        {
            this.email = email;
            this.name = name;
            this.phone = phone;
        }

        [DataMember(Order=2)]
        public string name { get; set; }

        [DataMember(Order = 1)]
        public string email { get; set; }

        [DataMember(Order = 3)]
        public string phone { get; set; }
    }

이 ValueObject가 나중에 REST 서비스에서 데이터 객체로 사용되기 때문에 명시적으로 [DataContract]라고 정의해준다. XML이나 JSON으로 변환될(Serialize될) 데이터는 명시적으로[DataMember] 로 정의해준다. 각 데이터 멤버는 디폴트로 변수명이 XML 엘리먼트명이 되며, Class명 역시 이 ValueObject의 디폴트 엘리먼트명이 된다. ValueObjet이 XML로 변환되었을 때 XML 엘리먼트명은 [DataContract]에서 Name이라는 속성으로 지정할 수 있다. 이 ValueObject는XML로 변환되면 다음과 같은 모양이 된다.

<Contact xmlns="http://schemas.datacontract.org/2004/07/WcfRestService">
  <email>String content</email>
  <name>String content</name>
  <phone>String content</phone>
</Contact>

Service1 클래스도 Refactor를 통해서 클래스명을 ContactService로 변경하고 파일명도 ContactService.cs로 변경한다.

ContactVo 데이터를 관리하기 위해서 가상의 DAO를 만든다. 이 DAO에서는 간단하게 데이터를 메모리 상에서 관리한다. 만약에 데이터베이스에 저장하고 싶으면 이 DAO를 나중에 ADO와 연결 시켜서 구현하면 된다 (편의상 인터페이스를 이용한 설계 등등등은 뺏으니 태클 걸지 마시기를.) Add > Class 선택 후, ContactDao 클래스를 생성하고 ContactDao.cs에 저장한다.

ContactDao.cs의 내용은 다음과 같다. (간단하게 Dictionary에 email을 Key로 ContactVo를 CRUD하는 구조이다.)

    public class ContactDao
    {

        static Dictionary<string, ContactVo> contacts = new Dictionary<string, ContactVo>(); 

        public void add(string email, ContactVo contact)
        {
            contacts.Add(email, contact);
        }

        public void update(string email, ContactVo contact)
        {
            contacts[email] = contact;
        }

        public ContactVo get(string email)
        {
            return contacts[email];
        }

        public void remove(String email)
        {
            contacts.Remove(email);
        }

        public List<ContactVo> getList()
        {
            return new List<ContactVo>(contacts.Values);
        }

    }

다음으로 ContactService 클래스를 통해서 CREATE,DELETE,UPDATE,READ 를 구현한다. 단순하게 인자를 받은 후에 DAO를 통해서 데이터를 저장 ,쿼리 한다.

       [WebInvoke(UriTemplate = "", Method = "POST")]
        public void Create(ContactVo instance)
        {
            dao.add(instance.email, instance);
        }

        [WebGet(UriTemplate = "{email}")]
        public ContactVo Get(string email)
        {
            return dao.get(email);
        }

        [WebInvoke(UriTemplate = "{email}", Method = "PUT")]
        public void Update(string email, ContactVo instance)
        {
            dao.update(email, instance);
        }

        [WebInvoke(UriTemplate = "{email}", Method = "DELETE")]
        public void Delete(string email)
        {
            dao.remove(email);
        }

여기서 주목해야할 부분은 [WebInvoke] 부분인데, 여기에 URI를 통해서 넘어가는 인자와 HTTP 메서드를 정의한다. URI에 인자가 들어갈 경우에는 {인자}로 정의하고, Query String을 사용할 경우에는 ?queryname={인자} 식으로 정의한후, 메서드에서 해당 인자를 넣어주면 된다. 예를 들어 /Contact/{email} 식으로 Resource의 URI를 지정해서 email을 인자로 사용하고 싶으면 UriTemplate=”{email}”이 되고, 메서드는 Method(string email)이 된다. POST와 PUT의 경우에는 Resource의 데이터 자체를 변경하기 때문에, HTTP Body에 ContactVo의 데이터 내용이 들어가야 하기 때문에 메서드의 인자로 ContactVo가 같이 들어간다.

즉 Update 메서드의 경우 위와 같이 맵핑 된다.
그리고 Base URL, 이 리소스의 URL을 정의해야 하는데, BaseURL은 Global.asax.cs에 RegisterResource 부분에 정의되어 있다.

        private void RegisterRoutes()
        {
            // Edit the base address of Service1 by replacing the "Service1" string below

            RouteTable.Routes.Add(new ServiceRoute("WcfContactService", new WebServiceHostFactory(), typeof(ContactService)));
        } 

RouteTable에 의해서 관리가 되는데, ServiceRoute의 명을 “WcfContactService”로 바꾸고, typeof의 클래스명을 ContactService로 변경한다 이렇게 되면, {이 웹 애플리케이션이 배폰된 URL}/WcfContactService가 Resource의 URL이 되는 것이다.

이제 F5키를 눌러서 실행을 해보면 자동으로 컴파일이 되고 테스트용 웹서버에 자동 배포가 된 후에 웹 브라우져가 자동으로 수행된다. URL에 http://localhost:37055/WcfContactService/help 를 넣어보면 다음과 같은 화면이 나온다.( 포트명은 바뀔 수 있음)

해당 Resource에 대해서 수행할 수 있는 메서드와 종류와 HTTP Method가 나온다. 각 Http Method를 클릭하면 상세하게 해당 메서드에 대한 호출 방법, 샘플 데이터,XML 스키마들이 출력된다.

사실 REST의 문제가 SOAP기반의 웹서비스와는 다르게 WSDL이 없기 때문에, 정확한 호출 방법과 데이터에 대한 스키마가 없기 때문에 관리가 곤란한점이 있고, 개발가이드를 별도 배포해야 하는 불편함이 있지만, WCF에서는 이렇게 help 페이지를 통해서 해당 리소스에 대한 호출 방법을 개발자에게 알려준다.

여기까지 했으면 가장 기본적인 REST 서비스는 만들어졌다. 이제부터 테스트를 해보자.

1.     carry라는 이름의 Contact 생성

요청

POST http://localhost:37055/WcfContactService/ HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/xml
User-Agent: Jakarta Commons-HttpClient/3.1
Host: localhost:37055
Content-Length: 154
 

<Contact xmlns="http://schemas.datacontract.org/2004/07/WcfRestService">
  <email>carry</email>
  <name>Carry.Chot</name>
  <phone>1234</phone>
</Contact>

2.     carry라는 이름의 Contact 정보 가지고 오기

요청

GET http://localhost:37055/WcfContactService/carry HTTP/1.1
Accept-Encoding: gzip,deflate
User-Agent: Jakarta Commons-HttpClient/3.1
Host: localhost:37055

응답

<Contact xmlns="http://schemas.datacontract.org/2004/07/WcfRestService" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <email>carry</email>
   <name>Carry.Chot</name>
   <phone>1234</phone>
</Contact>

 

위의 테스트는 무료 테스트 툴인 SoapUI 3.5.1 버전을 이용하였다. SoapUI 사용방법은 맨 마지막에 다루도록 하겠다.

Collection 데이터 처리

다음으로 살펴볼 부분은 List형태의 데이터(Collection)을 다루는 방법이다. 여러명의 Contact 목록을 ~/WcfContactService/에 GET으로 접속하면 쭈욱 리스트 형태로 출력해 주는 API를 만들려고 한다. OPEN API에서 필수 적인 요소로 데이터베이스에서 쿼리해 온 데이터, 테이블 데이터들이 이들에 해당한다.

ContactService 클래스에 다음 내용을 추가한다.
 

        [WebInvoke(UriTemplate = "", Method = "GET")]
        public List<ContactVo> GetList()
        {
            return dao.getList();
        }

실행을 하고 테스트를 해보면 다음과 같은 결과를 얻을 수 있다.

요청

GET http://localhost:37055/WcfContactService/ HTTP/1.1
Accept-Encoding: gzip,deflate
User-Agent: Jakarta Commons-HttpClient/3.1
Host: localhost:37055

응답

<ArrayOfContact xmlns="http://schemas.datacontract.org/2004/07/WcfRestService" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">

   <Contact>
      <email>carry</email>
      <name>Carry.Chot</name>
      <phone>1234</phone>
   </Contact>

</ArrayOfContact>

여기서 주의 깊게 볼 점은 Contact 목록이 <ArrayOfContact>이라는 엘리먼트로 묶여 있다는 것이다.  GetList에서 리턴되어 오는 타입이 List<ContactVo> 타입인데, WCF에서는 List나 일반적인 Collection Type은 모드 <ArrayOf>로 묶어서 리턴하게 되어 있다. 그러면 이것을 바꾸고 싶다면? XML 엘리먼트 이름이 지정된 List 타입을 새로 생성하면 된다.
ContactVo.cs 파일에 ContactVo를 리스트로 묶어줄 새로운 List 타입을 정의한다.

    [CollectionDataContract(Name = "ContactList", ItemName = "Contact")]
    public class ContactList : List<ContactVo>
    {

        public ContactList() : base() { }
        public ContactList(IEnumerable<ContactVo> collection) : base(collection) { }

    }

이 데이터 타입은 List타입이기 때문에, [DataContract]이 아니라 [CollectionDataContact]으로 정의하고, Name 부분에 엘리먼트 이름을 정의해주면 된다.

그후에, WcfContractService클래스의 GetList함수를 다음과 같이 변경한다.

       [WebInvoke(UriTemplate = "", Method = "GET")]
        public ContactList GetList()
        {
            return new ContactList(dao.getList());

        }

이 ContactList 클래스는 일반 List 클래스가 아니라 XML로 변환시 “ContactList”라는 XML 엘리먼트를 가지도록 정의된 클래스이기 때문에, 실행시 다음과 같은 결과를 출력하게 된다.

<ContactList xmlns="http://schemas.datacontract.org/2004/07/WcfRestService" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">

   <Contact>
      <email>carry</email>
      <name>Carry.Chot</name>
      <phone>1234</phone>
   </Contact>

</ContactList>

XML Name 스페이스 변경하기

위의 예제들을 실행한 후에 XML 응답값들을 보면

<ContactList xmlns="http://schemas.datacontract.org/2004/07/WcfRestService" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">

XML 네임 스페이스들이 임의로 정해져있다. XML 네임스페이스는 얼핏 별거 아닐 수 도 있지만, 사용 용도에 따라서 여러가지 방안으로 사용할 수 있다. REST의 경우 데이터에 대한 스키마가 정의되어 있지 않기 때문에, 실제 XML 스키마 (XSD)나 매뉴얼의 URL을 XML 네임 스페이스로 지정해서 사용할 수 있다. 그렇다면 사용자가 직접 XML 네임 스페이스를 어떻게 지정하는가?

방법은 간단하다. DataContact이나 CollectionDataContract에 네임 스페이스를 지정해주면 된다.(ContactVo.cs에서 다음과 같이 변경한다.)

[CollectionDataContract(Namespace="http://RESTSample.bycho.com/ContactService",Name = "ContactList", ItemName = "Contact")]  

       [DataContract(Namespace = "http://RESTSample.bycho.com/ContactService", Name = "Contact")] 

변경을 한후에 ContactList를 받아보면 다음과 같이 출력된다.

<ContactList xmlns="http://RESTSample.bycho.com/ContactService"  xmlns:i="http://www.w3.org/2001/XMLSchema-instance"/>

위와 같이 XML 네임스페이스가 변경되었다.

에러 처리

다음은 REST의 에러 처리 방법이다. REST에서 에러 처리는 HTTP Response Code를 통해서 에러메세지를 보내고 필요에 따라서 상세 에러 메시지를 보내는 형태이다. 예를 들어 HTTP GET으로 해당 리소스를 요청했는데, 없을때는 404 Not Found를 로그인 인증이 실패했을때는 401 Unauthorized를 리턴하는 식이다. 에러 메시지에 대한 개념은http://msdn.microsoft.com/en-us/library/dd203052.aspx 문서를 참고하기 바라고, 여기서는 WCF 기반의 코딩 방법에 대해서 알아보자

HTTP GET으로 ~/WcfContactService/{email}을 호출했을 때, 해당 Contact이 없으면 404 Not Found와 에러를 내보내는 시나리오를 구현해보자

먼저 ContactDao 클래스의 get에서 Contact 객체가 있는지 없는지 찾아보고 없으면 KeyNotFoundException을 던지도록 수정하자

        public ContactVo get(string email)
        {
            if (!contacts.ContainsKey(email)) throw new KeyNotFoundException(email + " cannot be found");

            return contacts[email];

        }

다음으로 ContactService의 Get메서드에서 dao가 KeyNotFoundException을 던지면 404 NotFound를 리턴하도록 수정하자

        [OperationContract]
        [WebGet(UriTemplate = "{email}")]

        public ContactVo Get(string email)
        {
            ContactVo contact;
            try
            {
                contact = dao.get(email);
            }
            catch (KeyNotFoundException ex)
            {

                throw new WebFaultException<string>(ex.ToString(), HttpStatusCode.NotFound);

            }

            return contact;

        }

이부분이 핵심인데, WCF의 REST 에러 핸들링 방식은 여러가지가 있지만 WebFaultException 방식이 공식 문서에 언급되어 있다. HttpStatusCode와 에러 TextString을 보내 된다. 에러의 디테일 내용은 XML로 출력된다. (필요에 따라 JSON,TEXT등으로도 변경할 수 있음). 테스트 결과는 다음과 같다.

HTTP/1.1 404 Not Found
Server: ASP.NET Development Server/10.0.0.0
Date: Fri, 20 Aug 2010 08:47:18 GMT
X-AspNet-Version: 4.0.30319
Content-Length: 481
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Connection: Close
 

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">System.Collections.Generic.KeyNotFoundException: carry cannot be found&#xD;
   at WcfRestService.ContactDao.get(String email) in C:\Users\bycho\Documents\Visual Studio 2010\Projects\WcfRestService\WcfRestService\ContactDao.cs:line 22&#xD;
   at WcfRestService.ContactService.Get(String email) in C:\Users\bycho\Documents\Visual Studio 2010\Projects\WcfRestService\WcfRestService\ContactService.cs:line 37</string>

이 외에도 Http Custom Header 처리와 SOAP UI를 이용한 REST 테스트 방법등 몇가지 내용이 더 있는데, 오늘은 여기까지 하고, 나중에 잡지 기고할때 내용을 보강하던지 하겠다.