构建基于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模式，所以没必要使用的。不过用上去也没错。