甩掉 ashx/asmx,使用jQuery.ajaxWebService请求WebMethod,Ajax处理更加简练

在WebForm下 开发ajax程序,需要借助于一般处理程序(*.ashx)或web服务(*.asmx),并且每一个ajax请求,都要建一个这样的文件,如此一来,如果在一个项目中ajax程序多了,势必会产生一堆的.ashx或.asmx,虽然于程序本身无碍,但那一堆文件看上去总觉得有伤大雅。那么可不可以丢掉这些.ashx和.asmx,选择一种更简练的方式来做ajax程序呢。
答案是肯定的,那就是:WebMethod 。(此方法是在.net3.5版本下调试的,在.net2.0下有问题)

 
首先在aspx.cs文件里建一个公开的静态方法,然后加上WebMethod属性。

[WebMethod]

 public static string GetUserName() 

 {

 //......

 }

  
 如果要在这个方法里操作session,那还得将WebMethod的EnableSession 属性设为true 。即:

[WebMethod(EnableSession = true)]//或[WebMethod(true)]

 public static string GetUserName() 

 {

 //......

 }


 然后我们就写ajax程序来访问这个程序,我们就用jQuery吧。

   $.ajax({

        type: "POST",

        contentType: "application/json",

        url: "WebForm2.aspx/GetUserName",

        data: "{}",

        dataType: "json",

        success: function(){.......}

    });

  这里对几个参数做一下简单的说明,
  type:请求的类型,这里必须用post 。WebMethod方法只接受post类型的请求。
  contentType:发送信息至服务器时内容编码类型。我们这里一定要用application/json 。
  url:请求的服务器端处理程序的路径,格式为"文件名(含后缀)/方法名"
  data:参数列表。注意,这里的参数一定要是json格式的字符串,记住是字符串格式,如:"{aa:11,bb:22,cc:33 , ...}"。如果你写的不是字符串,那jquery会把它实序列化成字符串,那么在服务器端接受到的就不是json格式了,且不能为空,即使没有参数也要写成"{}",如上例。
很多人不成功,原因就在这里。
  dataType:服务器返回的数据类型。必须是json,其他的都无效。因为webservice 是一json格式返回数据的,其形式为:{"d":"......."}。
  success:请求成功后的回调函数。你可以在这里对返回的数据做任意处理。

  我们可以看到其中一些参数值是固定的,所以从复用性的角度考虑,我们可以给jquery做一个扩展,对上面的函数做一下简单的封装:
我们建一个脚本文件叫 jquery.extend.js。在里面写一个叫ajaxWebService的方法(因为webmethod其实就是WebService嘛,故此方法对请求*.asmx也是有效的),代码如下:

///    <summary>

///    jQuery原型扩展,重新封装Ajax请求WebServeice

///    </summary>

///    <param name="url" type="String">

///     处理请求的地址

///</param>

///    <param name="dataMap" type="String">

///     参数,json格式的字符串

///</param>

///    <param name="fnSuccess" type="Function">

///     请求成功后的回调函数

///</param>

$.ajaxWebService = function(url, dataMap, fnSuccess) {

    $.ajax({

        type: "POST",

        contentType: "application/json",

        url: url,

        data: dataMap,

        dataType: "json",

        success: fnSuccess

    });

}

好了,这样我们请求webmethod方法 就可以这样写了:

 

$.ajaxWebService("WebForm2.aspx/GetUserName", "{}", function(result) {......});


 

最后:如果你的项目中ajax程序非常多(这种情况是可能存在的,我做过一个网站,是个sns,全程ajax,几乎每个操作都用了ajax),
 你觉得把WebMethod方法写在各个aspx页面里很零散,那么你可以专门建一个页面(如:WebMethods.aspx)来存放。
 

源码下载 

原文地址:http://www.cnblogs.com/xumingxiang/archive/2010/05/04/1727609.html

你可能感兴趣的:(webservice)