欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

全面解析$.Ajax()方法参数(推荐)

程序员文章站 2023-02-21 22:01:07
先给大家介绍下ajax概念 ajax即“asynchronous javascript and xml”(异步javascript和xml),是指一种创建交互式网页应用的...

先给大家介绍下ajax概念

ajax即“asynchronous javascript and xml”(异步javascript和xml),是指一种创建交互式网页应用的网页开发技术。

ajax = 异步 javascript和xml(标准通用标记语言的子集)。

ajax 是一种用于创建快速动态网页的技术。

通过在后台与服务器进行少量数据交换,ajax 可以使网页实现异步更新。这意味着可以在不重新加载整个网页的情况下,对网页的某部分进行更新。

传统的网页(不使用 ajax)如果需要更新内容,必须重载整个网页页面。

ajax方法

$.ajax()方法是jquery最底层的ajax实现。它的结构为:

  $.ajax(options)

该方法只有一个参数,但是这个对象里包含了$.ajax()方法所需要的请求设置以及回调函数等信息,参数以key/value的形式存在,所有的参数都是可选的。常用参数见下表:

1.url

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

2.type

要求为string类型的参数,请求方式(post或get)默认为get。注意其他http请求方法,例如put和delete也可以使用,但仅部分浏览器支持。

3.timeout

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

4.async

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

5.cache

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

6.data

要求为object或string类型的参数,发送到服务器的数据。如果不是字符串,将自动转换为字符串格式。get请求中将附加在url后。防止这种自动转换,可以查看  processdata选项。对象必须为key/value格式,例如{foo1:"bar1",foo2:"bar2"}转换为&foo1=bar1&foo2=bar2。如果是数组,jquery将自动为不同值对应同一个名称。例如{foo:["bar1","bar2"]}转换为&foo=bar1&foo=bar2。

7.datatype

要求为string类型的参数,预期服务器返回的数据类型。如果不指定,jquery将自动根据http包的mine信息返回responsexml或responsetext,并作为回调函数参数传递。可用的类型如下:

  xml:返回xml文档,可用jquery处理。

  html:返回纯文本html信息;包含的script标签会在插入dom时执行。

  script:返回纯文本javascript代码。不会自动缓存结果,除非设置了cache参数。注意在远程请求时(不在同一个域下),所有post请求都将转为get请求。

  json:返回json数据。

  jsonp:json格式。使用jsonp形式调用函数时,例如myurl?callback=?,jquery将自动替换后一个“?”为正确的函数名,以执行回调函数。

  text:返回纯文本字符串。

8.beforesend

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

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

9.complete

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

  function(xmlhttprequest,textstatus){
    this; //调用本次ajax请求时传递的options参数
  }

10.success

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

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

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

  function(data,textstatus){
    //data可能是xmldoc、jsonobj、html、text等
    this; //调用本次ajax请求时传递的options参数
  }

11.error

要求为function类型的参数,请求失败时被调用的函数。该函数有3个参数,即xmlhttprequest对象、错误信息、捕获的错误对象(可选)。ajax事件函数如下:

  function(xmlhttprequest,textstatus,errorthrown){
    //通常情况下textstatus和errorthrown只有其中一个包含信息
    this; //调用本次ajax请求时传递的options参数
  }

12.contenttype

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

13.datafilter

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

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

14.global

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

15.ifmodified

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

16.jsonp

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

17.username

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

18.password

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

19.processdata

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

20.scriptcharset

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

案例代码:

$(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);
   }
  });
 });
});

知识链接:

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

  $.each(data,function(commentindex,comment){
  //dosomething;
 })

2、ajaxstart()与ajaxstop():当ajax请求开始时,会触发ajaxstart()方法的回调函数。当ajax请求结束时,会触发ajaxstop()方法的回调函数。这些方法都是全局的方法,因此无论创建它们的代码位于何处,只要有ajax请求发生时,就会触发它们。

有时候页面需要加载一些图片,可能速度回比较慢,如果在加载过程中,不给用户提供一些提示和反馈信息,很容易让用户误认为按钮单击无用,使用户对网站失去信息。

此时,我们就需要为网页添加一个提示信息,常用的提示信息是“加载中...”,代码如下:

<div id="loading">加载中...</div>

当ajax请求开始时,将此元素显示,用来提示用户ajax请求正在进行;当ajax请求结束后,将此元素隐藏。代码如下:

$("#loading").ajaxstart(function(){
    $(this).show();
  }).ajaxstop(function(){
 $(this).hide();
 })

好了,下面再给大家分享一个案例代码:

$(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);
   }
  });
 });
});

end,代码到此结束。

以上所述是小编给大家介绍的全面解析$.ajax()方法参数(推荐),希望对大家有所帮助