首页
所有分类
TAGS
文字工具 EMOJI BIBLE
编程 Javascript

jQuery Ajax调用WCF服务详细教程

Posted in Javascript onMarch 31, 2015

这两天在写基于WCF服务的后台框架，过程中遇到了一些挫折，经过努力全部解决了，在此分享给大家，使用的工具是Visual Studio 2013。

该后台需要支持通过json来传递和接收数据。

首先，说说搭建过程。

第一步：创建WCF服务应用程序项目WCF。

jQuery Ajax调用WCF服务详细教程

第二步，创建服务使用的数据类

using System;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using System.Runtime.Serialization;

namespace WCF
{
  [DataContract]
  [Table("TUser")]
  public class Person
  {
    [DataMember]
    public int ID { get; set; }

    [DataMember]
    [StringLength(100)]
    public string LoginName { get; set; }

    [DataMember]
    [StringLength(100)]
    public string Password { get; set; }

    [DataMember]
    [DataType(DataType.Date)]
    public DateTime CreateDate { get; set; }
  }
}

这里，由于我使用EF来与数据库交互，所以使用了Table、StringLength、DataType。若你未使用EF，可以不加这些。DataContract是用来标志当前类在序列化时需要参考DataMember属性，若不设DataContract或仅设置DataMember，则所有共有属性和字段全部序列化，否则，只对设置有DataMember的序列化。注意，DataContract和DataMember与反序列化无关，也就是说，当把一个json对象字符串传递给WCF服务时，不管该字段上是否有DataMember，都会被反序列化。

第三步：创建服务契约接口

如果你的服务仅仅用来提供Ajax等一些非WCF客户端访问的，那么是不需要接口的，把接口定义中的各种Attribute直接加在服务提供的类的定义上即可。但是为了能让程序可以通过服务接口来访问，那么必须使用接口，例如：前端MVC+后台WCF的架构形式。

using System.Collections.Generic;
using System.ServiceModel;
using System.ServiceModel.Web;

namespace WCF
{
  [ServiceContract]
  public interface IPersonService
  {
    [OperationContract]
    [WebInvoke(Method = "POST", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.WrappedRequest)]
    Person CreatePerson(string loginName, string password);

    //服务功能2
    [OperationContract]
    [WebGet(RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.WrappedRequest)]
    bool CheckMan(string loginName);
  }
}

第四步，创建基于契约接口提供实际服务的类

jQuery Ajax调用WCF服务详细教程

由于我的服务需要支持Ajax，所以选择“WCF服务（支持Ajax）”一项，具体代码如下：

using System;
using System.Collections.Generic;
using System.ServiceModel.Activation;

namespace WCF
{
  [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
  public class PersonService : IPersonService
  {
    public Person CreatePerson(string loginName, string password)
    {
      return new PersonBLL().CreatePerson(loginName,password);
    }

    public bool CheckMan(string loginName)
    {
      return new PersonBLL().CheckMan(loginName);
    }
  }
}

上述的PersonBLL是用来实际处理数据的业务逻辑层，有兴趣的伙伴们可以自己写个简单的实现。

第五步，创建网页客户端。

在此为了避免处理跨域问题，故把网页post_get_test.html放在WCF项目下。

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <script type="text/javascript" src="jquery-1.10.2.js"></script>
  <script type="text/javascript" src="jqueryjson.js"></script>
  <title></title>
</head>
<body>
  <p>
    <input id="createPerson" type="button" value="POST_CreatePerson" /><br>
    <input id="checkMan" type="button" value="GET_CheckMan" /><br>

