WCFRESTFul服务搭建及实现增删改查

时间  2019-11-08
标签 wcfrestful 服务 搭建 实现 增删 繁體版
原文   原文链接

    RESTful Wcf是一种基于Http协议的服务架构风格,  RESTful 的服务一般是架构层面上的考虑。 由于它天生就具备很好的跨平台跨语言的集成能力，几乎全部的语言和网络平台都支持 HTTP 请求，无需去实现复杂的客户端代理，无需使用复杂的数据通信方式既能够将咱们的服务暴露给任何须要的人，不管他使用 VB、Ruby、JavaScript，甚至是 HTML FORM，或者直接在浏览器地址栏输入html

    WCF 中经过 WebGetAttribute、WebInvokeAttribute (GET/PUT/POST/DELETE)、UriTemplate 定义 REST 的服务的调用方式， 经过 WebMessageFormat (Xml/Json) 定义消息传递的格式。web

RESTful的几点好处(引用博文)：ajax

一、简单的数据通信方式，基于HTTP协议。避免了使用复杂的数据通信方式。json

二、避免了复杂的客户端代理。跨域

三、直接经过URI资源定向便可把服务暴露给调用者。浏览器

下面就经过一个简单的列子一步一步实现WCFRESTFulrestful

一、  新建以下项目网络

 　　

二、  项目文件介绍架构

(1)     IService1.cs 定义服务契约，在接口方法中定义RestFul请求规则。app

(2)     Service1.svc 实现IService1.cs定义的服务契约。

(3)     People.cs 数据契约，定义的实体对象

(4)     Global.asax 全局资源文件中定义注册路由

(5)     Web.config 配置WCF服务。

三、  IService1.cs接口定义三个方法，包含GET和POST请求

using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.Serialization;
using System.ServiceModel;
using System.ServiceModel.Web;
using System.Text;
namespace WcfRestFulService

{

    // NOTE: You can use the "Rename" command on the "Refactor" menu to change the interface name "IService1" in both code and config file together.

    [ServiceContract(Name="user")]
    public interface IService1
    {
        [OperationContract]

        [WebInvoke(UriTemplate = "get/{value}",  Method = "GET", ResponseFormat = WebMessageFormat.Json, RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Bare)]

        string GetData(string value);

        [OperationContract]

        [WebInvoke(UriTemplate = "add", Method = "POST", ResponseFormat = WebMessageFormat.Json, RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Bare)]

        string addPeople(People p);

        [OperationContract]

        [WebInvoke(UriTemplate = "GetList/{value}", Method = "GET", ResponseFormat = WebMessageFormat.Json, RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Bare)]

        List<People> GetList(string value);

    }

 

}

注意：经过WebInvoke属性的Method值说明该请求的类型，UriTemplate值说明url路由。接口中[ServiceContract(Name="user")]的定义，咱们的URL路径中将会用到user

四、  Service1.svc实现契约

using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.Serialization;
using System.ServiceModel;
using System.ServiceModel.Web;
using System.Text;
using System.ServiceModel.Activation;
namespace WcfRestFulService
{

    // NOTE: You can use the "Rename" command on the "Refactor" menu to change the class name "Service1" in code, svc and config file together.

