首页 前端知识 jquery中的ajax请求方式的写法 & 重要且常用参数的释义 & ajax返回值,return获取不到数据值

jquery中的ajax请求方式的写法 & 重要且常用参数的释义 & ajax返回值,return获取不到数据值

2024-06-25 23:06:59 前端知识 前端哥 627 733 我要收藏

jquery中的ajax请求方式的写法 & 重要且常用参数的释义 & ajax返回值,return获取不到数据值

1、ajax写法

示例

$.ajax({
	url:  "请求路径",
	type: "post",  // type: "GET",
	contentType: "application/json; charset=utf-8",
	data: JSON.stringify({
		id:'12',
		name:'姓名'
	}),  //将json对象转为json字符串
	dataType: "json", //表示接受的数据为json类型
	success: function (data) {
		// 请求成功后执行的代码
		if (data.success) {
			
		} else {    
			
		}
	},
	error: function(){  
	
	}
});

示例1-常用
/**
 * 获取选中单位的图层数据
 * @param {String} id - 选中单位的id
 * return  {Object} result - 选中单位的图层数据
*/
function getLayerData(id) {
	var result;
	$.ajax({
		url: origin + "/bigscreen/home/getDeptRiskInfoById",
		async: false,
		type: "GET",
		data: {
			deptId: id,
		},
		headers: { "token": token },
		success: function (data) {
			result = data
		}
	});
	return result;
}
附:关于ajax中return的问题

jquery中,ajax返回值,获取不到值

两种原因会导致这种情况:1、ajax未用同步;2、在ajax方法中直接return返回值

解决方案:

把要返回的result定义在ajax外面,在ajax内部对result赋值,然后 在ajax外部用return,

示例

function checkAccount3(){
    var result = "3:2";
    $.ajax({
        url : path+'/user/checkAccount.do',
        type : "post",
        data : {},
        async : false,
        success : function(data) {
            result = "3:1";
        }
    });
    return result;
}
示例2
function loadUnitData(callback) { 
    $.ajax({
        url: origin + "/bigscreen/home/treeselectNoScope",
        type: "GET",
        headers: {"token": token}
    }).done(function( data ) {
        if(callback) {
            callback(data.data)
        }
    });
}

loadUnitData(function (unit) {
    loadTree(unit);
})

function loadTree(unit) {
    console.log(unit)
})
示例3
$(function(){
    $('#send').click(function(){
         $.ajax({
             type: "GET",
             url: "test.json",
             data: {username:$("#username").val(), content:$("#content").val()},
             dataType: "json",
             success: function(data){
                         $('#resText').empty();   //清空resText里面的所有内容
                         var html = ''; 
                         $.each(data, function(commentIndex, comment){
                               html += '<div class="comment"><h6>' + comment['username']
                                         + ':</h6><p class="para"' + comment['content']
                                         + '</p></div>';
                         });
                         $('#resText').html(html);
                      }
         });
    });
});
2、常用参数
2.1、url

要求为String类型的参数,(默认为当前页地址)发送请求的地址。

就是在此发送需求到对应的后台去处理,后台根据这个url来区别不同的请求。

2.2、type-get和post

要求为String类型的参数,请求方式(post或get)默认为get

注意其他http请求方法,例如put和delete也可以使用,但仅部分浏览器支持。

  • post:

浏览器把各表单字段元素及其数据作为HTTP消息的实体内容发送给Web服务器,数据量要比使用GET方式传送的数据量大的多,安全。

  • get:

get方式可传送简单数据,有大小限制,数据追加到url中发送(http的header传送),url可以被客户端缓存,从浏览器的历史记录中得到客户数据,不安全。

2.3、async-同步false、异步true

要求为Boolean类型的参数,默认设置为true,所有请求均为异步请求。

如果需要发送同步请求,请将此选项设置为false。

注意,同步请求将锁住浏览器,用户其他操作必须等待请求完成才可以执行。