    <input type="text" id="loginName" />
    <input type="text" id="password" />
  </p>
  <script type="text/javascript">
    $(document).ready(function () {
      $('#createPerson').click(function () {
        $.ajax({
          type: "post",
          url: "personservice.svc/CreatePerson",
          data: '{"loginName":"' + $("#loginName").val() + '","password":"' + $("#password").val() + '"}',
          contentType: "application/json; charset=utf-8",
          dataType: "json",
          success: function (data) {
            alert("ID:" + data.d.ID + " Name:" + data.d.LoginName + " Password:" + data.d.Password + " CreateDate:" + data.d.CreateDate);
          },
          error: function (xhr) {
            alert(xhr.responseText);
          }
        });
      });

      $('#checkMan').click(function () {
        $.getJSON("PersonService.svc/CheckMan", 'loginname="' + $("#loginName").val() + '"',
          function (data) {
            alert(data.d);
          });
      });
    });
  </script>
</body>
</html>

建议在开发过程中采纳createPerson按钮调用方式来写，其可以通过error回调函数来反馈实际出错原因，方便调试。

第六步，发布WCF服务

右击WCF项目选择“发布”菜单项，在弹出窗口中的下拉列表中选择“新建配置文件”，输入配置文件名称，点击“确定”按钮后进入连接设置界面，如下：

jQuery Ajax调用WCF服务详细教程'

我是发布在本机的IIS中，故选择Web Deply发布方法，同时，这里建议服务器和站点名称设置成：localhost和default web site/XXX，这里XXX可以由你自己定义个服务站点的名字（实际就是IIS默认站点的虚拟目录名称），这样，你的开发伙伴获取到该项目源码后，能发布到完全相同的环境中，避免由于环境的差异延伸出一系列问题。

设置完毕后，点击“验证连接”，出现绿色的钩钩，说明设置正确，点击“发布”即可。

第七步，实测

1、现在可以通过浏览器访问http://localhost/wcf/personservice.svc来确认服务器端是否部署成功，出现如下界面说明部署成功。

jQuery Ajax调用WCF服务详细教程

2、通过浏览器访问测试网页http://localhost/wcf/post_get_test.html来检查功能是否OK。

其次，下面说说我在搭建过程中出现的各种问题。

1、网页通过Ajax调用服务的CreatePerson方法时把方法类型写错了，POST写成了GET，结果系统报：405 (Method Not Allowed)。另外，根据微软官网中描述，若通过soap访问一个WCF WEB HTTP应用程序（使用 WebHttpBinding 和 WebHttpBehavior 的服务）也会出现405错误。

2、web.config文件中endpoint节点的contract属性配置错误，没有指向WCF.IPersonService，网页执行时报：500 (System.ServiceModel.ServiceActivationException)；在用http://localhost/wcf/personservice.svc检验服务器端部署结果时，报：在服务“PersonService”实现的协定列表中找不到协定名称“VME.Contract.PersonService”。

这里需要说明的是若你的服务不是基于接口的，则endpoint的contract直接指向服务类即可。

3、在使用jQuery的ajax并以POST方式传值给服务器时，由于格式错误，报如下错误：500 (Internal Server Error)，详细信息为：格式化程序尝试对消息进行反序列化时引发异常。正确的有两种处理方式：

1）以json格式对象的方式传递，例如：

{"loginName":"name","password":"pwd"}

这里要强调的是键值对中，键必须加双引号，且大小写必须与服务方法中的形参定义完全一样。
2）以json格式对象字符串的形式传递，具体如下：

POST方式传值

A）传入非对象参数：

{"loginName":"name","password":"pwd"}'

这里要强调的是键值对中，键必须加双引号，且大小写必须与服务方法中的形参定义完全一样，值应按如下规则设置：字符串加双引号。
B）传入对象参数：

var person = {};

person.LoginName = $("#loginName").val();

person.Password = $("#password").val();

var jsonPerson = '{"person":' + $.toJSON(person) + '}';

这里要强调的是对象属性名称的大小写必须与数据类的属性定义完全一致。

GET方式传值

A）传入非对象参数：

'loginname="name"'

B）传入对象参数：

var person = {};

person.LoginName = $("#loginName").val();

person.Password = $("#password").val();

var jsonPerson = 'person=' + $.toJSON(person);

最后，说说WCF调试。

1、建议首先通过访问http://localhost/wcf/personservice.svc的形式确认服务器端部署成功，再进行客户端和服务器端联调。

2、若需要代码从客户端运行开始直到服务器端运行进行联调，则必须使用同步调用，因此，使用jQuery的ajax时，必须将async设置为false。

jQuery Ajax调用WCF服务详细教程

- Author -

junjie

声明：登载此文出于传递更多信息之目的，并不意味着赞同其观点或证实其描述。

Javascript 相关文章推荐
javascript 通用简单的table选项卡实现
May 07 Javascript
JavaScript的document对象和window对象详解
Dec 30 Javascript
jQuery学习笔记 操作jQuery对象 文档处理
Sep 19 Javascript
一样的table？不一样的table(可编辑状态table)
Sep 19 Javascript
javascript学习(一)构建自己的JS库
Jan 02 Javascript
javascript游戏开发之《三国志曹操传》零部件开发(三)情景对话中仿打字机输出文字
Jan 23 Javascript
js 验证密码强弱的小例子
Mar 21 Javascript
JS实现仿Windows经典风格的选项卡Tab切换代码
Oct 20 Javascript
详解angular2采用自定义指令（Directive）方式加载jquery插件
Feb 09 Javascript
JavaScript正则表达式校验与递归函数实际应用实例解析
Aug 04 Javascript
vue+mockjs模拟数据实现前后端分离开发的实例代码
Aug 08 Javascript
Jquery使用each函数实现遍历及数组处理
Jul 14 jQuery
JavaScript父子窗体间的调用方法
Mar 31 #Javascript
JavaScript操作cookie类实例
Mar 31 #Javascript
javascript实现简单的贪吃蛇游戏
Mar 31 #Javascript
javascript制作2048游戏
Mar 30 #Javascript
JavaScript模拟实现继承的方法
Mar 30 #Javascript
jQuery制作可自定义大小的拼图游戏
Mar 30 #Javascript
JS实现向表格中动态添加行的方法
Mar 30 #Javascript
Windows server 2008(5) Windows server 2019(5) http(6) Telnet(1) https(7) IIS(7) 远程登录(2) Windows server 2016(6) 远程控制(1) 动静分离(1)
You might like
windows下升级PHP到5.3.3的过程及注意事项
2010/10/12 PHP
php中3种方法统计字符串中每种字符的个数并排序
2012/08/27 PHP
php实现的单一入口应用程序实例分析
2015/09/23 PHP
php反序列化长度变化尾部字符串逃逸(0CTF-2016-piapiapia)
2020/02/15 PHP
使用prototype.js 的时候应该特别注意的几个问题.
2007/04/12 Javascript
Google韩国首页图标动画效果
2007/08/26 Javascript
javascript 数组学习资料收集
2010/04/11 Javascript
IE、FF浏览器下修改标签透明度
2014/01/28 Javascript
jQuery的缓存机制浅析
2014/06/07 Javascript
Node.js实现简单聊天服务器
2014/06/20 Javascript
JS实现在页面随时自定义背景颜色的方法
2015/02/27 Javascript
JavaScript数值千分位格式化的两种简单实现方法
2016/08/01 Javascript
AngularJS 中的Promise --- $q服务详解
2016/09/14 Javascript
浅谈JavaScript的闭包函数
2016/12/08 Javascript
JavaScript中localStorage对象存储方式实例分析
2017/01/12 Javascript
JavaScript实现按键精灵的原理分析
2017/02/21 Javascript
jQuery实现新闻播报滚动及淡入淡出效果示例
2018/03/23 jQuery
js比较两个单独的数组或对象是否相等的实例代码
2019/04/28 Javascript
JS代码触发事件代码实例
2020/01/02 Javascript
python正则匹配抓取豆瓣电影链接和评论代码分享
2013/12/27 Python
python实现简单的socket server实例
2015/04/29 Python
KMP算法精解及其Python版的代码示例
2016/06/01 Python
numpy的文件存储.npy .npz 文件详解
2018/07/09 Python
Python math库 ln(x)运算的实现及原理
2019/07/17 Python
Python使用Excel将数据写入多个sheet
2020/05/16 Python
实现ECharts双Y轴左右刻度线一致的例子
2020/05/16 Python
Python新手学习装饰器
2020/06/04 Python
在tensorflow下利用plt画论文中loss,acc等曲线图实例
2020/06/15 Python
中文专业学生自我评价范文
2014/02/06 职场文书
《从现在开始》教学反思
2014/04/15 职场文书
廉洁家庭事迹材料
2014/05/15 职场文书
天气温馨提示语
2015/07/14 职场文书
结婚十年感言
2015/07/31 职场文书
教师正风肃纪心得体会
2016/01/15 职场文书
导游词之无锡丝业博物馆
2019/11/12 职场文书
MySQL大小写敏感的注意事项
2021/05/24 MySQL