?Ajax前后端交互利器
1、Ajax运行原理
Ajax 相当于浏览器发送请求与接收响应的代理人,以实现在不影响用户浏览页面的情况下,局部更新页面数据,从而提高用户体验
1.1、Ajax实现步骤
- 创建Ajax对象
var xhr = new XMLHttpRequest();
- 告诉Ajax 请求地址以及请求方式
xhr.open(method,url);
- 发送请求
xhr.send(body);
- 获取服务器端给客户端的响应数据
xhr.onload = function() {
console.log(xhr.responseText);
}
1.2、快速入门
<script>
var xhr = new XMLHttpRequest();
xhr.open('get','http://localhost:3000/first');
xhr.send();
xhr.onload = function() {
console.log(xhr.responseText);
}
</script>
在服务器端创建路由:
const express = require('express');
const app = express();
app.get('/first',(req,res) => {
res.send('Hello,ajax');
});
app.listen(3000,()=>{
console.log('服务器启动成功');
});
1.3、服务器端响应的数据格式
-
在真实的项目中,服务器端大多数情况下会以 JSON 对象作为响应数据的格式。 -
当客户端拿到响应数据时,要将 JSON 数据和 HTML 字符串进行拼接,然后将拼接的结果展示在页面中。 -
在 http 请求与响应的过程中,无论是请求参数还是响应内容,如果是对象类型,最终都会被转换为对象字符串进行传输。
<script>
var xhr = new XMLHttpRequest();
xhr.open('get', 'http://localhost:3000/responseData');
xhr.send();
xhr.onload = function() {
console.log(xhr.responseText);
console.log(typeof xhr.responseText)
}
</script>
在 app.js 中设置路由
const express = require('express');
const path = require('path');
const app = express();
app.use(express.static(path.join(__dirname, 'public')));
app.get('/responseData', (req, res) => {
res.send({ "name": "zhangsan" });
});
app.listen(3000, () => {
console.log('服务器启动成功');
});
我们需要将 json 字符串转换为 json 对象
JSON.parse()
<script>
var xhr = new XMLHttpRequest();
xhr.open('get', 'http://localhost:3000/responseData');
xhr.send();
xhr.onload = function() {
var responseText = JSON.parse(xhr.responseText);
console.log(responseText)
var str = '<h2>' + responseText.name + '</h2>';
document.body.innerHTML = str;
}
</script>
1.4、传递get请求参数
<form method="get" action="http://www.example.com">
<input type="text" name="username"/>
<input type="password" name="password">
</form>
<!– http://www.example.com?username=zhangsan&password=123456 -->
xhr.open('get', 'http://www.example.com?name=zhangsan&age=20');
<body>
<input type="text" id="username"><br/>
<input type="text" id="age"><br/>
<input type="button" value="提交" id="btn">
<script type="text/javascript">
var btn = document.getElementById('btn');
var username = document.getElementById('username');
var age = document.getElementById('age');
btn.onclick = function() {
var xhr = new XMLHttpRequest();
var nameValue = username.value;
var ageValue = age.value;
var params = 'username=' + nameValue + '&age=' + ageValue;
xhr.open('get', 'http://localhost:3000/get?' + params);
xhr.send();
xhr.onload = function() {
console.log(xhr.responseText)
}
}
</script>
</body>
在 app.js 中创建路由
const express = require('express');
const path = require('path');
const app = express();
app.use(express.static(path.join(__dirname, 'public')));
app.get('/get', (req, res) => {
res.send(req.query);
})
app.listen(3000, () => {
console.log('服务器启动成功');
});
请求报文
在 HTTP 请求和响应的过程中传递的数据块就叫报文,包括要传送的数据和一些附加信息,这些数据和信息要遵守规定好的格式
1.5、传递POST请求参数
xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded')
xhr.send('name=zhangsan&age=20');
<body>
<input type="text" id="username"><br/>
<input type="text" id="age"><br/>
<input type="button" value="提交" id="btn">
<script type="text/javascript">
var btn = document.getElementById('btn');
var username = document.getElementById('username');
var age = document.getElementById('age');
btn.onclick = function() {
var xhr = new XMLHttpRequest();
var nameValue = username.value;
var ageValue = age.value;
var params = 'username=' + nameValue + '&age=' + ageValue;
xhr.open('post', 'http://localhost:3000/post');
xhr.setRequestHeader('Content-type', 'application/x-www-form-urlencoded');
xhr.send(params);
xhr.onload = function() {
console.log(xhr.responseText)
}
}
</script>
</body>
在 app.js 中创建路由
const express = require('express');
const path = require('path');
const bodyParser = require('body-parser');
app.use(express.urlencoded({ extended: false }))
const app = express();
app.use(express.static(path.join(__dirname, 'public')));
app.post('/post', (req, res) => {
res.send(req.body);
})
app.listen(3000, () => {
console.log('服务器启动成功');
});
注意:借助了第三方模块 body-parser
1.6、请求参数的格式
我们客户端在向服务器端发送请求参数有以下几种格式,不同的格式需要设置的请求头也是不一样的
- 设置请求头为
application/x-www-form-urlencoded ,传递如下请求参数
name=zhangsan&age=20&sex=男
- 设置请求头为
application/json ,传递如下请求参数,是 json 对象
{name: 'zhangsan', age: '20', sex: '男'}
在请求头中指定 Content-Type 属性的值是 application/json,告诉服务器端当前请求参数的格式是 json,我们还需要将 json 对象转换为 json 字符串,因为请求参数必须要以字符串格式传递
JSON.stringify()
<script type="text/javascript">
var xhr = new XMLHttpRequest();
xhr.open('post', 'http://localhost:3000/json');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.send(JSON.stringify({name: 'lisi',age: 50}));
xhr.onload = function() {
console.log(xhr.responseText)
}
</script>
在app.js 中配置路由
const express = require('express');
const path = require('path');
const bodyParser = require('body-parser');
const app = express();
app.use(express.json())
app.use(express.static(path.join(__dirname, 'public')));
app.post('/json', (req, res) => {
res.send(req.body);
});
app.listen(3000, () => {
console.log('服务器启动成功');
});
注意:get 请求是不能提交 json 对象数据格式的,传统网站的表单提交也是不支持 json 对象数据格式的。
1.7、获取服务器端的响应
1.7.1、Ajax状态码
在创建ajax对象,配置ajax对象,发送请求,以及接收完服务器端响应数据,这个过程中的每一个步骤都会对应一个数值,这个数值就是ajax状态码。
0:请求未初始化(还没有调用open()) 1:请求已经建立,但是还没有发送(还没有调用send()) 2:请求已经发送 3:请求正在处理中,通常响应中已经有部分数据可以用了 4:响应已经完成,可以获取并使用服务器的响应了
xhr.readyState
1.7.2、onreadystatechange事件
当 Ajax 状态码发生变化时将自动触发该事件。
在事件处理函数中可以获取 Ajax 状态码并对其进行判断,当状态码为 4 时就可以通过 xhr.responseText 获取服务器端的响应数据了
<script type="text/javascript">
var xhr = new XMLHttpRequest();
console.log(xhr.readyState);
xhr.open('get', 'http://localhost:3000/readystate');
console.log(xhr.readyState);
xhr.onreadystatechange = function() {
console.log(xhr.readyState);
if (xhr.readyState == 4) {
console.log(xhr.responseText);
}
}
xhr.send();
</script>
在 app.js 中配置路由
const express = require('express');
const path = require('path');
const bodyParser = require('body-parser');
const app = express();
app.use(express.json())
app.use(express.static(path.join(__dirname, 'public')));
app.get('/readystate', (req, res) => {
res.send('hello');
});
app.listen(3000, () => {
console.log('服务器启动成功');
});
1.7.3、区别
两种获取服务器端响应方式的区别
区别描述 | onload事件 | onreadystatechange事件 |
---|
是否兼容IE低版本 | 不兼容 | 兼容 | 是否需要判断Ajax状态码 | 不需要 | 需要 | 被调用次数 | 一次 | 多次 |
1.8、Ajax错误处理
- 网络畅通,服务器端能接收到请求,服务器端返回的结果不是预期结果。
- 我们可以判断服务器端返回的状态码,分别进行处理。
xhr.status 获取http状态码
<body>
<button id="btn">发送Ajax请求</button>
<script type="text/javascript">
var btn = document.getElementById('btn');
btn.onclick = function() {
var xhr = new XMLHttpRequest();
xhr.open('get', 'http://localhost:3000/error');
xhr.send();
xhr.onload = function() {
console.log(xhr.status);
console.log(xhr.responseText);
if (xhr.status == 400) {
alert('请求出错');
}
}
}
</script>
</body>
在app.js 中设置路由
const express = require('express');
const path = require('path');
const bodyParser = require('body-parser');
const app = express();
app.use(express.json())
app.use(express.static(path.join(__dirname, 'public')));
app.get('/error', (req, res) => {
res.status(400).send('not ok');
})
app.listen(3000, () => {
console.log('服务器启动成功');
});
1.8.1、几种错误示例
Ajax 请求报错通常会出现以下几种情况,我们来进行查看并排查
-
网络畅通,服务器端没有接收到请求,返回404状态码 检查请求地址是否错误。
-
网络畅通,服务器端能接收到请求,服务器端返回500状态码。 服务器端错误,找后端程序员进行沟通
app.get('/error', (req, res) => {
console.log(abc);
res.send("hello")
})
-
网络中断,请求无法发送到服务器端。 会触发xhr对象下面的onerror事件,在onerror事件处理函数中对错误进行处理。
xhr.onerror = function() {
alert('网络中断, 无法发送Ajax请求')
}
- Ajax状态码: 表示Ajax请求的过程状态 ajax对象返回的(0、1、2、3、4)
- Http状态码: 表示请求的处理结果 是服务器端返回的
1.9、低版本 IE 浏览器的缓存问题
问题:在低版本的 IE 浏览器中,Ajax 请求有严重的缓存问题,即在请求地址不发生变化的情况下,只有第一次请求会真正发送到服务器端,后续的请求都会从浏览器的缓存中获取结果。即使服务器端的数据更新了,客户端依然拿到的是缓存中的旧数据。
解决方案:在请求地址的后面加请求参数,保证每一次请求中的请求参数的值不相同
xhr.open('get', 'http://www.example.com?t=' + Math.random());
2、Ajax异步编程
2.1、同步异步概述
同步
- 一个人同一时间只能做一件事情,只有一件事情做完,才能做另外一件事情
- 落实到代码上,就是上一行代码执行完成后,才能执行下一行代码,即代码逐行执行
console.log("before");
console.log("after");
异步
- 一个人一件事情做了一半,转而去做其他事情,当其他事情做完以后,再回过头来继续做之前未完成的事情。
- 落实到代码上,就是异步代码虽然需要花费时间去执行,但程序不会等待异步代码执行完成后再继续执行后续代码,而是直接执行后续代码,当后续代码执行完成后再回头看异步代码是否返回结果,如果已有返回结果,再调用事先准备好的回调函数处理异步代码执行的结果。
console.log('before');
setTimeout(
() => { console.log('last');
}, 2000);
console.log('after');
2.2、Ajax封装
问题: 发送一次请求代码过多,发送多次请求代码冗余且重复
解决方案:将请求代码封装到函数中,发请求时调用函数即可
Ajax 封装代码如下:
function ajax (options) {
var defaults = {
type: 'get',
url: '',
async: true,
data: {},
header: {
'Content-Type': 'application/x-www-form-urlencoded'
},
success: function () {},
error: function () {}
}
Object.assign(defaults, options);
var xhr = new XMLHttpRequest();
var params = '';
for (var attr in defaults.data) {
params += attr + '=' + defaults.data[attr] + '&';
params = params.substr(0, params.length-1)
}
if (defaults.type == 'get') {
defaults.url += '?' + params;
}
xhr.open(defaults.type, defaults.url, defaults.async);
if (defaults.type == 'post') {
xhr.setRequestHeader('Content-Type', defaults.header['Content-Type']);
if (defaults.header['Content-Type'] == 'application/json') {
xhr.send(JSON.stringify(defaults.data))
}else {
xhr.send(params);
}
} else {
xhr.send();
}
xhr.onload = function () {
var contentType = xhr.getResponseHeader('content-type');
var responseText = xhr.responseText;
if (contentType.includes('application/json')) {
responseText = JSON.parse(responseText);
}
if (xhr.status == 200) {
defaults.success(responseText, xhr);
} else {
defaults.error(responseText, xhr);
}
}
xhr.onerror = function () {
defaults.error(xhr);
}
}
我们可以将上述代码抽离成一个 ajax.js 文件,这样我们的客户端只需要引入 ajax.js 文件,并传递相应的参数,这样就可以大大节省我们的代码量
<body>
<script type="text/javascript" src="/js/ajax.js"></script>
<script type="text/javascript">
ajax({
url: '',
type: '',
success: function() {
}
})
</script>
</body>
3、模板引擎
模板引擎概述
作用: 使用模板引擎提供的模板语法,可以将数据和 HTML 拼接起来
官方地址:https://aui.github.io/art-template/zh-cn/index.html
3.1 使用步骤
- 下载 art-template 模板引擎库文件并在 HTML 页面中引入库文件
<script src="./js/template-web.js"></script>
- 准备 art-template 模板
<script id="tpl" type="text/html">
<div class="box"></div>
</script>
- 告诉模板引擎将哪一个模板和哪个数据进行拼接
- 第一个参数是 模板ID
- 第二个参数是 对象
- 方法的返回值就是拼接好的 html 字符串
var html = template('tpl', {username: 'zhangsan', age: '20'});
- 将拼接好的html字符串添加到页面中
document.getElementById('container').innerHTML = html;
- 通过模板语法告诉模板引擎,数据和html字符串要如何拼接
<script id="tpl" type="text/html">
<div class="box"> {{ username }} </div>
</script>
5、FormData
5.1、FormData对象的作用
-
模拟HTML表单,相当于将HTML表单映射成表单对象,自动将表单对象中的数据拼接成请求参数的格式。 -
异步上传二进制文件
5.2、FormData对象的使用
- 准备HTML表单
<form id="form">
<input type="text" name="username" />
<input type="password" name="password" />
<input type="button"/>
</form>
- 将 HTML 表单转化为 formData 对象
var form = document.getElementById('form');
var formData = new FormData(form);
- 提交表单对象
xhr.send(formData);
例如客户端代码如下:
<body>
<form id="form">
<input type="text" name="username">
<input type="password" name="password">
<input type="button" id="btn" value="提交">
</form>
<script type="text/javascript">
var btn = document.getElementById('btn');
var form = document.getElementById('form');
btn.onclick = function() {
var formData = new FormData(form);
var xhr = new XMLHttpRequest();
xhr.open('post', 'http://localhost:3000/formData');
xhr.send(formData);
xhr.onload = function() {
if (xhr.status == 200) {
console.log(xhr.responseText);
}
}
}
</script>
</body>
服务器端代码如下:
const express = require('express');
const path = require('path')
const formidable = require('formidable');
const app = express();
app.use(express.static(path.join(__dirname, 'public')));
app.post('/formData', (req, res) => {
const form = new formidable.IncomingForm();
form.parse(req, (err, fields, files) => {
res.send(fields);
});
});
app.listen(3000);
注意:
- Formdata 对象不能用于 get 请求,因为对象需要被传递到 send 方法中,而 get 请求方式的请求参数只能放在请求地址的后面。
- 服务器端 bodyParser 模块不能解析 formData 对象表单数据,我们需要使用 formidable 模块进行解析
5.3、FormData对象的实例方法
- 获取表单对象中属性的值
formData.get('key');
- 设置表单对象中属性的值
formData.set('key', 'value');
<body>
<form id="form">
<input type="text" name="username">
<input type="password" name="password">
<input type="button" id="btn" value="提交">
</form>
<script type="text/javascript">
var btn = document.getElementById('btn');
var form = document.getElementById('form');
btn.onclick = function() {
var formData = new FormData(form);
console.log(formData.get('username'));
formData.set('username', 'itcast');
formData.set('age', 100);
var xhr = new XMLHttpRequest();
xhr.open('post', 'http://localhost:3000/formData');
xhr.send(formData);
xhr.onload = function() {
if (xhr.status == 200) {
console.log(xhr.responseText);
}
}
}
</script>
</body>
- 删除表单对象中属性的值
formData.delete('key');
- 向表单对象中追加属性值
formData.append('key', 'value');
<body>
<form id="form">
<input type="text" name="username">
<input type="password" name="password">
<input type="button" id="btn" value="提交">
</form>
<script type="text/javascript">
var btn = document.getElementById('btn');
var form = document.getElementById('form');
btn.onclick = function() {
var formData = new FormData(form);
console.log(formData.get('username'));
formData.set('username', 'itcast');
formData.append('username', 'itheima');
formData.set('age', 100);
formData.delete('password');
var xhr = new XMLHttpRequest();
xhr.open('post', 'http://localhost:3000/formData');
xhr.send(formData);
xhr.onload = function() {
if (xhr.status == 200) {
console.log(xhr.responseText);
}
}
}
</script>
</body>
注意:set 方法与 append 方法的区别是,在属性名已存在的情况下,set 会覆盖已有键名的值,append会保留两个值。
5.4、FormData二进制文件上传
<input type="file" id="file"/>
二进制文件上传客户端代码如下:
var file = document.getElementById('file')
file.onchange = function () {
var formData = new FormData();
formData.append('attrName', this.files[0]);
xhr.open('post', 'www.example.com');
xhr.send(formData);
}
5.4.1、示例
客户端代码如下:
<body>
<div class="container">
<div class="form-group">
<label>请选择文件</label>
<input type="file" id="file">
</div>
</div>
<script type="text/javascript">
var file = document.getElementById('file');
file.onchange = function() {
var formData = new FormData();
formData.append('attrName', this.files[0]);
var xhr = new XMLHttpRequest();
xhr.open('post', 'http://localhost:3000/upload');
xhr.send(formData);
xhr.onload = function() {
if (xhr.status == 200) {
console.log(xhr.responseText);
}
}
}
</script>
</body>
服务器端代码如下:
const express = require('express');
const path = require('path')
const formidable = require('formidable');
const app = express();
app.use(express.static(path.join(__dirname, 'public')));
app.post('/upload', (req, res) => {
const form = new formidable.IncomingForm();
form.uploadDir = path.join(__dirname, 'public', 'uploads');
form.keepExtensions = true;
form.parse(req, (err, fields, files) => {
res.send('ok')
});
});
app.listen(3000);
5.5、FormData文件上传进度展示
file.onchange = function () {
xhr.upload.onprogress = function (ev) {
bar.style.width = (ev.loaded / ev.total) * 100 + '%';
}
}
5.6、FormData文件上传图片即时预览
在我们将图片上传到服务器端以后,服务器端通常都会将图片地址做为响应数据传递到客户端,客户端可以从响应数据中获取图片地址,然后将图片再显示在页面中
xhr.onload = function () {
var result = JSON.parse(xhr.responseText);
var img = document.createElement('img');
img.src = result.src;
img.onload = function () {
document.body.appendChild(this);
}
}
|