前后端交互-Ajax编程基础
2022-04-15 本文已影响0人
Imkata
一. Ajax 基础
1 - 传统网站中存在的问题
传统网站应用指的就是我们在node课程中做的应用，如果用户想要获取网页的最新数据，只能刷新浏览器，这样就导致：
- 网速慢的情况下，页面加载时间长，用户只能等待
- 表单提交后，如果一项内容不合格，需要重新填写所有表单内容
- 页面跳转，重新加载页面，造成资源浪费，增加用户等待时间
2 - Ajax 概述
Ajax：标准读音 [ˈeɪˌdʒæks] ，全称：Asynchronous JavaScript，中文音译：阿贾克斯
它是浏览器提供的一套方法，可以实现页面无刷新更新数据，提高用户浏览网站应用的体验。
3 - Ajax 的应用场景
- 页面上拉加载更多数据
- 列表数据无刷新分页
- 表单项离开焦点数据验证
- 搜索框提示文字下拉列表
4 - Ajax 的运行环境
Ajax 技术需要运行在网站环境中才能生效，当前课程会使用Node创建的服务器作为网站服务器。
代码地址：https://github.com/iamkata/Ajax-base
- 在终端执行
npm install安装必要的第三方模块 - 在终端执行
npm app.js打印服务器启动成功 - 在浏览器输入
localhost:3000即可看到效果
注意：
在服务端app.js中一定要配置路由，然后Ajax中的请求方式和请求地址要和服务端app.js中的路由相同，这样才能正常访问。
示例代码：
app.js代码：
app.get('/first', (req, res) => {
res.send('Hello, Ajax');
});
01.Ajax入门.html文件代码：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Document</title>
</head>
<body>
<script type="text/javascript">
// 1.创建ajax对象
var xhr = new XMLHttpRequest();
// 2.告诉Ajax对象要向哪发送请求，以什么方式发送请求
// 1)请求方式 2)请求地址
xhr.open('get', 'http://localhost:3000/first');
// 3.发送请求
xhr.send();
// 4.获取服务器端响应到客户端的数据
xhr.onload = function (){
// 服务端响应给客户端的数据
console.log(xhr.responseText)
}
</script>
</body>
</html>
在浏览器访问：http://localhost:3000/01.Ajax入门.html 即可拿到服务端响应给客户端的数据，打印结果如下：
二. Ajax 运行原理及实现
1 - Ajax 运行原理
Ajax 相当于浏览器发送请求与接收响应的代理人，以实现在不影响用户浏览页面的情况下，局部更新页面数据，从而提高用户体验。
2 - Ajax 的实现步骤
// 1. 创建 Ajax 对象
var xhr = new XMLHttpRequest();
// XML是一种数据格式，现在我们使用的最多的是json格式，XML格式作为了解
// 2. 告诉 Ajax 请求方式以及请求地址
xhr.open('get', 'http://www.example.com');
// 3. 发送请求
xhr.send();
// 4. 获取服务器端给与客户端的响应数据
xhr.onload = function () {
console.log(xhr.responseText);
}
3 - 服务器端响应的数据格式
在真实的项目中，服务器端大多数情况下会以 JSON 对象作为响应数据的格式。当客户端拿到响应数据时，要将 JSON 数据和 HTML 字符串进行拼接，然后将拼接的结果展示在页面中。
在 http 请求与响应的过程中，无论是请求参数还是响应内容，如果是对象类型，最终都会被转换为对象字符串进行传输。
// 将JSON字符串转换为JSON对象
var responseText = JSON.parse(xhr.responseText);
示例代码：
app.js文件：
app.get('/responseData', (req, res) => {
// 传递一个json对象给客户端
res.send({"name": "zs"});
});
html文件：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Document</title>
</head>
<body>
<script type="text/javascript">
// 1.创建ajax对象
var xhr = new XMLHttpRequest();
// 2.告诉Ajax对象要向哪发送请求，以什么方式发送请求
// 1)请求方式 2)请求地址
xhr.open('get', 'http://localhost:3000/responseData');
// 3.发送请求
xhr.send();
// 4.获取服务器端响应到客户端的数据
xhr.onload = function (){
// console.log(typeof xhr.responseText)
// 将JSON字符串转换为JSON对象
var responseText = JSON.parse(xhr.responseText);
// 测试：在控制台输出处理结果
console.log(responseText)
// 将数据和html字符串进行拼接
var str = '<h2>'+ responseText.name +'</h2>';
// 将拼接的结果追加到页面中
document.body.innerHTML = str;
}
</script>
</body>
</html>
浏览器输入：http://localhost:3000/02.处理服务器端返回的JSON数据.html结果如下：
注意：如果当前发送Ajax请求的文件地址（http://localhost:3000/02.处理服务器端返回的JSON数据.html）和Ajax请求地址（http://localhost:3000/responseData）一样，那么协议、域名、端口号都可以省略。
比如，上面的：
xhr.open('get', 'http://localhost:3000/responseData');
省略协议、域名、端口号之后：
xhr.open('get', '/responseData');
请求被发送之后，浏览器会自动把协议、域名、端口号加上。
4 - 请求参数传递
1. 传统网站表单提交
<form method="get" action="http://www.example.com">
<input type="text" name="username"/>
<input type="password" name="password">
</form>
// GET方式参数会被拼接到请求地址后面，POST方式请求参数会被放到请求体中
// 传统网站表单提交，无论是GET还是POST，最后都会转换成如下格式：
// http://www.example.com?username=zhangsan&password=123456
2. Ajax中的请求参数
① GET 请求方式
GET 请求方式，请求参数放在请求地址后面
xhr.open('get', 'http://www.example.com?name=zhangsan&age=20');
示例代码：
app.js代码：
app.get('/get', (req, res) => {
// 将客户端通过get方式传递的参数原封不动的响应回去
res.send(req.query);
});
html代码：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Document</title>
</head>
<body>
<p>
<input type="text" id="username">
</p>
<p>
<input type="text" id="age">
</p>
<p>
<input type="button" value="提交" id="btn">
</p>
<script type="text/javascript">
// 获取按钮元素
var btn = document.getElementById('btn');
// 获取姓名文本框
var username = document.getElementById('username');
// 获取年龄文本框
var age = document.getElementById('age');
// 为按钮添加点击事件
btn.onclick = function () {
// 创建ajax对象
var xhr = new XMLHttpRequest();
// 获取用户在文本框中输入的值
var nameValue = username.value;
var ageValue = age.value;
// 拼接请求参数
var params = 'username='+ nameValue +'&age=' + ageValue;
// 配置ajax对象
xhr.open('get', 'http://localhost:3000/get?'+params);
// 发送请求
xhr.send();
// 获取服务器端响应的数据
xhr.onload = function () {
console.log(xhr.responseText)
}
}
</script>
</body>
</html>
浏览器输入：http://localhost:3000/03.传递get请求参数.html，右键检查，选择Network - XHR即可查看Ajax请求，结果如下：
② POST 请求方式
POST 请求方式，请求参数放在请求体中
// 设置请求头报文
xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded')
// 设置请求体报文
xhr.send('name=zhangsan&age=20');
示例代码：
app.js文件代码：
// 引入body-parser模块，就可以直接通过req.body获取post参数了
const bodyParser = require('body-parser');
// 代表解析 application/x-www-form-urlencoded 这种格式的参数
app.use(bodyParser.urlencoded());
app.post('/post', (req, res) => {
res.send(req.body);
});
html文件代码：
// 拼接请求参数
var params = 'username='+ nameValue +'&age=' + ageValue;
// 配置ajax对象
xhr.open('post', 'http://localhost:3000/post');
// 设置请求参数格式的类型（post请求必须要设置）
xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
// 发送请求
xhr.send(params);
// 获取服务器端响应的数据
xhr.onload = function () {
console.log(xhr.responseText)
}
// 浏览器输入：http://localhost:3000/04.传递post请求参数.html
浏览器输入：http://localhost:3000/04.传递post请求参数.html结果如下：
5 - 请求参数的格式
客户端通过Ajax技术向服务端发送请求，请求的格式可以为：
- application/x-www-form-urlencoded
name=zhangsan&age=20&sex=男
- application/json
{name: 'zhangsan', age: '20', sex: '男'}
在请求头中指定 Content-Type 属性的值是 application/json，告诉服务器端当前请求参数的格式是 json对象格式。
JSON.stringify() // 将json对象转换为json字符串
JSON.parse(xhr.responseText);// 将json字符串转换为json对象
注意：get 请求是不能提交application/json对象数据格式的，只能提交application/x-www-form-urlencoded数据格式，传统网站的表单提交也是不支持application/json对象数据格式的。
示例代码：
// app.js文件代码:
const bodyParser = require('body-parser');
// 代表解析json格式的数据
app.use(bodyParser.json());
app.post('/json', (req, res) => {
res.send(req.body);
});
// html文件代码:
// 1.创建ajax对象
var xhr = new XMLHttpRequest();
// 2.告诉Ajax对象要向哪发送请求，以什么方式发送请求
// 1)请求方式 2)请求地址
xhr.open('post', 'http://localhost:3000/json');
// 通过请求头告诉服务器端客户端向服务器端传递的请求参数的格式是什么
xhr.setRequestHeader('Content-Type', 'application/json');
// JSON.stringify() 将json对象转换为json字符串 因为传递请求参数的时候只能传递字符串
// 3.发送请求
xhr.send(JSON.stringify({name: 'lisi', age:50}));
// 4.获取服务器端响应到客户端的数据
xhr.onload = function (){
console.log(xhr.responseText) // 打印返回的数据
console.log(typeof(xhr.responseText)); // 打印数据类型
}
结果为：
6 - 获取服务器端的响应
1. Ajax 状态码
在创建ajax对象，配置ajax对象，发送请求，以及接收完服务器端响应数据，这个过程中的每一个步骤都会对应一个数值，这个数值就是ajax状态码。
0：请求未初始化(还没有调用open())
1：请求已经建立，但是还没有发送(还没有调用send())
2：请求已经发送
3：请求正在处理中，通常响应中已经有部分数据可以用了
4：响应已经完成，可以获取并使用服务器的响应了
xhr.readyState // 获取Ajax状态码
2. onreadystatechange 事件
当 Ajax 状态码发生变化时将自动触发该事件。
在事件处理函数中可以获取 Ajax 状态码并对其进行判断，当状态码为 4 时就可以通过 xhr.responseText 获取服务器端的响应数据了。
// 当Ajax状态码发生变化时
xhr.onreadystatechange = function () {
// 判断当Ajax状态码为4时
if (xhr.readyState == 4) {
// 获取服务器端的响应数据
console.log(xhr.responseText);
}
}
// 先监听，后发送请求
xhr.send();
3. 两种获取服务器端响应方式的区别
总结：onload事件执行效率比onreadystatechange事件高，推荐使用onload事件。
7 - Ajax 错误处理
- 网络畅通，服务器端能接收到请求，服务器端返回的结果不是预期结果
--> 可以判断服务器端返回的状态码，分别进行处理。xhr.status获取http状态码 - 网络畅通，服务器端没有接收到请求，返回404状态码
--> 检查请求地址是否错误 - 网络畅通，服务器端能接收到请求，服务器端返回500状态码
--> 服务器端错误，找后端程序员进行沟通 - 网络中断，请求无法发送到服务器端
--> 会触发xhr对象下面的onerror事件，在onerror事件处理函数中对错误进行处理
示例代码：
// 服务端代码：
app.get('/error', (req, res) => {
res.status(400).send('not ok');
});
// 客户端代码：
// 4.获取服务器端响应到客户端的数据
xhr.onload = function (){
// xhr.status获取http状态码
console.log(xhr.responseText); // 'not ok'
if (xhr.status == 400) {
alert('请求出错')
}
}
// 右键检查 Network - offline 模拟无网络环境
// 当网络中断时会触发onerrr事件
xhr.onerror = function () {
alert('网络中断, 无法发送Ajax请求')
}
8 - 低版本 IE 浏览器的缓存问题
问题：在低版本的 IE 浏览器中，Ajax 请求有严重的缓存问题，即在请求地址不发生变化的情况下，只有第一次请求会真正发送到服务器端，后续的请求都会从浏览器的缓存中获取结果。即使服务器端的数据更新了，客户端依然拿到的是缓存中的旧数据。
解决方案：在请求地址的后面加请求参数，保证每一次请求中的请求参数的值不相同。
xhr.open('get', 'http://www.example.com?t=' + Math.random()); // 随便写一个参数
三. Ajax 异步编程
1 - 同步异步概述
同步：
- 一个人同一时间只能做一件事情，只有一件事情做完，才能做另外一件事情。
- 落实到代码中，就是上一行代码执行完成后，才能执行下一行代码，即代码逐行执行。
console.log('before');
console.log('after');
异步：
- 一个人一件事情做了一半，转而去做其他事情，当其他事情做完以后，再回过头来继续做之前未完成的事情。
- 落实到代码上，就是异步代码虽然需要花费时间去执行，但程序不会等待异步代码执行完成后再继续执行后续代码，而是直接执行后续代码，当后续代码执行完成后再回头看异步代码是否返回结果，如果已有返回结果，再调用事先准备好的回调函数处理异步代码执行的结果。
console.log('before');
setTimeout(
() => { console.log('last');
}, 2000);
console.log('after');
2 - Ajax 封装
问题：发送一次请求代码过多，发送多次请求代码冗余且重复。
解决方案：将请求代码封装到函数中，发请求时调用函数即可。
function ajax (options) {
// 存储的是默认值
var defaults = {
type: 'get', // 请求方式
url: '', // 请求地址
data: {}, // 请求参数(对象类型)
header: { // 请求头(设置请求参数的格式)
'Content-Type': 'application/x-www-form-urlencoded'
},
success: function () {}, // 成功回调 参数：(responseData, xhr)
error: function () {} // 失败回调 参数：(responseData, xhr)
};
// 使用options对象中的属性覆盖defaults对象中的属性
// 会影响原对象，所以不用接收结果
Object.assign(defaults, options);
// 创建ajax对象
var xhr = new XMLHttpRequest();
// 拼接请求参数的变量
var params = '';
// 循环用户传递进来的对象格式参数
// defaults.data是对象类型，所以我们使用forin循环
for (var attr in defaults.data) {
// 将参数转换为字符串格式
// 注意：defaults.data是个对象，对象后面不能点一个临时变量，所以写成defaults.data[attr]
params += attr + '=' + defaults.data[attr] + '&';
}
// 将参数最后面的&截取掉
// 将截取的结果重新赋值给params变量
params = params.substr(0, params.length - 1);
// 判断请求方式
if (defaults.type == 'get') {
defaults.url = defaults.url + '?' + params;
}
// 配置ajax对象
xhr.open(defaults.type, defaults.url);
// 如果请求方式为post
if (defaults.type == 'post') {
// 用户希望的向服务器端传递的请求参数的类型
// 注意：
// 数据是{'Content-Type': 'application/x-www-form-urlencoded'}这样的
// 因为'Content-Type'两边有单引号，不是变量，所以不能使用点语法
var contentType = defaults.header['Content-Type']
// 设置请求参数格式的类型
xhr.setRequestHeader('Content-Type', contentType);
// 判断用户希望的请求参数格式的类型
// 如果类型为json
if (contentType == 'application/json') {
// 向服务器端传递json数据格式的参数
xhr.send(JSON.stringify(defaults.data))
} else {
// 向服务器端传递普通类型的请求参数
xhr.send(params);
}
} else {
// 发送请求
xhr.send();
}
// 监听xhr对象下面的onload事件
// 当xhr对象接收完响应数据后触发
xhr.onload = function () {
// xhr.getResponseHeader()
// 获取响应头中的数据
var contentType = xhr.getResponseHeader('Content-Type');
// 服务器端返回的数据
var responseText = xhr.responseText;
// 如果响应类型中包含applicaition/json
if (contentType.includes('application/json')) {
// 将json字符串转换为json对象
responseText = JSON.parse(responseText)
}
// 当http状态码等于200的时候
if (xhr.status == 200) {
// 请求成功 调用处理成功情况的函数 返回的是json对象
defaults.success(responseText, xhr);
} else {
// 请求失败 调用处理失败情况的函数 返回的是json对象
defaults.error(responseText, xhr);
}
}
}
// 调用ajax函数,传入一个对象
ajax({
// 请求方式
type: 'post',
// 请求地址
url: 'http://localhost:3000/responseData',
header: { 'Content-Type': 'application/json'},
success: function (responseObj, xhr) {
console.log('这里是success函数');
console.log(responseObj); // 返回的是json对象
console.log(xhr);
},
error: function (responseObj, xhr) {
console.log('这里是失败函数');
console.log(responseObj); // 返回的是json对象
console.log(xhr);
},
})
