構建基於WCF Restful Service的服務

前言

傳統的Asmx服務，由於遵循SOAP協議，所以返回內容以xml方式組織。並且客戶端需要添加服務端引用才能使用（雖然看到網絡上已經提供了這方面的Dynamic Proxy，但是沒有這種方式簡便），所以給開發和部署帶來了不小的麻煩。並且當服務過多的時候，生成的引用文件會很大，之前項目的一個引用文件光引用代碼都有5000多行，全部在一個類中。確實不方便維護。

基於以上幾點，就特別研究了一下基於Restful的服務開發，當時手頭有兩種框架，一個是WCF Restful Service，另一個是Asp.net Web API。由於對WCF比較熟悉一些，所以就選擇了前者。

Restful Service及其相關

說到Restful Service，不得不提到其中的Rest這個關鍵字。它是用於創建分布式超文本媒體的一種架構方式，我們可以通過標准的HTTP（GET，POST，PUT，DELETE）操作來構建基於面向資源的軟件架構方式（Resource-Oriented Architecture (ROA)）。它是獨立於任何技術或者平台的，所以人們經常將符合這種操作規范的服務稱為“RESTful services”。因為WCF能夠構建符合這種規范的服務，所以我們經常稱之為 WCF Restful Services。

由於傳統的WCF Service可以使用tcp,net.msmq,http等協議進行數據交換，並且采用了RPC（Remote Procedure Call）的工作方式，客戶端需要添加對服務端的引用才能完成。但是WCF Restful Service完全使用Http協議來進行，並且無需添加客戶端引用，所以方便很多。

服務端開發一瞥

下面以圖書館的例子來做具體的說明。

打開VS2010，新建一個WCF REST Service Application項目，然后在項目中，添加一個BookService.cs用於處理邏輯操作，再添加一個BookEntity.cs用於提供實體類。

打開Global.asax，可以看到如下代碼：

void Application_Start(object sender, EventArgs e)
{
   RegisterRoutes();
}

private void RegisterRoutes()
{
   RouteTable.Routes.Add(new ServiceRoute("BookService", new WebServiceHostFactory(), typeof(BookService)));
}

 

其中RegisterRoutes是設定服務啟動的入口點的。

然后是BookEntity實體類的組織方式：

public class BookEntity
{
       public int BookID { get; set; }

       public string BookName { get; set; }

       public decimal BookPrice { get; set; }

       public string BookPublish { get; set; }
}

這里我就不用多說了，實體類包含圖書序號，圖書名稱，圖書價格，出版單位四個屬性。

