一、Promise的起因
当项目有需求时,需要封装一个方法,给一个要读取文件的路径,使用这个方法去读取文件并把内容返回。
例:在一个file文件夹里有三个文档,需要将里面内容读取出来
分别在1,2,3文件里保存111,222,333,然后创建js文件
1.普通读取文件的方式
const fs = require('fs')
const path = require('path')
fs.readFile(path.join(__dirname, './files/1.txt'), 'utf-8', (err, dataStr) => {
if (err) throw err
console.log(dataStr) //111
})
结果输出111
2.利用异步方式读取文件
a.利用return
function getFileByPath(fpath, callback) {
fs.readFile(fpath, 'utf-8', (err, dataStr) => {
if (err) throw(err)
return dataStr
})
}
var result = getFileByPath(path.join(__dirname, './files/1.txt'))
console.log(result) //undefined
结果如下:
原因:此时return没有在主函数内部,一个方法没有return,这个方法默认返回undefined
b.利用callback
function getFileByPath(fpath, callback) {
fs.readFile(fpath, 'utf-8', (err, dataStr) => {
if (err) throw(err)
callback(dataStr)
})
}
getFileByPath(path.join(__dirname, './files/1.txt'), (err, dataStr) => {
console.log('callback调用的方法-----'+dataStr)
})
结果输出为:
A.callback对异常结果的处理
我们可以规定: callback 中,有两个参数;第一个参数,是 失败的结果;第二个参数是成功的结果;
如果成功了,返回的结果,应该位于 callback 参数的第二个位置,此时, 第一个位置 由于没有出错,所以,放一个 null;
如果失败了,则 第一个位置放 Error对象,第二个位置放置一个 undefined
function getFileByPath(fpath, callback) {
fs.readFile(fpath, 'utf-8', (err, dataStr) => {
if (err) return callback(err)
callback(null, dataStr)
})
}
getFileByPath(path.join(__dirname, './files/1.txt'), (err, dataStr) => {
if (err) return console.log(err.message)
console.log(dataStr)//111
})
结果输出111
若路径错误的话,结果输出
ENOENT: no such file or directory, open
B.定义两个callback将正确的路径和错误的路径分开
const fs = require('fs')
const path = require('path')
//定义两个callback将正确的路径和错误的路径分开
function getFileByPath(fpath, succCb, errCb) {
fs.readFile(fpath, 'utf-8', (err, dataStr) => {
if (err) return errCb(err)
succCb(dataStr)
})
}
getFileByPath(path.join(__dirname, './files/1.txt'), function (data) {
console.log(data + '成功了!!!')
}, function (err) {
console.log('失败的结果,我们使用失败的回调处理了一下:' + err.message)
})
当路径正确时:
当路径错误时:
C.当出现需求时:先读取文件1,再读取文件2,最后再读取文件3
const fs = require('fs')
const path = require('path')
function getFileByPath(fpath, succCb, errCb) {
fs.readFile(fpath, 'utf-8', (err, dataStr) => {
if (err) return errCb(err)
succCb(dataStr)
})
}
getFileByPath(path.join(__dirname, './files/1.txt'), function (data) {
console.log(data)
getFileByPath(path.join(__dirname, './files/2.txt'), function (data) {
console.log(data)
getFileByPath(path.join(__dirname, './files/3.txt'), function (data) {
console.log(data)
})
})
})
结果如下:
当出现回调地狱时,可以利用ES6的promise来解决
二、promise的基本介绍
本质:是单纯的为了解决回调地狱问题;并不能帮我们减少代码量;
将回调地狱的调用关系,改变为串联关系
1.
Promise 是一个 构造函数,既然是构造函数, 那么,我们就可以 new Promise() 得到一个 Promise 的实例;
2.
在 Promise 上,有两个函数,分别叫做 resolve(成功之后的回调函数) 和 reject(失败之后的回调函数)
3.
在 Promise 构造函数的 Prototype 属性上,有一个 .then() 方法,也就说,只要是 Promise 构造函数创建的实例,都可以访问到 .then() 方法
4.
Promise 表示一个 异步操作;每当我们 new 一个 Promise 的实例,这个实例,就表示一个具体的异步操作;
5.
既然 Promise 创建的实例,是一个异步操作,那么,这个 异步操作的结果,只能有两种状态:
-
5.1 状态1: 异步执行成功了,需要在内部调用 成功的回调函数 resolve 把结果返回给调用者;
-
5.2 状态2: 异步执行失败了,需要在内部调用 失败的回调函数 reject 把结果返回给调用者;
-
5.3 由于 Promise 的实例,是一个异步操作,所以,内部拿到 操作的结果后,无法使用 return 把操作的结果返回给调用者; 这时候,只能使用回调函数的形式,来把 成功 或 失败的结果,返回给调用者;
6.
我们可以在 new 出来的 Promise 实例上,调用 .then() 方法,【预先】 为 这个 Promise 异步操作,指定 成功(resolve) 和 失败(reject) 回调函数;
1.形式上和具体的promise异步操作的区别
注意:这里 new 出来的 promise, 只是代表 【形式上】的一个异步操作;
什么是形式上的异步操作:就是说,我们只知道它是一个异步操作,但是做什么具体的异步事情,目前还不清楚
// 这是一个具体的异步操作,其中,使用 function 指定一个具体的异步操作
var promise = new Promise(function(){
// 这个 function 内部写的就是具体的异步操作!!!
})
2.创建一个具体的异步操作
const fs = require('fs')
var promise = new Promise(function () {
fs.readFile('./files/2.txt', 'utf-8', (err, dataStr) => {
if (err) throw err
console.log(dataStr) //222
})
})
注意:每当 new 一个 Promise 实例的时候,就会立即执行这个异步操作中的代码;即,当前操作会立即执行
也就是说,new 的时候,除了能够得到 一个 promise 实例之外,还会立即调用 我们为 Promise 构造函数传递的那个 function,执行这个 function 中的 异步操作代码;
3.利用函数封装,之后再进行调用
使promise不用立即执行
function getFileByPath(fpath) {
var promise = new Promise(function () {
fs.readFile(fpath, 'utf-8', (err, dataStr) => {
if (err) throw err
console.log(dataStr)
})
})
}
getFileByPath('./files/2.txt') //222
三、通过.then指定成功或失败的回调
function getFileByPath(fpath) {
return new Promise(function (resolve, reject) {
fs.readFile(fpath, 'utf-8', (err, dataStr) => {
if (err) return reject(err)
resolve(dataStr)
})
})
}
getFileByPath('./files/2.txt')
.then(function (data) {
console.log(data) //222
}, function (err) {
console.log(err.message)
})
不管是成功还是失败都会返回读取到的内容
1.解决回调地狱
需求:先读取文件1,在读取2,最后读取3
注意:通过 .then 指定 回调函数的时候,成功的回调函数,必须传,但是,失败的回调,可以省略不传
const fs = require('fs')
function getFileByPath(fpath) {
return new Promise(function (resolve, reject) {
fs.readFile(fpath, 'utf-8', (err, dataStr) => {
if (err) return reject(err)
resolve(dataStr)
})
})
}
//错误示范
getFileByPath('./files/1.txt')
.then(function (data) {
console.log(data)
getFileByPath('./files/2.txt')
.then(function (data) {
console.log(data)
getFileByPath('./files/3.txt')
.then(function (data) {
console.log(data)
})
})
})
这是一个错误示范
正确做法:
在上一个 .then 中,返回一个新的 promise 实例,可以继续用下一个 .then 来处理
const fs = require('fs')
function getFileByPath(fpath) {
return new Promise(function (resolve, reject) {
fs.readFile(fpath, 'utf-8', (err, dataStr) => {
if (err) return reject(err)
resolve(dataStr)
})
})
}
//正确做法
getFileByPath('./files/1.txt')
.then(function (data) {
console.log(data)
// 读取文件2
return getFileByPath('./files/2.txt')
})
.then(function (data) {
console.log(data)
return getFileByPath('./files/3.txt')
})
.then(function (data) {
console.log(data)
})
结果如下:
四、捕获异常的两种方式
1.如果前面的 Promise 执行失败,我们不想让后续的Promise 操作被终止,可以为每个 promise 指定失败的回调
如果前面的 Promise 执行失败了,但是不要影响后续 promise 的正常执行,此时,我们可以单独为 每个 promise,通过 .then 指定一下失败的回调
const fs = require('fs')
function getFileByPath(fpath) {
return new Promise(function (resolve, reject) {
fs.readFile(fpath, 'utf-8', (err, dataStr) => {
if (err) return reject(err)
resolve(dataStr)
})
})
}
getFileByPath('./files/11.txt')
.then(function (data) {
console.log(data)
// 读取文件2
return getFileByPath('./files/2.txt')
}, function (err) {
console.log('这是失败的结果:' + err.message)
// return 一个 新的 Promise
return getFileByPath('./files/2.txt')
})
.then(function (data) {
console.log(data)
return getFileByPath('./files/3.txt')
})
.then(function (data) {
console.log(data)
}).then(function (data) {
console.log(data)
})
console.log('OKOKOK')
结果如下:
2.利用catch去处理promise抛出的异常
如果 后续的Promise 执行,依赖于 前面 Promise 执行的结果,如果前面的失败了,则后面的就没有继续执行下去的意义了,此时,我们想要实现,一旦有报错,则立即终止所有 Promise的执行;
const fs = require('fs')
function getFileByPath(fpath) {
return new Promise(function (resolve, reject) {
fs.readFile(fpath, 'utf-8', (err, dataStr) => {
if (err) return reject(err)
resolve(dataStr)
})
})
}
//catch处理异常
getFileByPath('./files/1.txt')
.then(function (data) {
console.log(data)
// 读取文件2
return getFileByPath('./files/22.txt')
})
.then(function (data) {
console.log(data)
return getFileByPath('./files/3.txt')
})
.then(function (data) {
console.log(data)
})
.catch(function (err) { console.log('这是自己的处理方式:' + err.message)
})
catch 的作用: 如果前面有任何的 Promise 执行失败,则立即终止所有 promise 的执行,并马上进入 catch 去处理 Promise中 抛出的异常;
五、JQuery中Ajax使用promise指定成功的回调函数
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Document</title>
</head>
<body>
<input type="button" value="获取数据" id="btn">
<script src="./node_modules/jquery/dist/jquery.min.js"></script>
<script>
$(function () {
$('#btn').on('click', function () {
$.ajax({
url: './data.json',
type: 'get',
dataType: 'json'
})
.then(function (data) {
console.log(data)
})
})
});
</script>
</body>
</html>