構建RESTful風格的WCF服務

RESTful Wcf是一種基於Http協議的服務架構風格。 相較 WCF、WebService 使用 SOAP、WSDL、WS-* 而言，幾乎所有的語言和網絡平台都支持 HTTP 請求。

RESTful的幾點好處：

1、簡單的數據通訊方式，基於HTTP協議。避免了使用復雜的數據通訊方式。

2、避免了復雜的客戶端代理。

3、直接通過URI資源定向即可把服務暴露給調用者。

下面使用一個簡單的demo項目來看看啥是RESTful Wcf。

1、項目結構【VS2010+.net 4.0】：

2、接口定義：定義了2個方法，分別代表GET、POST典型請求方式。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.ServiceModel.Web;
using MyWcfService.Model;
namespace MyWcfService
{
    [ServiceContract(Namespace = ServiceEnvironment.ServiceNamespace, Name = "user")]
    public interface IUserService
    {
        /// <summary>
        /// 根據code獲取對象(GET請求處理)
        /// </summary>
        /// <param name="code"></param>
        /// <returns></returns>
        [OperationContract]
        [WebGet(UriTemplate = "search/{code}", ResponseFormat = ServiceEnvironment.WebResponseFormat, RequestFormat = ServiceEnvironment.WebRequestFormat, BodyStyle = ServiceEnvironment.WebBodyStyle)]
        UserInfo GetUserInfoSingle(string code);

        /// <summary>
        /// 注冊新的用戶(POST請求處理)
        /// </summary>
        /// <param name="user">注冊用戶信息</param>
        /// <returns>注冊成功返回注冊用戶基本信息</returns>
        [OperationContract]
        [WebInvoke(Method = "POST", UriTemplate = "register", ResponseFormat = ServiceEnvironment.WebResponseFormat, RequestFormat = ServiceEnvironment.WebRequestFormat, BodyStyle = ServiceEnvironment.WebBodyStyle)]
        UserInfo Register(UserInfo user);
    }
}

3、服務實現類WcfUserService：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.Serialization;
using System.ServiceModel;
using System.ServiceModel.Web;
using System.Text;
using MyWcfService.Model;
using System.ServiceModel.Activation;

namespace MyWcfService
{
    [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)]
    public class WcfUserService : IUserService
    {
        public UserInfo GetUserInfoSingle(string code)
        {
            // var request= WebOperationContext.Current.IncomingRequest;
　　　　　　　　 //測試數據
            IList<UserInfo> list = new List<UserInfo>()
            {
                new UserInfo(){ Id=1, Code="000001", Name="喬峰", Description="喬大爺啊"},
                new UserInfo(){ Id=2, Code="600000", Name="段譽", Description="你爹真是風流倜儻啊"}
                new UserInfo(){ Id=3, Code="000002", Name="慕容復", Description="妹子被樓上的搶咯，太失敗了"},
                new UserInfo(){ Id=4, Code="000008", Name="庄聚賢", Description="無所事事的帥哥庄聚賢"}
            };
            return list.Where(e => e.Code == code).FirstOrDefault();
        }

        public UserInfo Register(UserInfo user)
        {
            if (user == null)
                return null;
            user.Description = "POST搞定了！";
            return user;
        }
    }
}

4、定義web資源請求和響應格式：

/// <summary>
        /// web請求格式
        /// </summary>
        public const WebMessageFormat WebRequestFormat = WebMessageFormat.Xml;

        /// <summary>
        /// web相應格式
        /// </summary>
        public const WebMessageFormat WebResponseFormat = WebMessageFormat.Xml;


        /// <summary>
        /// 請求內容封裝方式
        /// </summary>
        public const WebMessageBodyStyle WebBodyStyle = WebMessageBodyStyle.Bare;

5、Global全局資源文件，注冊服務的路由：

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

        private static void RegisterRoutes()
        {
            RouteTable.Routes.Add(new ServiceRoute("user", new WebServiceHostFactory(), GetServiceType("WcfUserService")));
        }

        private static Type GetServiceType(string typeName)
        {
            string typeFullName = String.Format("MyWcfService.{0},MyWcfService", typeName);
            return Type.GetType(typeFullName);
        }

6、wcf配置文件：

 <system.serviceModel>
    <bindings>
      <netTcpBinding>
        <binding name="defaultNetTcpBinding" closeTimeout="00:01:00"
            openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00"
            transactionFlow="false" transferMode="Buffered" transactionProtocol="OleTransactions"
            hostNameComparisonMode="StrongWildcard" listenBacklog="10"
            maxBufferPoolSize="2147483647" maxBufferSize="2147483647" maxConnections="100"
            maxReceivedMessageSize="2147483647">
          <readerQuotas maxDepth="32" maxStringContentLength="8192" maxArrayLength="16384"
              maxBytesPerRead="4096" maxNameTableCharCount="16384" />
          <reliableSession ordered="true" inactivityTimeout="00:10:00"
              enabled="false" />
          <security mode="None">
            <transport clientCredentialType="Windows" protectionLevel="EncryptAndSign" />
            <message clientCredentialType="Windows" />
          </security>
        </binding>
      </netTcpBinding>
    </bindings>
    <behaviors>
      <serviceBehaviors>

        <behavior name="defaultResultBehavior">
          <!-- 為避免泄漏元數據信息，請在部署前將以下值設置為 false 並刪除上面的元數據終結點 -->
          <serviceMetadata httpGetEnabled="true"/>
          <!-- 要接收故障異常詳細信息以進行調試，請將以下值設置為 true。在部署前設置為 false 以避免泄漏異常信息 -->
          <serviceDebug includeExceptionDetailInFaults="true"/>
          <dataContractSerializer maxItemsInObjectGraph="6553500"/>
        </behavior>
      </serviceBehaviors>
      <endpointBehaviors>
        <behavior name="defaultRestEndpointBehavior">
          <webHttp helpEnabled="true" automaticFormatSelectionEnabled="true" />
          <dataContractSerializer maxItemsInObjectGraph="6553500"/>
        </behavior>
        <behavior>
          <dataContractSerializer maxItemsInObjectGraph="6553500"/>
        </behavior>
      </endpointBehaviors>
    </behaviors>
    <services>
      <service name="MyWcfService.WcfUserService" behaviorConfiguration="defaultResultBehavior">
        <endpoint contract="MyWcfService.IUserService" binding="webHttpBinding" behaviorConfiguration="defaultRestEndpointBehavior" />
      </service>
      
    </services>
    <serviceHostingEnvironment multipleSiteBindingsEnabled="true" aspNetCompatibilityEnabled="true" />
  </system.serviceModel>

文件代碼都准備的差不多了，運行服務看下效果：

調用GET方法，返回xml數據：

ok，一個RestFul WCF就搭建完畢。

下一篇文章還是基於這個demo，如何使用dynamic解析Http RestFul xml格式響應數據，並展現在客戶端。