2.4、data

发送到服务器的数据,要求为Object或String类型的参数。

如果已经不是字符串,将自动转换为字符串格式。get请求中将附加在url后。

防止这种自动转换,可以查看processData选项。

对象必须为key/value格式。如果是数组,JQuery将自动为不同值对应同一个名称。

// 对象必须为key/value格式。例如:
{
    id:"12",
    name:"小红"
}
=>&id=12&name=小红。  //  中文会乱码

// 如果是数组,JQuery将自动为不同值对应同一个名称。例如:
{
    user:["13","china"]
} 
=> &user=13&user=china。
2.5、dataType

要求为String类型的参数,预期服务器返回的数据类型。

如果不指定,JQuery将自动根据http包mime信息返回responseXML或responseText,并作为回调函数参数传递。

  • 常用类型:
    • xml:返回XML文档,可用JQuery处理。
    • html:返回纯文本HTML信息;包含的script标签会在插入DOM时执行。
    • script: 返回纯文本JavaScript代码。不会自动缓存结果。除非设置了cache参数。注意在远程请求时(不在同一个域下),所有post请求都将转为get请求。
    • json:返回JSON数据。如果指定为json类型,则会把获取到的数据作为一个JavaScript对象来解析,并且把构建好的对象作为结果返回。
    • jsonp: JSONP格式。使用SONP形式调用函数时,例如myurl?callback=?,JQuery将自动替换后一个“?”为正确的函数名,以执行回调函数。
    • text:返回纯文本字符串。
2.6、success

要求为Function类型的参数,请求成功后调用的回调函数,有两个参数。

(1) 由服务器返回,并根据dataType参数进行处理后的数据。

(2) 描述状态的字符串。

function(data, textStatus){
    this;  //调用本次ajax请求时传递的options参数
}
  • data就是后台处理之后,返回的一个javascript对象,里面包含前台需要的各种信息,需要什么塞什么,

    data可能是xmlDoc、jsonObj、html、text等等

2.7、error

要求为Function类型的参数,请求失败时被调用的函数。该函数有3个参数,即XMLHttpRequest对象、错误信息、捕获的错误对象(可选)。

// ajax事件函数如下:
function(XMLHttpRequest, textStatus, errorThrown){
   //通常情况下textStatus和errorThrown只有其中一个包含信息
   this;   //调用本次ajax请求时传递的options参数
}
2.8、contentType

要求为String类型的参数,当发送信息至服务器时,内容编码类型默认为"application/x-www-form-urlencoded"。该默认值适合大多数应用场合。

  • multipart/form-data:有时候也会这个,上传下载可能会用到。
  • contentType: “application/json; charset=utf-8” 这个也可能常会用到。
2.9、timeout

要求为Number类型的参数,设置请求超时时间(毫秒)。此设置将覆盖$.ajaxSetup()方法的全局设置。

2.10、async

要求为Boolean类型的参数,默认设置为true,所有请求均为异步请求。如果需要发送同步请求,请将此选项设置为false。注意,同步请求将锁住浏览器,用户其他操作必须等待请求完成才可以执行。

错误示例

制作注册表单验证时我们需要通过ajax请求数据,例如我们需要请求数据库中的用户名判断是否存在,这时我们就需要return,再者我们很多时候需要使用数据库中的数据,这时我们也需要将数据返回出去。

var getAjax = function (successFn, failFn) {
    var callBackReturn;
    // 发送ajax请求
    $.ajax({
        type: "POST",
        url: "checkName.php",
        data: {
            username: $inputVal
        },
        success: function (responseText) {
            if (responseText === "denied") {
                // 若已存在
                return false;
            } else {
                return true;
            }
        }
    });
};

我们我们发送了一个异步请求来验证输入的用户名,但结果却没有想的那样返回true or false,却返回了undefined;这是因为你发送了异步请求,但请求的数据还没返回回来,就已经执行到return语句,自然就返回了undefined。

