Разработка REST сервиса при помощи WCF.

Всем привет! Сегодня мы поговорим о подходе для разработки сетевой архитектуры под названием REST и способах его реализации на платформе .NET при помощи Windows Communication Foundation.

Для начала, разберемся, что такое REST и с чем его едят. В основе архитектуры REST лежит 3 основополагающих принципа:

1. Протокол передачи данных HTTP. Для обмена данными между клиентом и сервисом используются классические запросы с командами HTTP: GET, POST, PUT, DELETE (получение, добавление, обновление и удаление данных соответственно);
2. Ресурсно-ориентированная архитектура. Взаимодействие с сервисом – это обмен данными между клиентом и определенным ресурсом, расположенным на сервисе. При этом каждый ресурс обладает уникальным адресом (URI). Не правда ли, очень похоже на схему функционирования сети Интернет в целом?
3. Формат передаваемых данных: XML или JSON.
   

Для тех, кто знаком с принципами архитектуры классических WCF сервисов (SOAP), разницу с подходом REST можно описать следующей фразой: SOAP – это сервис с набором методов, а REST – это сервис с набором ресурсов.

Стоит отметить, что использование REST подхода очень распространено в современной Интернет среде. Практически все сервисы API крупнейших игроков Интернет индустрии построены именно на архитектуре REST (Bing, Facebook, Google, eBay, YouTube, Amazon и т.д.)

Такая популярность не случайна, REST предоставляет два больших преимущества своим пользователям:

1. Кроссплатформенность. Поскольку в основе RESTа лежит протокол HTTP, не составляет ни малейших трудностей для реализации, как клиента, так и сервиса на любой из существующих платформ;
2. Масштабируемость. Протокол HTTP не поддерживает передачу состояния. Говоря другими словами, каждый запрос по HTTP является автономным. Это позволяет с легкостью в любое время организовать горизонтальное масштабирование серверной части.

WCF, как одна из ведущих технологий для разработки сервисов, имеет специальные механизмы для разработки REST сервисов. Далее мы рассмотрим пример быстрой разработки REST сервиса при помощи WCF.

Не изменяя традициям WCF, для сервиса REST также необходим контракт операций. Давай определим этот интерфейс, исходя из следующего сценария: на сервисе хранится коллекция товаров, для которой необходимо предоставить базовые операции: получение, добавление и удаление товаров.

   1:      [ServiceContract]

   2:      public interface IGoodsOperations

   3:      {

   4:          [WebGet(UriTemplate = "/{id}")]

   5:          [OperationContract]

   6:          Good GetGoodById(string id);

   7:   

   8:          [WebInvoke(Method = "POST")]

   9:          [OperationContract]

  10:          Guid AddGoodToCollection(string title);

  11:   

  12:          [WebInvoke(Method = "PUT", BodyStyle = WebMessageBodyStyle.Wrapped)]

  13:          [OperationContract]

  14:          void UpdateGood(Guid id, string title);

  15:   

  16:          [WebInvoke(Method = "DELETE")]

  17:          [OperationContract]

  18:          void DeleteGood(Guid id);

  19:      }

Рассмотрим этот интерфейс подробнее. Как и в обычных сервисах WCF, интерфейс помечен атрибутом [ServiceContract], а его методы атрибутами [OperationContract].

Также можно заметить, что каждый метод помечен атрибутом [WebGet] или [WebInvoke]. Данные атрибуты являются одна из составляющих механизма REST в WCF.

Ранее упоминалось, что с REST сервисом можно работать посредством четырех базовых операций: GET, POST, PUT и DELETE. Атрибуты [WebGet] и [WebInvoke] указывают, с помощью какой операции будет доступен этот метод.

Для операции GET используется атрибут [WebGet]. Поскольку в этой операции данные передаются на сервер в строке запроса, необходимо указать такой параметр как UriTemplate – это текстовая константа, которая обозначает, каким образом параметры строки запроса будут мапиться на параметры метода. Стоит отметить, что параметры могут быть только строкового типа!

Для всех остальных операций кроме GET используется атрибут [WebInvoke]. У него есть параметр Method, где необходимо указать название операции (POST, PUT, DELETE). Почему-то этот параметр сделали строкой, а не перечислением.

Также, у обоих атрибутов есть такие параметры, как RequestFormat и ResponseFormat, которые определяют, в каком формате сервис будет принимать, и отдавать данные.

Приведем реализацию данного контракта (исключительно, как пример):

   1:      public class GoodsService : IGoodsOperations

   2:      {

   3:          private static Dictionary<Guid, Good> Collection;

   4:   

   5:          static GoodsService()

   6:          {

   7:              Collection = new Dictionary<Guid, Good>();

   8:          }

   9:          

  10:   

  11:          public Good GetGoodById(string id)

  12:          {

  13:              Guid goodId = Guid.Parse(id);

  14:              Good existGood;

  15:              if (Collection.TryGetValue(goodId, out existGood))

  16:              {

  17:                  return existGood;

  18:              }

  19:              else

  20:              {

  21:                  WebOperationContext.Current.OutgoingResponse.StatusCode = HttpStatusCode.NotFound;

  22:                  return null;

  23:              }

  24:   

  25:          }

  26:   

  27:          public Guid AddGoodToCollection(string title)

  28:          {

  29:              var id = Guid.NewGuid();

  30:              Collection.Add(id, new Good() { Id = id, Title = title });

  31:              

  32:              WebOperationContext.Current.OutgoingResponse.StatusCode = HttpStatusCode.Created;

  33:              return id;

  34:          }

  35:   

  36:          public void UpdateGood(Guid id, string title)

  37:          {

  38:              Good existGood;

  39:              if (Collection.TryGetValue(id, out existGood))

  40:              {

  41:                  existGood.Title = title;

  42:              }

  43:              else

  44:              {

  45:                  WebOperationContext.Current.OutgoingResponse.StatusCode = HttpStatusCode.NotFound;

  46:              }

  47:          }

  48:   

  49:          public void DeleteGood(Guid id)

  50:          {

  51:              if (Collection.ContainsKey(id))

  52:              {

  53:                  Collection.Remove(id);

  54:              }

  55:              else

  56:              {

  57:                  WebOperationContext.Current.OutgoingResponse.StatusCode = HttpStatusCode.NotFound;

  58:              }

  59:          }

  60:      }

В данном коде необходимо обратить внимание на взаимодействие с WebOperationContext.Current – в этом классе находится контекст текущего запроса. (Аналог HttpContext.Current в ASP.NET) Здесь мы используем данный класс для установки кода ответа сервиса, в зависимости от результатов выполнения логики метода.

В одной из следующих статьей мы рассмотрим, какими способами можно организовать хостинг REST сервиса.