最近联系人用到的两个异步请求方法 $.ajax(),$.get()详解

最新推荐文章于 2022-12-07 18:01:22 发布

aitang2184

最新推荐文章于 2022-12-07 18:01:22 发布

阅读量145

点赞数

文章标签： javascript json ViewUI

原文链接：http://www.cnblogs.com/huanhuan8808/p/3153076.html

版权

参与公司的im项目也有一个月左右的时间。现在，好好整理下im联系人分组功能中，用到的方法。

1. $.ajax() 方法

ajax()方法，通过HTTP请求动态加载远程的数据。

该方法是 jQuery 底层 AJAX 实现。简单易用的高层实现见 $.get, $.post 等。$.ajax() 返回其创建的 XMLHttpRequest 对象。大多数情况下你无需直接操作该函数，除非你需要操作不常用的选项，以获得更多的灵活性。

语法：

$.ajax([settings]); /*参数 settings，可选的，可用于配置ajax请求的键值对集合*/

接下来重点介绍ajax()方法中的参数：

$.ajax() 只有一个参数：参数 key/value 对象，包含各配置及回调函数信息。详细参数选项见下。

参数名	类型	描述
url	String	(默认: 当前页地址) 发送请求的地址。
type	String	(默认: "GET") 请求方式 ("POST" 或 "GET")，默认为 "GET"。注意：其它 HTTP 请求方法，如 PUT 和 DELETE 也可以使用，但仅部分浏览器支持。
timeout	Number	设置请求超时时间（毫秒）。此设置将覆盖全局设置。
async	Boolean	(默认: true) 默认设置下，所有请求均为异步请求。如果需要发送同步请求，请将此选项设置为 false。注意，同步请求将锁住浏览器，用户其它操作必须等待请求完成才可以执行。
beforeSend	Function	发送请求前可修改 XMLHttpRequest 对象的函数，如添加自定义 HTTP 头。XMLHttpRequest 对象是唯一的参数。 function (XMLHttpRequest) { this; // the options for this ajax request }
cache	Boolean	(默认: true) jQuery 1.2 新功能，设置为 false 将不会从浏览器缓存中加载请求信息。
complete	Function	请求完成后回调函数 (请求成功或失败时均调用)。参数： XMLHttpRequest 对象，成功信息字符串。 function (XMLHttpRequest, textStatus) { this; // the options for this ajax request }
contentType	String	(默认: "application/x-www-form-urlencoded") 发送信息至服务器时内容编码类型。默认值适合大多数应用场合。
data	Object, String	发送到服务器的数据。将自动转换为请求字符串格式。GET 请求中将附加在 URL 后。查看 processData 选项说明以禁止此自动转换。必须为 Key/Value 格式。如果为数组，jQuery 将自动为不同值对应同一个名称。如 {foo:["bar1", "bar2"]} 转换为 '&foo=bar1&foo=bar2'。
dataType	String	预期服务器返回的数据类型。如果不指定，jQuery 将自动根据 HTTP 包 MIME 信息返回 responseXML 或 responseText，并作为回调函数参数传递，可用值: "xml": 返回 XML 文档，可用 jQuery 处理。 "html": 返回纯文本 HTML 信息；包含 script 元素。 "script": 返回纯文本 JavaScript 代码。不会自动缓存结果。 "json": 返回 JSON 数据。 "jsonp": JSONP 格式。使用 JSONP 形式调用函数时，如 "myurl?callback=?" jQuery 将自动替换 ? 为正确的函数名，以执行回调函数。
error	Function	(默认: 自动判断 (xml 或 html)) 请求失败时将调用此方法。这个方法有三个参数：XMLHttpRequest 对象，错误信息，（可能）捕获的错误对象。 function (XMLHttpRequest, textStatus, errorThrown) { // 通常情况下textStatus和errorThown只有其中一个有值 this; // the options for this ajax request }
global	Boolean	(默认: true) 是否触发全局 AJAX 事件。设置为 false 将不会触发全局 AJAX 事件，如 ajaxStart 或 ajaxStop 。可用于控制不同的Ajax事件
ifModified	Boolean	(默认: false) 仅在服务器数据改变时获取新数据。使用 HTTP 包 Last-Modified 头信息判断。
processData	Boolean	(默认: true) 默认情况下，发送的数据将被转换为对象(技术上讲并非字符串) 以配合默认内容类型 "application/x-www-form-urlencoded"。如果要发送 DOM 树信息或其它不希望转换的信息，请设置为 false。
success	Function	请求成功后回调函数。这个方法有两个参数：服务器返回数据，返回状态 function (data, textStatus) { // data could be xmlDoc, jsonObj, html, text, etc... this; // the options for this ajax request }

这里有几个Ajax事件参数：beforeSend ，success ，complete ，error 。我们可以定义这些事件来很好的处理我们的每一次的Ajax请求。注意一下，这些Ajax事件里面的 this 都是指向Ajax请求的选项信息的(请参考说 get() 方法时的this的图片)。

实例：

im分组联系人中的联系人渲染

render_contacts_list: function(){
        $.ajax({
            url: 'http://im.okhqb.com/get_groups',//请求数据的url地址
//求情成功时的回调函数 
            success: function( result ){          
                result = $.parseJSON( result );
                if( result.code == 200 ){
                    var data = result.data;
                    var group_box = '';
                    for(var i in data){    
                        group_box = '<div class="group_box">\
                                        <div class="sort_t" group_id="'+data[i].group_id+'" >\
                                          <span class="arrow"></span>\
                                          '+data[i].group_name+'\
                                          <a class="edit_group"  title="点击编辑该分组" style="display:none;"></a>\
                                          <a class="del_group"  style="display:none;" title="点击删除该分组"></a>\
                                         </div>\
                                         <ul class="sort_list"></ul>\
                                      </div>';
                        $("#cur_cList").append(group_box);    
                        group_box = '';                             
                   }
                  }else {
                  $("#cur_cList").append( '<strong>读取分组名称信息失败</strong>');
                }
            }
        });
        
        $.ajax({
          url:'http://im.okhqb.com/get_users_grouping_list',
          success: function( result ){
              result = $.parseJSON( result );
              if( result.code == 200 ){
                 var data = result.data;
                 for(var j in data ){
                    var gId = data[j].group_id; 
                    if( data[j].user_id && data[j].user_name ){
                        $(".sort_t[group_id = " + gId + "]").siblings(".sort_list").append( '<li><a class="_rc" href="javascript:;" uid="' + data[j].user_id + '" gid="' + data[j].group_id + '">' + data[j].user_name + '</a><a class="del_contact" style="display:none;" href="javascript:;" title="点击删除联系人" ></a></li>' );
                    }
                 }
              }else{
                  var gId1 = data[j].group_id; 
                  $(".sort_t[group_id =" + gId1 + "]").siblings(".sort_list").append('<li><strong>读取该分组联系人信息失败</strong></li>');
              }
          }    
        });
    },

这里提醒的一点是，返回来的数据类型，必须将它格式化为json数据类型。

结果是 result = $.parseJSON( result );

第二点，异步方法中是不能return的，因为是异步请求，所以，程序不会等到执行一行再执行return。

2. $.get()方法

使用get()方法进行异步请求

语法：

jQuery.get( url, [data], [callback] )：

或者是

$.get( url, [data], [callback] )：

参数

url (String)	发送请求的URL地址.
data (Map) :	(可选) 要发送给服务器的数据，以 Key/value 的键值对形式表示，会做为QueryString附加到请求URL中。
callback (Function) :	(可选) 载入成功时回调函数(只有当Response的返回状态是success才是调用该方法)。

这是一个简单的 GET 请求功能以取代复杂 $.ajax 。请求成功时可调用回调函数。如果需要在出错时执行函数，请使用 $.ajax()

实例1

 $.get("./Ajax.aspx", {Action:"get",Name:"lulu"}, function (data, textStatus){

//返回的 data 可以是 xmlDoc, jsonObj, html, text, 等等.
this; // 在这里this指向的是Ajax请求的选项配置信息，请参考下图
alert(data);

//alert(textStatus);//请求状态：success，error等等。

当然这里捕捉不到error，因为error的时候根本不会运行该回调函数
//alert(this);
});

实例2

im中的其他功能基本都是用$.get()方法进行数据交互的。

add_group: function( group_name ){
		$.get(
				  "http://im.okhqb.com/add_group?group_name=" + group_name,
				  function( result ){
					 result = $.parseJSON( result );
					 if( result.code == 200 ){
					   $("#cur_cList").html(""); 
					   Contact_grouping.render_contacts_list();
					   alert("添加分组成功");	 
					 }else{
					   alert("添加分组失败");
					 } 
				  }
		      );
	},

这是一个添加分组功能的get()请求。在回调函数中，对结果进行判断，做相应处理。

现在对ajax理解还是尚浅，未能理解透彻，后续跟进。

转载于:https://www.cnblogs.com/huanhuan8808/p/3153076.html