初学笔记,用于方便自己查找方法和参数信息。后续如有发现其他关于 ajax 方法和参数会持续加入本文章中。若本文出现错误,可以留言或者私信。
ajax 常用方法
ajax 发送请求
| 方法 | 描述 |
|---|---|
| open(method,url.async) | 规定请求的类型、url以及是否进行异步处理请求。 - method: 请求的类型;get或pos - url: 文件在服务器上的位置 - async: true(异步)或false(同步) |
| send(string) | 请求发送到服务器。 - string:仅用于post |
常用使用方法参数
| 编号 | 参数 | 类型 | 描述 |
|---|---|---|---|
| 1 | url | String | 类型的参数,(默认为当前页面地址)发送请求的地址 |
| 2 | type | String | 请求方式(post或get)默认为 get。 |
| 3 | timeout | Number | 设置请求超时时间(毫秒)。此设置将覆盖 **$.ajaxSetup()**方法的全局设置。 |
| 4 | async | Boolean | 默认为 true ,所有请求均为异步请求。如果需要发送同步请求,该值为false。 |
| 5 | cache | Boolean | 是否在缓存中读取数据的读取(默认如果当前请求有缓存的话,直接使用缓存)。,默认为 true (当dataType为script时,默认为false)。设置为false将不会为浏览器缓存中加载请求信息。 - true: 在第一次请求完成后,如果地址和参数不变化,第二次去请求,会默认获取缓存中的数据,不去服务服务端的最新数据。 - false :每次都会向服务器请求最新数据。 |
| 6 | data | Object/String | 发送到服务器的数据。如果已经不是字符串,将自动转换为字符串格式。get 请求中将附加在 url 后。防止这种自动转换,乐意查看 processData 选项。对象必须为 key/value 格式 |
| 7 | datatype | String | 预期服务器返回的数据类型,如果不指定,JQuery 将自动根据 http 包 mime 信息返回 responseXML 或 responseText,作为回调函数参数传递。 |
| 8 | beforeSend | Function | 发送请求钱可以修 XMLHttpRequest 对象的函数,例如添加自定义 HTTP 头。在 beforeSend 中如果返回 false 可以取消本次 ajax 请求。 XMLHttpRequest 对象时唯一的参数。 |
| 9 | compete | Function | 请求文成后调用的回调函数(请求成功或失败均调用)。参数: XMLHttpRequest 对象和一个描述成功请求类型的字符串。 |
| 10 | success | Function | 请求成功回调函数 - data: 由服务器返回,并根据 dataType 参数进行处理后的数据。 - textStatus: 描述状态的字符串。 |
| 11 | error | Function | 请求失败时,被调用的函数。由三个参数: XMLHttpRequest、错误信息、捕获的错误对象(可选)。 |
| 12 | contentType | String | 当发送信息至服务器时,内容编码类型默认为 applcaton/x-www-form-urlencoded。该默认值适合大多数场合。 |
| 13 | dataFilter | Function | 给 ajax 返回的原始数据进行预处理的函数。提供 data 和 type 两个参数。data 时 ajax 返回的原始数据,type 是调用 JQuery.ajax 时提供的 dataType 参数。函数返回的值将由 JQuery 进一步处理。 |
| 14 | global | Boolean | 默认值为 true。表示是否出发全局 ajax 事件,ajaxStart 或 ajaxStop 可用于控制各种 ajax 事件。 |
| 15 | ifModified | Boolean | 仅在服务器数据改变时获取新数据。服务器数据改变判断的以及时 Last-Modified 头信息。默认值为 false,即忽略头信息。 |
| 16 | jsonp | String | 在一个 jsonp 请求中重写回调函数的名字。该值用来代替在 "callback=?" 这种 get 或 post 请求中 URL 参数里的 "callback" 部分。 |
| 17 | username | String | 用于响应 HTTP 访问认证请求的用户名。 |
| 18 | password | String | 用于相应 HTTP 访问请求的密码。 |
| 19 | procressData | Boolean | 默认值为false。 |
默认情况下,发送的数据被转化为对象以配合默认内容类型 "application/x-www-form-urlencoded"。如果要放松 DOM 树信息或者其他不希望被转换的信息,请设置为 false 。 20|scriptCharset|String|只有当请求时 dataType 为 jsonp 或 script,并且 type 是 get 时才用于强制修改字符集(charset)。通常在本地和远程的内容编码不同时使用。
注:
- async:若该参数值为false,为同步请求,将锁住浏览器,用户其他操作必须等待请求完成后才可以执行。
- cache :ajax 缓存只对 get 和 head 方式的请求有效,因为浏览器认为 post 请求提交的内容必定有变化,所有不缓存。
- datatype: 可用类型如下:
- xml: 返回 XML 文档,可用 JQuery 处理。
- html: 返回纯文本 HTML 信息;包含的 script 标签会在插入 DOM 时执行。
- script: 返回纯文本 JavaScript 代码。不会自动缓存结果。除非设置了 cache 参数。注意在远程请求时(不在同一个域下),所以 post 请求都将转为 get 请求。
- json: 返回 JSON 数据。
- jsonp: JSONP 格式。
- text: 返回纯文本字符串。
ajax 常用属性
ajax 通过 readyState 状态的变化接受服务器响应
| 属性 | 描述 |
|---|---|
| onreadystatechange | 存储函数(或函数名),每当readyState 属性改变时,就会调用该函数。 |
| readyState | 存有 XMLHttpRequest的状态。从 0 到4 发生后编发 - 0: 请求未初始化 - 1: 服务器连接已建立 - 2: 请求已接受 - 3:请求处理中 - 4: 请求已完成,且响应已就绪 |
| status | 200: "OK" 404: 未找到页面 |
参考文章: