构建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格式响应数据，并展现在客户端。