正确示例

我们需要将异步请求变为同步,用回调函数来发送return值,并在ajax的success回调中用变量存储返回值。

var getAjax = function (successFn, failFn) {
    var callBackReturn;
    // 发送ajax请求
    $.ajax({
        type: "POST",
        url: "checkName.php",
        // 发送同步请求
        async: false,
        data: {
            username: $inputVal
        },
        success: function (responseText) {
            if (responseText === "denied") {
                $tipObj.html(tipText[2]);
                callBackReturn = failFn();
            } else {
                $tipObj.html(tipText[3]);
                callBackReturn = successFn();
            }
        }
    });
    return callBackReturn;
};
2.11、cache

要求为Boolean类型的参数,默认为true(当dataType为script时,默认为false),设置为false将不会从浏览器缓存中加载请求信息。

2.12、beforeSend

要求为Function类型的参数,发送请求前可以修改XMLHttpRequest对象的函数,例如添加自定义HTTP头。在beforeSend中如果返回false可以取消本次ajax请求。XMLHttpRequest对象是惟一的参数。

function(XMLHttpRequest){
    this;   //调用本次ajax请求时传递的options参数
}
2.13、complete

要求为Function类型的参数,请求完成后调用的回调函数(请求成功或失败时均调用)。参数:XMLHttpRequest对象和一个描述成功请求类型的字符串。

function(XMLHttpRequest, textStatus){
    this;    //调用本次ajax请求时传递的options参数
}
2.14、dataFilter

要求为Function类型的参数,给Ajax返回的原始数据进行预处理的函数。提供data和type两个参数。data是Ajax返回的原始数据,type是调用jQuery.ajax时提供的dataType参数。函数返回的值将由jQuery进一步处理。

function(data, type){
    //返回处理后的数据
    return data;
}
2.15、global

要求为Boolean类型的参数,默认为true。表示是否触发全局ajax事件。设置为false将不会触发全局ajax事件,ajaxStart或ajaxStop可用于控制各种ajax事件。

2.16、ifModified

要求为Boolean类型的参数,默认为false。仅在服务器数据改变时获取新数据。服务器数据改变判断的依据是Last-Modified头信息。默认值是false,即忽略头信息。

2.17、jsonp

要求为String类型的参数,在一个jsonp请求中重写回调函数的名字。该值用来替代在"callback=?"这种GET或POST请求中URL参数里的"callback"部分,例如{jsonp:‘onJsonPLoad’}会导致将"onJsonPLoad=?"传给服务器。

2.18、username

要求为String类型的参数,用于响应HTTP访问认证请求的用户名。

2.19、password

要求为String类型的参数,用于响应HTTP访问认证请求的密码。

2.20、processData

要求为Boolean类型的参数,默认为true。默认情况下,发送的数据将被转换为对象(从技术角度来讲并非字符串)以配合默认内容类型"application/x-www-form-urlencoded"。如果要发送DOM树信息或者其他不希望转换的信息,请设置为false。

2.21、scriptCharset

要求为String类型的参数,只有当请求时dataType为"jsonp"或者"script",并且type是GET时才会用于强制修改字符集(charset)。通常在本地和远程的内容编码不同时使用。

3、 $.each()函数

$.each()函数不同于JQuery对象的each()方法,它是一个全局函数,不操作JQuery对象,而是以一个数组或者对象作为第1个参数,以一个回调函数作为第2个参数。回调函数拥有两个参数:第1个为对象的成员或数组的索引,第2个为对应变量或内容。

转载请注明出处或者链接地址:https://www.qianduange.cn//article/13530.html
标签
评论
发布的文章

JSON、Ajax

2024-07-27 22:07:31

JsonNode、ObjectNode和ArrayNode

2024-07-27 22:07:30

大家推荐的文章
会员中心 联系我 留言建议 回顶部
复制成功!