分析Ajax发送请求的详细属性和一些坑
比较基础的一个ajax请求
这个data是json化过的数据
$.ajax({
url: 'http://127.0.0.1:5000/api/v1.0/verify_code/',
type: 'POST',
data: data,
success: function (data) {
alert('ok');
console.log(data);
location.href = '/index.html'
},
error: function (data) {
alert('失败');
console.log(data)
}
})
ajax保持状态
这个是session保持状态用
xhrFields: {
withCredentials: true
},
ajax发送formdata数据
如果是form表单发送就直接使用,选择器是form表单即可
data: $('#form1').serialize(),
如果不是form表单数据想要发送form表单
var phone = $('#phone_number').val();
// 发送from-data格式内容
var form_data = new FormData();
form_data.enctype="multipart/form-data";
// 添加内容
form_data.append('phone', phone);
$.ajax({
url: 'http://127.0.0.1:5000/api/v1.0/msg_code/',
type: 'POST',
data: form_data,
processData: false,
contentType: false,
)}
ajax添加csrftoken保护请求头
$.ajax({
...
headers: {"X-CSRFToken": getCookie("csrf_token")},
...
})
function getCookie(name) {
var r = document.cookie.match("\\b" + name + "=([^;]*)\\b");
return r ? r[1] : undefined;
}
详细属性解析
比较常用的属性:
属性 | 功能 |
---|---|
url | 请求的url,(默认为当前地址)发送请求的页面。 |
type | http请求消息的方法,例如get,post,put,delete等。 |
contentType | http请求消息的数据类型,例如json,text,xml等。 |
data | 要求为Object或String类型的参数,发送到服务器的数据。如果不是字符串,将自动转换为字符串格式。get请求中将附加在URL后。防止这种自动转换,可以查看processData选项。对象必须为key/value格式,例如{foo1:“bar1”,foo2:“bar2”}转换为&foo1=bar1&foo2=bar2。如果是数组,JQuery将自动为不同值对应同一个名称。例如{foo:[“bar1”,“bar2”]}转换为&foo=bar1&foo=bar2。 |
比较高级的属性
属性 | 功能 |
---|---|
timeout | 要求为Number类型的参数,设置请求超时时间(毫秒)。此设置将覆盖$.ajaxSetup()方法的全局设置。 |
async | 要求为Boolean类型的参数,默认设置为true,所有请求均为异步请求。如果需要同步请求,请将此选项设置为false。注意,同步请求将锁住浏览器,用户其他操作必须等待请求完成才可以执行。 |
cache | 要求为Boolean类型的参数,默认为true(当dataType为Script时,默认为false),设置false将不会从浏览器缓存中加载请求信息。 |
dataType | 要求为String类型的参数,预期服务器返回的数据类型。如果不指定,jQuery将自动根据HTTP包的mine信息返回responseXML或responseText,并作为回调函数参数传递。可用的类型如下: |
dataType | xml:返回XML文档,可用jQuery处理。 |
dataType | html:返回纯文本HTML信息;包含的script标签会在插入DOM时执行。 |
dataType | script:返回纯文本javascript代码。不会自动缓存结果,除非设置了cache参数。注意在远程请求时(不在同一个域下),所有post请求都将转为get请求。 |
dataType | json:返回JSON数据。 |
dataType | jsonp:JSON格式。使用JSONP形式调用函数时,例如myurl?callback=?,JQuery将自动替换后一个“?”为正确的函数名,以执行回调函数。 |
dataType | text:返回纯文本字符串。 |
beforeSend | 要求为Function类型的参数,发送请求前可以修改XMLHttpRequest对象的函数,例如添加自定义HTTP头。在beforeSend中如果返回false可以取消本次ajax请求。XMLHttpRequest对象是唯一的参数。function(XMLHttpRequest){this;//调用本次ajax请求时传递的options参数} |
complete | 要求为Function类型的参数,请求完成后调用的回调函数(请求成功或失败均调用)。参数:XMLHttpRequest对象和一个描述成功请求类型的字符串。function(XMLHttpRequest,textStatus){this; //调用本次ajax请求时传递的options参数} |
success | 要求为Function类型的参数,请求成功后调用的回调函数,有两个参数。(1)由服务器返回,并根据dataType参数进行处理后的数据。(2)描述状态的字符串。 function(data,textStatus){ //data可能是xmlDoc、jsonObj、html、text等this; //调用本次ajax请求时传递的options参数 } |
error | 要求为Function类型的参数,请求失败时被调用的函数。该函数有3个参数,即XMLHttpRequest对象、错误信息、捕获的错误对象(可选)。ajax事件函数如下:function(XMLHttpRequest,textStatus,errorThrown){ //通常情况下textStatus和errorThrown只有其中一个包含信息 this; //调用本次ajax请求时传递的options参数 } |
contentType | 要求为String类型的参数,当发送信息至服务器时。内容编码类型默认为"application/x-www-form-urlencoded"。该默认值适合大多数应用场合。 |
dataFilter | 要求为Function类型的参数,给Ajax返回的原始数据进行预处理的函数。提供data和type两个参数。data是Ajax返回的原始数据,type是调用jQuery.ajax时提供的dataTYpe参数。函数返回的值将由jQuery进一步处理。 |
global | 要求为Boolean类型的参数,默认为true。表示是否触发全局ajax事件。设置为false将不会触发全局ajax事件,ajaxStart和ajaxStop可用于控制各种ajax事件。 |
ifModified | 要求为Boolean类型的参数,默认为false。仅在服务器数据改变时获取新数据。服务器数据改变判断的依据是Last-Modified头信息。默认值是false,即忽略头信息。 |
sonp | 要求为String类型的参数,在一个jsonp请求中重写回调函数的名字。该值用来替代在"callback=?"这种GET或POST请求中URL参数里的"callback"部分,例如{jsonp:‘onJsonPLoad’}会导致将"onJsonPLoad=?"传给服务器。 |
username | 要求为String类型的参数,用于响应HTTP访问认证请求的用户。 |
password | 要求为String类型的参数,用于响应HTTP访问认证请求的密码。 |
processData | 要求为Boolean类型的参数,默认为true。默认情况下,发送的数据将被转换为对象(从技术角度来讲而非字符串)以配合默认内容类型"application/x-www-form-urlencoded"。如果要发送DOM树信息或者其他不希望转换的信息,请设置为false。 |
scriptCharset | 要求为String类型的参数,只有当请求时dataType为"jsonp"或者"script",并且type是GET时才会用于强制修改字符集(charset)。通常在本地和远程的内容编码不同时使用。 |