zoukankan      html  css  js  c++  java
  • $.ajax()详解

    前端开发难免会用到 $.ajax(),详细整理下各参数的含义,供以后查询参考。

    文章整合了 《https://www.cnblogs.com/tyler...》 和 《https://www.cnblogs.com/huyue...》。


    一、$.ajax( ){ }函数格式如下:
    
    $.ajax({
        url: "test.aspx?r=" + Math.random(),
        type: "GET",
        data: {},
        dataType: "json",
        async: false,  // 默认是true
        success: function (result) {
            var coin = result["coin"];
            var stage = result["stage"];
            document.write("金币:" + coin + "个,身份:" + stage);
        }
    });
    
    二、参数具体含义:

    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类型的参数,发送到服务器的数据。如果已经不是字符串,将自动转换为字符串格式。本质上还是String类型。(w3school中只说明了这一种类型)
    get请求中,data将附加在url后。防止这种自动转换,可以查看processData选项。对象必须为key/value格式,例如{foo1:"bar1",foo2:"bar2"}转换为&foo1=bar1&foo2=bar2。如果是数组,JQuery将自动为不同值对应同一个名称。例如{foo:["bar1","bar2"]}转换为&foo=bar1&foo=bar2。

    7.dataType:
    要求为String类型的参数,预期服务器返回的数据类型,将根据该指定类型解析返回数据,如果这里数据类型不match,比如指定json,但服务器返回的type是html,即使状态码是200 ok,也会走到error里面。
    如果不指定,JQuery将自动根据http包mime信息返回responseXML或responseText,并作为回调函数参数传递。

    可用的类型如下:
    xml:返回XML文档,可用JQuery处理。
    html:返回纯文本HTML信息;包含的script标签会在插入DOM时执行。
    script:返回纯文本JavaScript代码。不会自动缓存结果。除非设置了cache参数。注意在远程请求时(不在同一个域下),所有post请求都将转为get请求。
    json:返回JSON数据。
    jsonp:JSONP格式。使用SONP形式调用函数时,例如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类型的参数,请求成功后调用的回调函数,有两个参数:

    • 由服务器返回,并根据dataType参数进行处理后的数据。
    • 描述状态的字符串。

      
      function(data, textStatus){
          //data可能是xmlDoc、jsonObj、html、text等等
          this;  //调用本次ajax请求时传递的options参数
      }
      
    • 触发条件:
      XMLHttpRequest对象的属性readyState和status
      success:readyState==4 && (status>=200 && status < 300 || status === 304)

      readyState==4 请求已完成,且响应已就绪
      status==200 服务器响应正常。
      本质上是一个if else判断,若

      
      if(readyState==4 &amp;&amp; (status&gt;=200 &amp;&amp; status &lt; 300 || status === 304)){
          success
      } else {
          error
      }
      

    在这里插入图片描述

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

    
    function(XMLHttpRequest, textStatus, errorThrown){
        //通常情况下textStatus和errorThrown只有其中一个包含信息
        this;   //调用本次ajax请求时传递的options参数
        // 打印 errorThrown 可以看出错误信息
    }
    

    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=?"传给服务器。
    jsonp本质上是get,即便指定type为post,也会按照get来发起请求。

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

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

    19.processData:
    要求为Boolean类型的参数,默认为true。默认情况下,通过data选项传递进来的数据,如果是一个对象(技术上讲只要不是字符串),都会处理转化成一个查询字符串,以配合默认内容类型 "application/x-www-form-urlencoded"。如果要发送 DOM 树信息或其它不希望转换的信息,请设置为 false。

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

    其他补充:

    $.ajax() 函数依赖服务器提供的信息来处理返回的数据。如果服务器报告说返回的数据是 XML,那么返回的结果就可以用普通的 XML 方法或者 jQuery 的选择器来遍历。如果见得到其他类型,比如 HTML,则数据就以文本形式来对待。

    通过 dataType 选项还可以指定其他不同数据处理方式。除了单纯的 XML,还可以指定 html、json、jsonp、script 或者 text。

    其中,text 和 xml 类型返回的数据不会经过处理。数据仅仅简单的将 XMLHttpRequest 的 responseText 或 responseHTML 属性传递给 success 回调函数。

    注意我们必须确保网页服务器报告的 MIME 类型与我们选择的 dataType 所匹配。比如说,XML的话,服务器端就必须声明 text/xml 或者 application/xml 来获得一致的结果。

    如果指定为 html 类型,任何内嵌的 JavaScript 都会在 HTML 作为一个字符串返回之前执行。类似地,指定 script 类型的话,也会先执行服务器端生成 JavaScript,然后再把脚本作为一个文本数据返回。

    如果指定为 json 类型,则会把获取到的数据作为一个 JavaScript 对象来解析,并且把构建好的对象作为结果返回。为了实现这个目的,它首先尝试使用 JSON.parse( )。如果浏览器不支持,则使用一个函数来构建。

    JSON 数据是一种能很方便通过 JavaScript 解析的结构化数据。如果获取的数据文件存放在远程服务器上(域名不同,也就是跨域获取数据),则需要使用 jsonp 类型。使用这种类型的话,会创建一个查询字符串参数 callback=? ,这个参数会加在请求的 URL 后面。服务器端应当在 JSON 数据前加上回调函数名,以便完成一个有效的 JSONP 请求。如果要指定回调函数的参数名来取代默认的 callback,可以通过设置 $.ajax() 的 jsonp 参数。

    注意:JSONP 是 JSON 格式的扩展。它要求一些服务器端的代码来检测并处理查询字符串参数。

    如果指定了 script 或者 jsonp 类型,那么当从服务器接收到数据时,实际上是用了 <script> 标签而不是 XMLHttpRequest 对象。这种情况下,$.ajax() 不再返回一个 XMLHttpRequest 对象,并且也不会传递事件处理函数,比如 beforeSend。

    参考:http://www.w3school.com.cn/jq...

    来源:https://segmentfault.com/a/1190000017765056

  • 相关阅读:
    Nginx 部署多个 web 项目(虚拟主机)
    Nginx 配置文件
    Linux 安装 nginx
    Linux 安装 tomcat
    Linux 安装 Mysql 5.7.23
    Linux 安装 jdk8
    Linux 安装 lrzsz,使用 rz、sz 上传下载文件
    springMVC 拦截器
    spring 事务
    基于Aspectj 注解实现 spring AOP
  • 原文地址:https://www.cnblogs.com/datiangou/p/10224925.html
Copyright © 2011-2022 走看看