然后就是我們的核心內容：

    [ServiceContract]
    [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
    [ServiceBehavior(InstanceContextMode = InstanceContextMode.Single)]
    public class BookService
    {
        public BookService()
        {
            bookList = new List<BookEntity>();
            BookEntity book = new BookEntity();
            book.BookID = 1;
            book.BookName = "大話設計模式";
            book.BookPrice = (decimal)45.2;
            book.BookPublish = "中國郵電出版社";
            bookList.Add(book);

            BookEntity book1 = new BookEntity();
            book1.BookID = 2;
            book1.BookName = "測試用例";
            book1.BookPrice = (decimal)21.0;
            book1.BookPublish = "清華大學出版社";
            bookList.Add(book1);

            BookEntity book2 = new BookEntity();
            book2.BookID = 3;
            book2.BookName = "Rework";
            book2.BookPrice = (decimal)15.4;
            book2.BookPublish = "Wrox pulishment";
            bookList.Add(book2);
        }

        private static List<BookEntity> bookList;

        [WebInvoke(Method = "GET"
            , ResponseFormat = WebMessageFormat.Json
            , BodyStyle = WebMessageBodyStyle.Bare   //不需要任何修飾，否則生成的json無法解析
            , UriTemplate = "/?bookID={bookID}")]  //只接收string類型，如果是其他類型，需要按照 /?para={parameter}的方式來組織。
        public BookEntity Get(int bookID)
        {
            return bookList.Where(p => p.BookID == bookID).FirstOrDefault();
        }

        [WebInvoke(Method = "GET"
            , ResponseFormat = WebMessageFormat.Json
            , BodyStyle = WebMessageBodyStyle.Bare
            , UriTemplate = "/")]
        public List<BookEntity> GetALL()
        {
            return bookList;
        }

          [WebInvoke(Method = "POST"
            , ResponseFormat = WebMessageFormat.Json
            , BodyStyle = WebMessageBodyStyle.Bare
            , UriTemplate = "/")]
        public bool Update(BookEntity book)
        {
            BookEntity query = (from p in bookList where p.BookID == book.BookID select p).FirstOrDefault();
            bookList.Remove(query);
            bookList.Add(book);
            return true;
          }

         [WebInvoke(Method = "PUT"
            , ResponseFormat = WebMessageFormat.Json
            , BodyStyle = WebMessageBodyStyle.Bare
            , UriTemplate = "/")]
        public bool Add(BookEntity book)
        {
            bookList.Add(book);
            return true;
        }

        [WebInvoke(Method = "DELETE"
            , ResponseFormat = WebMessageFormat.Json
            , BodyStyle = WebMessageBodyStyle.Bare
            , UriTemplate = "/")]
        public bool Delete(BookEntity book)
        {
            BookEntity bookCurrent = (from p in bookList where p.BookID == book.BookID select p).FirstOrDefault();
            return bookList.Remove(bookCurrent);
        }
    }

其中，Method 方法主要是表明可以接受客戶端的請求類型，這里有四種：GET，POST，PUT，DELETE，其中GET為請求數據，POST為更新數據，PUT為新增數據，DELETE代表着刪除數據。

然后ResponseFormat 則代表着返回的數據組織，如果是Json則表明客戶端會接收到Json數據，如果是XML則表明客戶端會接收到XML組織的數據。BodyStyle 代表返回數據的包裝對象，如果是Bare則表明數據無任何包裝，原生數據返回；如果是Wrapped則表明數據會在最外層包裝一個當前函數名稱加上Result的套。比如對於Delete對象，則會返回 DeleteResult:{******}，會造成DataContractJsonSerializer無法進行反序列化。

UriTemplate 主要用於指定操作的URI路徑，只要用戶輸入了合法路徑並采用了正確的請求方式，就會觸發該函數。

最后說到的就是URI后面跟的參數的問題，由於函數只能接受string類型的，所以如果傳入參數是string類型，則可以使用UriTemplate = "{bookID}"的路徑，反之，則需要加上/?param1={paramname}的方式，比如我代碼中使用的是：UriTemplate = "/?bookID={bookID}"。

當一切都弄好以后，讓我們運行一下，訪問如下路徑，就可以得到結果：

http://localhost:45345/BookService/

得到的結果如下：

[{"BookID":1,"BookName":"大話設計模式","BookPrice":45.2,"BookPublish":"中國郵電出版社"},{"BookID":2,"BookName":"測試用例","BookPrice":21,"BookPublish":"清華大學出版社"},{"BookID":3,"BookName":"Rework","BookPrice":15.4,"BookPublish":"Wrox pulishment"}]

 如果訪問http://localhost:45345/BookService/?bookID=1，則會得到如下的結果:

{"BookID":1,"BookName":"大話設計模式","BookPrice":45.2,"BookPublish":"中國郵電出版社"}

客戶端開發一瞥

初步測試成功后，讓我們來進行一下全面的測試。

首先，在項目中，我們新建一個Asp.net WebForm Application，用於做測試工作。

然后，在Default.aspx.cs中，針對GET操作，我們添加如下代碼：

private void GetBookByID(string id)
       {
           WebClient proxy = new WebClient();
           string serviceURL = string.Empty;
           DataContractJsonSerializer obj ;
           if (string.IsNullOrEmpty(id))
           {
               serviceURL = string.Format("http://localhost:45345/BookService/");
               obj = new DataContractJsonSerializer(typeof(List<BookEntity>));
           }
           else
           {
               serviceURL = string.Format("http://localhost:45345/BookService/?bookID=" + id);
               obj = new DataContractJsonSerializer(typeof(BookEntity));
           }
           byte[] data = proxy.DownloadData(serviceURL);
           Stream stream = new MemoryStream(data);
           var result = obj.ReadObject(stream);
           List<BookEntity> list=new List<BookEntity>();
           if (result is BookEntity)
               list.Add(result as BookEntity);
           else if (result is List<BookEntity>)
               list = result as List<BookEntity>;
           GridView1.DataSource = list;
           GridView1.DataBind();
       }

在以上代碼中，DataContractJsonSerializer 是WCF提供的一個序列化類，用於將對象序列化或者反序列化。

寫好之后，我們點擊界面按鈕，出現了以下的結果：

針對PUT操作，也就是添加操作，我們添加如下代碼：

BookEntity bookEntity = new BookEntity();
            bookEntity.BookID = Int32.Parse(txtBookID.Text);
            bookEntity.BookName = txtBookName.Text;
            bookEntity.BookPrice = decimal.Parse(txtBookPrice.Text);
            bookEntity.BookPublish = txtBookPublish.Text;

            DataContractJsonSerializer obj = new DataContractJsonSerializer(typeof(BookEntity));
            MemoryStream ms = new MemoryStream();
            obj.WriteObject(ms, bookEntity);
            byte[] byteSend = ms.ToArray();
            ms.Close();

            string serviceURL = string.Format("http://localhost:45345/BookService");

            WebClient test = new WebClient();
            test.Headers.Add("Content-Type", "application/json");
            test.Headers.Add("ContentLength", byteSend.Length.ToString());


            byte[] responseData = test.UploadData(serviceURL, "PUT", byteSend);

            string result = Encoding.GetEncoding("UTF-8").GetString(responseData);
            lblLog.Text = result;

在做這步的時候，需要注意，test.Headers.Add("Content-Type", "application/json") 和test.Headers.Add("ContentLength", byteSend.Length.ToString())需要添加，否則會造成Http 400 返回的錯誤。並且，向服務端傳遞實體的時候，可以通過使用UploadData的方式來進行，如果數據量過大，可以考慮使用異步方式傳送。

接下來的POST和DELETE方法和上面類似，我都貼一下：

POST方法：

BookEntity bookEntity = new BookEntity();
           bookEntity.BookID = Int32.Parse(txtBookID.Text);
           bookEntity.BookName = txtBookName.Text;
           bookEntity.BookPrice = decimal.Parse(txtBookPrice.Text);
           bookEntity.BookPublish = txtBookPublish.Text;

           DataContractJsonSerializer obj = new DataContractJsonSerializer(typeof(BookEntity));
           MemoryStream ms = new MemoryStream();
           obj.WriteObject(ms, bookEntity);
           byte[] byteSend = ms.ToArray();
           ms.Close();

           string serviceURL = string.Format("http://localhost:45345/BookService");

           WebClient test = new WebClient();
           test.Headers.Add("Content-Type", "application/json");
           test.Headers.Add("ContentLength", byteSend.Length.ToString());

           byte[] responseData = test.UploadData(serviceURL, "POST", byteSend);

           string result = Encoding.GetEncoding("UTF-8").GetString(responseData);
           lblLog.Text = result;

DELETE方法：

BookEntity bookEntity = new BookEntity();
           bookEntity.BookID = Int32.Parse(txtBookID.Text);

           DataContractJsonSerializer obj = new DataContractJsonSerializer(typeof(BookEntity));
           MemoryStream ms = new MemoryStream();
           obj.WriteObject(ms, bookEntity);
           byte[] byteSend = ms.ToArray();
           ms.Close();

           string serviceURL = string.Format("http://localhost:45345/BookService");

           WebClient test = new WebClient();
           test.Headers.Add("Content-Type", "application/json");
           test.Headers.Add("ContentLength", byteSend.Length.ToString());


           byte[] responseData = test.UploadData(serviceURL, "DELETE", byteSend);

           string result = Encoding.GetEncoding("UTF-8").GetString(responseData);
           lblLog.Text = result;

最后得到的效果圖如下：

（新增記錄）

（更新記錄）

（刪除記錄）

 成文倉促，難免有誤，還請指出，在此謝過。

源代碼下載

點擊下載源代碼  

 

Edit：基於本方法構建的Android服務已經在使用中。后續繼續跟進各種使用信息。

在StackOverFlow問答如下：點擊這里查看

 看評論中提到了IContract問題，由於這是Restful Service，不是基於RPC模式，所以沒必要使用的。不過用上去也沒錯。