XMLHttpRequest
的基本使用;Ajax
函数;XMLHttpRequest Level2
的新特性;jQuery
高级用法;axios
;提示:以下是本篇文章正文内容,下面案例可供参考
XMLHttpRequest(简称 xhr)是浏览器提供的 Javascript 对象,通过它,可以请求服务器上的数据资源。之前所学的 jQuery 中的 Ajax 函数,就是基于 xhr 对象封装出来的。
步骤:
xhr
对象;xhr.open()
函数(创建请求);xhr.send()
函数(发起Ajax
请求);xhr.onreadystatechange
事件(拿到服务器响应回来的数据)。代码示例:
<script>
// 1. 创建 XHR 对象
var xhr = new XMLHttpRequest()
// 2. 调用 open函数,指定 请求方式 与 URL地址
xhr.open('GET', 'http://www.liulongbin.top:3006/api/getbooks')
// 3. 调用 send 函数,发起 Ajax 请求
xhr.send()
// 4. 监听 onreadystatechange 事件
xhr.onreadystatechange = function() {
// 4.1 监听 xhr 对象的请求状态 readyState ;与服务器响应的状态 status
if (xhr.readyState === 4 && xhr.status === 200) {
// 4.2 打印服务器响应回来的数据
console.log(xhr.responseText)
}
}
</script>
if(xhr.readyState === 4 && xhr.status === 200)
:判断条件的固定写法,要记住。如果条件成立,表示数据获取成功。
注意:判断条件里的status
和响应回来的数据里的status
属性并不是同一个。
注意区分:
监听状态 | 描述 |
---|---|
readyState |
请求状态 |
status |
服务器响应状态 |
XMLHttpRequest 对象的 readyState
属性,用来表示当前 Ajax 请求所处的状态。每个 Ajax 请求必然处于以下状态中的一个:
值 | 状态 | 描述 |
---|---|---|
0 | UNSENT | XMLHttpRequest 对象已被创建,但尚未调用 open方法。 |
1 | OPENED | open()方法已经被调用 |
2 | HEADERS_RECEIVED | send() 方法已经被调用,响应头也已经被接收。 |
3 | LOADING | 数据接收中,此时 response 属性中已经包含部分数据。 |
4 | DONE | Ajax 请求完成,这意味着数据传输已经彻底完成或失败。 |
使用 xhr 对象发起带参数的 GET 请求时,只需在调用 xhr.open
期间,为 URL 地址指定参数即可:
// ...此处省略
xhr.open('GET', 'http://www.liulongbin.top:3006/api/getbooks?id=1')
// ...省略
这种在 URL 地址后面拼接的参数,叫做查询字符串。
定义:查询字符串(URL 参数)是指在 URL 的末尾加上用于向服务器发送信息的字符串(变量
)。
格式:将英文的 ?
放在URL 的末尾,然后再加上 参数=值
,想加上多个参数的话,使用 &
符号进行分隔。以此形式,可将想要发给服务器的数据添加到 URL 中。
代码示例:
// 不带参数的 URL 地址
http://www.liulongbin.top:3006/api/getbooks
// 带一个参数的 URL 地址
http://www.liulongbin.top:3006/api/getbooks?id=1
// 带两个参数的 URL 地址
http://www.liulongbin.top:3006/api/getbooks?id=1&bookname=西游记
无论使用 $.ajax()
,还是使用 $.get()
,又或者直接使用 xhr 对象发起 GET 请求,当需要携带参数的时候,本质上,都是直接将参数以查询字符串的形式,追加到 URL 地址的后面,发送到服务器的。
$.get('url', {name: '张三疯', age: 20}, function() {})
// 等价于
$.get('url?name=zs&age=20', function() {})
$.ajax({ method: 'GET', url: 'url', data: {name: '张三疯', age: 20}, success: function() {} })
// 等价于
$.ajax({ method: 'GET', url: 'url?name=zs&age=20', success: function() {} })
URL 地址中,只允许出现英文相关的字母、标点符号、数字,因此,在 URL 地址中不允许出现中文字符。
如果 URL 中需要包含中文这样的字符,则必须对中文字符进行编码(转义)。
URL编码的原则:使用安全的字符(没有特殊用途或者特殊意义的可打印字符)去表示那些不安全的字符。
URL编码原则的通俗理解:使用英文字符去表示非英文字符。
代码示例:
http://www.liulongbin.top:3006/api/getbooks?id=1&bookname=西游记
// 经过 URL 编码之后,URL地址变成了如下格式:
http://www.liulongbin.top:3006/api/getbooks?id=1&bookname=%E8%A5%BF%E6%B8%B8%E8%AE%B0
编码中,用3组“%XX
” 来表示一个中文字符
浏览器提供了 URL 编码与解码的 API,分别是:
encodeURI()
编码的函数;decodeURI()
解码的函数。代码示例:
encodeURI('菜鸟程序员')
// 输出字符串 %E8%8F%9C%E9%B8%9F%E7%A8%8B%E5%BA%8F%E5%91%98
decodeURI('%E8%8F%9C%E9%B8%9F')
// 输出字符串 菜鸟
由于浏览器会自动对 URL 地址进行编码操作,因此,大多数情况下,程序员不需要关心 URL 地址的编码与解码操作。
更多关于 URL 编码的知识,请参考如下博客:
https://blog.csdn.net/Lxd_0111/article/details/78028889
步骤:
xhr
对象;xhr.open()
函数;Content-Type
属性(固定写法);xhr.send()
函数,同时指定要发送的数据;xhr.onreadystatechange
事件代码示例:
// 1. 创建 xhr 对象
var xhr = new XMLHttpRequest()
// 2. 调用 open()
xhr.open('POST', 'http://www.liulongbin.top:3006/api/addbook')
// 3. 设置 Content-Type 属性(固定写法)
xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded')
// 4. 调用 send(),同时将数据以查询字符串的形式,提交给服务器
xhr.send('bookname=水浒传&author=施耐庵&publisher=天津图书出版社')
// 5. 监听 onreadystatechange 事件
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
console.log(xhr.responseText)
}
}
数据交换格式,就是 服务器端 与 客户端 之间进行数据传输与交换的格式。
前端领域,经常提及的两种数据交换格式分别是 XML 和 JSON。其中 XML 用的非常少,重点学习的数据交换格式就是 JSON。
XML 的英文全称是 EXtensible Markup Language(即可扩展标记语言)。XML 和 HTML 类似,也是一种标记语言。
XML 和 HTML 虽然都是标记语言,但是,它们两者之间没有任何的关系。
① XML 格式臃肿,和数据无关的代码多,体积大,传输效率低;
② 在 Javascript 中解析 XML 比较麻烦。
代码如下(示例):
Jack
David
通知
晚上KTV
概念:JSON 的英文全称是 JavaScript Object Notation,即“JavaScript 对象表示法”。简单来讲,JSON 就是 Javascript 对象和数组的字符串表示法,它使用文本表示一个 JS 对象或数组的信息,因此,JSON 的本质是字符串。
作用:JSON 是一种轻量级的文本数据交换格式,在作用上类似于 XML,专门用于存储和传输数据,但是 JSON 比 XML 更小、更快、更易解析。
现状:JSON 是在 2001 年开始被推广和使用的数据格式,到现今为止,JSON 已经成为了主流的数据交换格式。
JSON
就是用字符串来表示 Javascript
的 对象 和 数组。所以,JSON 中包含对象和数组两种结构,通过这两种结构的 相互嵌套,可以表示各种复杂的数据结构。
对象结构:对象结构在 JSON 中表示为 { } 括起来的内容。数据结构为 { key: value, key: value, … } 的键值对结构。其中,key 必须使用英文的 双引号 包裹字符串,value 的数据类型必须是数字、字符串、布尔值、null、数组、对象6种类型。
数组结构:数组结构在 JSON 中表示为 [ ] 括起来的内容。数据结构为 [ “java”, “javascript”, 30, true … ] 。数组中数据的类型必须是数字、字符串、布尔值、null、数组、对象6种类型。
代码示例:
[ "java", "python", "php" ]
[ 100, 200, 300.5 ]
[ true, false, null ]
[ { "name": "Jack", "age": 20}, { "name": "David", "age": 30} ]
[ [ "苹果", "香蕉", "桔子" ], [ 4, 50, 5 ] ]
undefined
或函数作为 JSON 的值。JSON 的作用:在计算机与网络之间存储和传输数据。
JSON 的本质:用字符串来表示 Javascript 对象数据或数组数据
JSON 是 JS 对象的字符串表示法,它使用文本表示一个 JS 对象的信息,本质是一个字符串。例如:
//这是对象
var obj = {a: 'Hello', b: 'World'}
//这是 JSON 字符串,本质是一个字符串
var json = '{"a": "Hello", "b": "World"}'
JSON 字符串 转 JS 对象,用 JSON.parse()
方法:
var obj = JSON.parse('{"a": "Hello", "b": "World"}')
//结果是 {a: 'Hello', b: 'World'}
JS 对象 转 JSON 字符串,用 JSON.stringify()
方法:
var json = JSON.stringify({a: 'Hello', b: 'World'})
//结果是 '{"a": "Hello", "b": "World"}'
把数据对象转换为字符串的过程,叫做序列化;
把字符串转换为数据对象的过程,叫做反序列化.
示例代码:
<script>
var xhr = new XMLHttpRequest();
xhr.open('GET', 'http://www.liulongbin.top:3006/api/getbooks');
xhr.send();
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
console.log(xhr.responseText);
console.log(typeof xhr.responseText);
}
}
</script>
xhr.responseText
得到的结果是JSON格式的字符串,并且用typyof
检查,也确实是字符串格式。如图:
因为字符串不便于操作,就这需要用到JOSN.parse()
将这个结果转换为对象再进行操作。
// 将字符串转换为对象
var result=JSON.parse(xhr.responseText);
console.log(result);
<!-- 1. 导入自定义的ajax函数库 -->
<script src="./itheima.js"></script>
<script>
// 2. 调用自定义的 itheima 函数,发起 Ajax 数据请求
itheima({
method: '请求类型',
url: '请求地址',
data: { /* 请求参数对象 */ },
success: function(res) { // 成功的回调函数
console.log(res) // 打印数据
}
})
</script>
itheima()
函数是自定义的 Ajax 函数,它接收一个配置对象作为参数,配置对象中可以配置如下属性:
属性 | 描述 |
---|---|
method |
请求的类型 |
url |
请求的 URL 地址 |
data |
请求携带的数据 |
success |
请求成功之后的回调函数 |
需要把 data 对象,转化成查询字符串的格式,从而提交给服务器,因此提前定义 resolveData
函数如下:
/**
* 处理 data 参数
* @param {data} 需要发送到服务器的数据
* @returns {string} 返回拼接好的查询字符串 name=zs&age=10
*/
function resolveData(data) {
var arr = []
for (var k in data) {
arr.push(k + '=' + data[k])
}
return arr.join('&')
}
在 itheima()
函数中,需要创建 xhr 对象,并监听 onreadystatechange
事件:
代码示例:
function itheima(options) {
var xhr = new XMLHttpRequest()
// 拼接查询字符串
var qs = resolveData(options.data)
// 监听请求状态改变的事件
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
var result = JSON.parse(xhr.responseText)
options.success(result)
}
}
}
解释:
1) resolveData(options.data)
:把外界传递过来的参数对象,转换为查询字符串
2)xhr.responseText
是服务器响应回来的数据,但它是一个JSON
格式的字符串,我们需要用JSON.parse()
函数将它转换为JS对象。再执行success回调函数(响应成功后的一些操作都在回调函数里)。
注:
如果POST
要提交参数,不是在url
后面去拼接查询字符串,而是在send()
期间去指定参数
不同的请求类型,对应 xhr对象的不同操作,因此需要对请求类型进行 if … else … 的判断。
代码示例:
if (options.method.toUpperCase() === 'GET') {
// 发起 GET 请求
xhr.open(options.method, options.url + '?' + qs)
xhr.send()
} else if (options.method.toUpperCase() === 'POST') {
// 发起 POST 请求
xhr.open(options.method, options.url)
xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded')
xhr.send(qs)
}
根据options.method
的类型(get
或post
),
url
地址的后面,然后发起请求xhr.send()
;
toUpperCase()
:转换成大写
封装的Ajax itheima
函数完整代码如下:
function resolveData(data) {
var arr = [];
for (var k in data) {
var str = k + '=' + data[k]
arr.push(str)
}
return arr.join('&')
}
// var res = resolveData({ name: '张三疯', age: 180 })
// console.log(res);
function itheima(options) {
var xhr = new XMLHttpRequest();
// 把外界传递过来的参数对象,转换为查询字符串
var qs = resolveData(options.data);
// 把外界传递过来的参数对象,转换为查询字符串
var qs = resolveData(options.data);
if (options.method.toUpperCase() === 'GET') {
// 发起GET请求
xhr.open(options.method, options.url + '?' + qs);
xhr.send();
} else if (options.method.toUpperCase() === 'POST') {
// 发起POST请求
// 如果`POST`要提交参数,不是在`url`后面去拼接查询字符串,而是在`send()`期间去指定参数
xhr.open(options.method, options.url);
// 设置Content-Type属性
xhr.setRequestHeader('Content-Type','application/x-www-form-urlencoded');
xhr.send(qs)
}
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
// xhr.responseText是服务器响应回来的数据,但它是一个JSON格式的字符串,需要转换为JS对象
var result = JSON.parse(xhr.responseText);
options.success(result)
}
}
}
封装itheima
函数的调用
<script>
// itheima({
// method: 'GET',
// url: 'http://www.liulongbin.top:3006/api/getbooks',
// data: {
// id: 1
// },
// success: function(res) {
// console.log(res);
// }
// })
itheima({
method: 'post',
url: 'http://www.liulongbin.top:3006/api/addbook',
data: {
bookname: '三国演义',
author: '罗贯中',
publisher: '四川人民出版社'
},
// 监听success的回调
success: function(res) {
console.log(res);
}
})
</script>
HTTP
请求的时限;FormData
管理表单数据(旧版只能使用form
标签);有时,Ajax 操作很耗时,而且无法预知要花多少时间。如果网速很慢,用户可能要等很久。新版本的 XMLHttpRequest 对象,增加了 timeout
属性,可以设置 HTTP 请求的时限。
代码示例:
// 设置超时时间
xhr.timeout = 3000;
// 超时后的处理函数
xhr.ontimeout = function() {
console.log('请求超时!');
}
此语句,将最长等待时间设为了 3000 毫秒。过此时限,就自动停止HTTP请求。与之配套的还有 timeout
事件,用来指定回调函数:
本案例完整代码:
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Documenttitle>
head>
<body>
<script>
var xhr = new XMLHttpRequest();
// 设置超时时间
xhr.timeout = 3000;
// 超时后的处理函数
xhr.ontimeout = function() {
console.log('请求超时!');
}
xhr.open('GET', 'http://www.liulongbin.top:3006/api/getbooks');
xhr.send();
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
// responseText获得字符串形式的的响应数据
console.log(xhr.responseText);
}
}
script>
body>
html>
1)readyState
属性返回一个 XMLHttpRequest
代表当前所处的状态(UNSENT、 OPENED、HEADERS_RECEIVED、 LOADING、DONE);
2)responseText
:获得字符串形式的的响应数据。也可以写作如下格式:
document.getElementById("myDiv").innerHTML=xhr.responseText;
主要功能:
Ajax 操作常用来提交表单数据。为了方便表单处理,HTML5 新增了 FormData
对象,可以模拟表单操作:
// 1. 新建 FormData 对象
var fd = new FormData()
// 2. 为 FormData 添加表单项
fd.append('uname', 'zs')
fd.append('upwd', '123456')
// 3. 创建 XHR 对象
var xhr = new XMLHttpRequest()
// 4. 指定请求类型与URL地址
xhr.open('POST', 'http://www.liulongbin.top:3006/api/formdata')
// 5. 直接提交 FormData 对象,这与提交网页表单的效果,完全一样
xhr.send(fd)
FormData
对象也可以用来获取网页表单的值,示例代码如下:
// 获取网页表单元素
var form = document.querySelector('#form1')
// 监听表单元素的 submit 事件
form.addEventListener('submit', function(e) {
e.preventDefault()
// 根据 form 表单创建 FormData 对象,会自动将表单数据填充到 FormData 对象中
var fd = new FormData(form)
var xhr = new XMLHttpRequest()
xhr.open('POST', 'http://www.liulongbin.top:3006/api/formdata')
xhr.send(fd)
xhr.onreadystatechange = function() {}
})
还可以在创建一个包含Form表单数据的FormData对象之后,并且在发送请求之前,附加额外的数据到FormData对象里。例如:
var formElement = document.querySelector("form");
var formData = new FormData(formElement);
var request = new XMLHttpRequest();
request.open("POST", "submitform.php");
formData.append("serialnumber", serialNumber++);
request.send(formData);
这样就可以在发送请求之前,自由地附加不一定是用户编辑的字段到表单数据里。
注意:如果FormData
对象是通过表单创建的,则表单中指定的请求方式会被应用到方法open()
中 。
新版 XMLHttpRequest
对象,不仅可以发送文本信息,还可以上传文件。
实现步骤:
FormData
中追加文件;onreadystatechange
事件代码示例:
<input type="file" id="file1" />
<button id="btnUpload">上传文件button>
<br />
<img src="" alt="" id="img" width="800" />
代码示例:
// 1. 获取上传文件的按钮
var btnUpload = document.querySelector('#btnUpload')
// 2. 为按钮添加 click 事件监听
btnUpload.addEventListener('click', function() {
// 3. 获取到选择的文件列表
var files = document.querySelector('#file1').files
if (files.length <= 0) {
return alert('请选择要上传的文件!')
}
// ...后面的业务逻辑
})
代码示例:
// 1. 创建 FormData 对象
var fd = new FormData()
// 2. 向 FormData 中追加文件
fd.append('avatar', files[0])
代码示例:
// 1. 创建 xhr 对象
var xhr = new XMLHttpRequest()
// 2. 调用 open 函数,指定请求类型与URL地址。其中,请求类型必须为 POST
xhr.open('POST', 'http://www.liulongbin.top:3006/api/upload/avatar')
// 3. 发起请求
xhr.send(fd)
代码示例:
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
var data = JSON.parse(xhr.responseText)
if (data.status === 200) { // 上传文件成功
// 将服务器返回的图片地址,设置为 标签的 src 属性
document.querySelector('#img').src = 'http://www.liulongbin.top:3006' + data.url
}
else { // 上传文件失败
console.log(data.message)
}
}
}
新版本的 XMLHttpRequest
对象中,可以通过监听 xhr.upload.onprogress
事件,来获取到文件的上传进度。语法格式如下:
// 创建 XHR 对象
var xhr = new XMLHttpRequest()
// 监听 xhr.upload 的 onprogress 事件
xhr.upload.onprogress = function(e) {
/ e.lengthComputable 是一个布尔值,表示当前上传的资源是否具有可计算的长度
if (e.lengthComputable) {
// e.loaded 已传输的字节
// e.total 需传输的总字节
var percentComplete = Math.ceil((e.loaded / e.total) * 100)
}
}
代码示例:
<link rel="stylesheet" href="./lib/bootstrap.css" />
<script src="./lib/jquery.js">script>
代码示例:
<div class="progress" style="width: 500px; margin: 10px 0;">
<div class="progress-bar progress-bar-info progress-bar-striped active" id="percent" style="width: 0%">
0%
div>
div>
代码示例:
xhr.upload.onprogress = function(e) {
if (e.lengthComputable) {
// 1. 计算出当前上传进度的百分比
var percentComplete = Math.ceil((e.loaded / e.total) * 100)
$('#percent')
// 2. 设置进度条的宽度
.attr('style', 'width:' + percentComplete + '%')
// 3. 显示当前的上传进度百分比
html(percentComplete + '%')
}
}
代码示例:
xhr.upload.onload = function() {
$('#percent')
// 移除上传中的类样式
removeClass()
// 添加上传完成的类样式
addClass('progress-bar progress-bar-success')
}
代码示例:
<input type="file" id="file1">
<button id="btnUpload">上传button>
<img src="" alt="" id="img" width:300/>
引入js文件:
<script src="./lib/jquery.js">script>
验证文件:
$('#btnUpload').on('click', function() {
// 1. 将 jQuery 对象转化为 DOM 对象,并获取选中的文件列表
var files = $('#file1')[0].files;
// 2. 判断是否选择了文件
if (files.length <= 0) {
return alert('请选择后上传')
}
var fd=new FormData();
})
jQuery对象后面跟上
[0]
,即可转换为DOM对象
var fd = new FormData()
// 将用户选择的文件,添加到 FormData 中
fd.append('avatar', files[0])
var xhr = new XMLHttpRequest()
xhr.open('POST', 'http://www.liulongbin.top:3006/api/upload/avatar')
xhr.send(fd)
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
var data = JSON.parse(xhr.responseText)
if (data.status === 200) {
// 上传成功
document.querySelector('#img').src = 'http://www.liulongbin.top:3006' + data.url
} else {
// 上传失败
console.log('图片上传失败!' + data.message)
}
}
}
本案例完整代码:网盘源码(提取码:7j6v)
Ajax 请求 开始 时,执行 ajaxStart
函数。可以在 ajaxStart 的 callback
中显示 loading
效果。
语法格式如下:
// 自 jQuery 版本 1.8 起,该方法只能被附加到文档
$(document).ajaxStart(function() {
$('#loading').show()
})
注意:$(document).ajaxStart()
函数会监听当前文档内所有的 Ajax
请求。
Ajax 请求 结束 时,执行 ajaxStop
函数。可以在 ajaxStop 的 callback
中隐藏 loading
效果。
语法格式如下:
// 自 jQuery 版本 1.8 起,该方法只能被附加到文档
$(document).ajaxStop(function() {
$('#loading').hide()
})
案例源码:网盘下载(提取码: sxqf)
Axios是专注于网络数据请求的库。
相比于原生的 XMLHttpRequest 对象,axios简单易用。
相比于 jQuery
,axios
更加 轻量化,只专注于网络数据请求。
axios发起get请求的语法:
axios.get('url', { params: { /*参数*/ } }).then(callback)
具体的GET请求示例如下:
// 请求的 URL 地址
var url = 'http://www.liulongbin.top:3006/api/get'
// 请求的参数对象
var paramsObj = { name: '张三疯', age: 180 }
// 调用 axios.get() 发起 GET 请求
axios.get(url, { params: paramsObj }).then(function(res) {
// res.data 是服务器返回的数据
var result = res.data
console.log(res)
})
axios发起POST请求的语法:
axios.post('url', { /*参数*/ }).then(callback)
具体的POST请求示例如下:
// 请求的 URL 地址
var url = 'http://www.liulongbin.top:3006/api/post'
// 要提交到服务器的数据
var dataObj = { location: '北京', address: '顺义' }
// 调用 axios.post() 发起 POST 请求
axios.post(url, dataObj).then(function(res) {
// res.data 是服务器返回的数据
var result = res.data
console.log(result)
})
axios 也提供了类似于 jQuery 中 $.ajax() 的函数,语法如下:
axios({
method: '请求类型',
url: '请求的URL地址',
data: { /* POST数据 */ },
params: { /* GET参数 */ }
}) .then(callback)
axios({
method: 'GET',
url: 'http://www.liulongbin.top:3006/api/get',
params: { // GET 参数要通过 params 属性提供
name: 'zs',
age: 20
}
}).then(function(res) {
console.log(res.data)
})
axios({
method: 'POST',
url: 'http://www.liulongbin.top:3006/api/post',
data: { // POST 数据要通过 data 属性提供
bookname: 'JavaScript从入门到放弃',
price: 168
}
}).then(function(res) {
console.log(res.data)
})
提示