     [AspNetCompatibilityRequirements(
        RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
    public class Service1 : IService1
    {
        public string GetData(string value)
        {
            return string.Format("You entered: {0}", value);
        }

        public string addPeople(People p)
         {
             if (p == null)
             {
                 return "People is Null";
             }
             return p.Name;
         }

        public List<People> GetList(string value)

        {

            return new List<People> { new People(){Id=1,Name="eric"}};

        }
    }
}

注意：[AspNetCompatibilityRequirements( RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]的定义跟咱们在webconfig中的一个配置相关，咱们在下文中详细介绍。

五、  Global全局资源文件，注册服务的路由：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Security;
using System.Web.SessionState;
using System.Web.Routing;
using System.ServiceModel.Activation;
namespace WcfRestFulService
{
    public class Global : System.Web.HttpApplication
    {
        protected void Application_Start(object sender, EventArgs e)
        {
            RegistrRoutes();
        }
        private void RegistrRoutes()
        {
            //说明：ServiceRoute须要引用 System.ServiceModel.Activation.dll
            RouteTable.Routes.Add(new ServiceRoute("user", new WebServiceHostFactory(), typeof(Service1)));
        }
    }
}

六、  Web.config配置文件

<?xml version="1.0"?>
<configuration>
  <system.web>
    <compilation debug="true" targetFramework="4.0" />
  </system.web>
  <system.serviceModel>
    <behaviors>
      <serviceBehaviors>
        <behavior name="defaultResultBehavior">
          <!-- 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="false"/>
          <dataContractSerializer maxItemsInObjectGraph="6553500"/>
        </behavior>
      </serviceBehaviors>
      <endpointBehaviors>
        <behavior name="defaultRestEndpointBehavior">
          <webHttp helpEnabled="true" automaticFormatSelectionEnabled="true" />
          <dataContractSerializer maxItemsInObjectGraph="6553500"/>
        </behavior>
        </endpointBehaviors>
    </behaviors>
    <services>
      <service name="WcfRestFulService.Service1" behaviorConfiguration="defaultResultBehavior">
        <endpoint binding="webHttpBinding" contract="WcfRestFulService.IService1" behaviorConfiguration="defaultRestEndpointBehavior"></endpoint>
      </service>
    </services>
    <serviceHostingEnvironment multipleSiteBindingsEnabled="true" aspNetCompatibilityEnabled="true" />
  </system.serviceModel>
 <system.webServer>
    <modules runAllManagedModulesForAllRequests="true"/>
  </system.webServer>
</configuration>

说明：在配置文件中咱们看<serviceHostingEnvironment multipleSiteBindingsEnabled="true" aspNetCompatibilityEnabled="true" />节点，若是使aspNetCompatibilityEnabled="true"必须在Service1.svc声明[AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]，其中RequirementsMode的值也能够为AspNetCompatibilityRequirementsMode. Required

至此咱们的WCFRESFul搭建成功，运行服务看效果。

一、  http://localhost:9315/Service1.svc(传统的页面，是否是很熟悉)

二、http://localhost:9315/user/help(RESTFul的风格，是否是眼前一亮

三、  经过RESTFul风格调用服务

(1)、http://localhost:9315/user/get/1调用服务string GetData(string value)，参数值为1

(2)、http://localhost:9315/user/add 调用string addPeople(People p)服务

 

下面咱们开始建立一个简答的ajax调用列子测试一下WC FRESTFul服务

注意：若是你是用VS自带的IIS调试，WCF RESTFul生成的URL与调用WCF服务的URL端口号要保持一致，要否则用ajax调用浏览器会认为跨域。 好比：http://localhost:9315/user/get/1 和 http://localhost:9315/Default.aspx，

我是采用win7系统的IIS 7调试的。

服务地址配置为：http://localhost/wfcrestful/user/help

调用服务的Web页面的地址为：http://localhost/restfulTest/WebForm1.aspx

 

调用服务string GetData(string value)

$.get("http://localhost/wfcrestful/user/get/1", function (json) { alert(json) });

调用服务：string addPeople(People p)

$.ajax({
            "url": "http://localhost/wfcrestful/user/add",
            "type": "POST",
            "contentType": "application/json",
            "dataType": "json",
            "data": '{\"Id\":1,\"Name\":\"我是输入的内容\"}',
            "success": function (returnValue) {
            alert(returnValue);               
            }

            });

调用服务GetList(string value)

$.get("http://localhost/wfcrestful/user/GetList/22", function (json) {
                alert(json[0].Name);
            })

至此整个DEMO已经完成，请点击下载源码。

PS：WCF RESTFul已是过期的技术了，有兴趣的童鞋们能够研究一下 MVC WebApi

文中有些的不对的地方欢迎你们指正。

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程