zzWCF实现RESTFul Web Service

Posted 2020-09-29 liangouyang

http://www.cnblogs.com/KeithWang/archive/2012/02/14/2351826.html

http://blog.csdn.net/qq_26054303/article/details/48655985

http://www.cnblogs.com/LNCLSH/p/3781572.html

共同学习了前面一些概念，终于开始正题了哈。RESTful的Web Service调用直观，返回的内容容易解析。这里先会描述一个简单的场景--Web Service提供一个方法来搜索个人信息，传入人名，返回完整个人信息。
下面我们一步步用WCF实现一个RESTful的Web Service。在这之后分别描述用普通Console程序host在本地，以及用IIS发布到网络。

1. Contract

namespace WcfRESTful
{
    [ServiceContract]
    public interface IPersonRetriever
    {
        [OperationContract]
        [WebGet(UriTemplate = "Persons/{name}", ResponseFormat = WebMessageFormat.Json)]
        Person GetPerson(string name);
    }

    [DataContract]
    public class Person
    {
        [DataMember]
        public string Name { get; set; }
        [DataMember]
        public int Age { get; set; }
        [DataMember]
        public DateTime Birthday { get; set; }
    }
}

这里需要注意的是在方法GetPerson()上面的WebGetAttribute：
1.1 WebGetAttribute定义了该方法的访问方式为RESTful的Get（关于RESTful可以参考本小博中关于REST介绍的文章）。
1.2 UriTemplet描述了URL匹配的格式，当格式匹配时，{name}位置的字符串会被对应传入为方法参数。
1.3 ResponseFormat指定了返回的数据格式，可选项为JSON和XML。

 

2. Contract实现

namespace WcfRESTful
{
    public class PersonRetriever : IPersonRetriever
    {
        public Person GetPerson(string name)
        {
            WebOperationContext.Current.OutgoingResponse.ContentType = "text/plain";
            return new Person { Name = name, Age = 22, Birthday = DateTime.Now };
        }
    }
}

这个实现里面，我们简单的返回一个用传入名参数为name的Person实例。这里补充一点：如果ContectType是"Text"，如果返回结果串包含特别字符（比如转义，双引号，XML文件片段等），有些情况会在IE中解析不正常，造成字段缺失，目前没有找到相关资料说明IE解析规则。为了方便和谨慎起见，直接用"text/plain"。

 

3. 在Console中Host Service

在第1,2步的基础上，我们开始在console中host这个service。

namespace WcfRESTful
{
    class Program
    {
        static void Main(string[] args)
        {
            Uri baseAddress = new Uri("http://127.0.0.1:9998/PersonRetriever");
            using (ServiceHost host = new ServiceHost(typeof(PersonRetriever), baseAddress))
            {
                WebHttpBinding binding = new WebHttpBinding();
                ServiceEndpoint endpoint = host.AddServiceEndpoint(typeof(IPersonRetriever), binding, baseAddress);
                WebHttpBehavior httpBehavior = new WebHttpBehavior();
                endpoint.Behaviors.Add(httpBehavior);
                host.Opened += delegate
                {
                    Console.WriteLine("Hosted successfully.");
                };
                host.Open();
                Console.ReadLine();
            }
        }
    }
}

让后我们通过URL：http://127.0.0.1:9998/PersonRetriever/Persons/Tom 就可以访问该Service了，其中"Tom"是需要查询的人名。在IE中输入该URL，回车之后的结果如下图：

4. 在IIS中Host Web Service

4.1新建一个WCF Service（或者Web Service依.Net Framework版本不同而定）工程，把第1,2步的Contract和实现Copy到App_Code文件夹下面。

4.2修改Service.svc - 注意，Factory="System.ServiceModel.Activation.WebServiceHostFactory"必须添加才可以直接在IE查看结果，但是Matedata将被屏蔽不能显示。

<%@ ServiceHost Language="C#" Debug="true" Service="WcfRESTful.PersonRetriever" CodeBehind="~/App_Code/PersonRetriever.cs" Factory="System.ServiceModel.Activation.WebServiceHostFactory"%>

4.3添加Endpoint到Web.config

    <system.serviceModel>
        <services>
            <service name="WcfRESTful.PersonRetriever" behaviorConfiguration="ServiceBehavior">
                <endpoint binding="webHttpBinding" contract="WcfRESTful.IPersonRetriever"/>
                <endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange"/>
            </service>
        </services>
        <behaviors>
            <serviceBehaviors>
                <behavior name="ServiceBehavior">
                    <!-- To avoid disclosing metadata information, set the value below to false and remove the metadata endpoint above before deployment -->
                    <serviceMetadata httpGetEnabled="true"/>
                    <!-- To receive exception details in faults for debugging purposes, set the value below to true.  Set to false before deployment to avoid disclosing exception information -->
                    <serviceDebug includeExceptionDetailInFaults="true"/>
                </behavior>
            </serviceBehaviors>
        </behaviors>
    </system.serviceModel>

4.4添加工程目录到IIS虚拟路径，命名为WCFTest。

以上4.1－4.4的所有步骤都完成了，我们通过URL：http://16X.19X.18X.6X/wcftest/Service.svc/Persons/Tom 一样可以得到上面的结果{"Age":22,"Birthday":"\\/Date(1329226087212-0500)\\/","Name":"Tom"}。

这里需要补充一点，在4.1步骤，我们新建一个Web Service工程，仅仅是为了少写一些Web.Config的配置（会默认有system.web，complier等配置信息），其实我们完全可以新建App_Code文件夹，把Contact和Contract实现拷入该文件夹，然后在外层手工新建Service.svc，Web.config并写入相应配内容，一样可以成功部署和使用。

 

5. 总结
RESTful Web Service用更简单通用的协议（HTTP，少了SOAP这一道封装和解析），更直接的结果，让人眼前一亮，在资源不需要交互逻辑和复杂结构的情况下还是不错的选择