axios使用分析

最新推荐文章于 2022-11-25 15:20:15 发布

牛先森家的牛奶

最新推荐文章于 2022-11-25 15:20:15 发布

阅读量1.3k

点赞数

分类专栏： axios Vue 文章标签： ajax

本文链接：https://blog.csdn.net/weixin_42681295/article/details/108300070

版权

Vue 同时被 2 个专栏收录

119 篇文章 5 订阅

订阅专栏

axios

4 篇文章 0 订阅

订阅专栏

axios 从入门到源码分析

axios 从入门到源码分析

axios 从入门到源码分析

第 1 章：HTTP 相关

1.1. MDN 文档

https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Overview

1.2. HTTP

在这里插入图片描述

前后应用从浏览器端向服务器发送 HTTP 请求(请求报文)
后台服务器接收到请求后, 调度服务器应用处理请求, 向浏览器端返回 HTTP
响应(响应报文)
浏览器端接收到响应, 解析显示响应体 / 调用监视回调

1.3. HTTP 请求报文

请求行:
method url
GET /product_detail?id=2
POST /login
多个请求头
Host: www.baidu.com
Cookie: BAIDUID=AD3B0FA706E; BIDUPSID=AD3B0FA706;
Content-Type: application/x-www-form-urlencoded 或者 application/json
请求体
username=fqniu&pwd=123456
{“username”: “fqniu”, “pwd”: 123456}

1.4. HTTP 响应报文

响应状态行: status statusText
多个响应头
Content-Type: text/html;charset=utf-8
Set-Cookie: BD_CK_SAM=1;path=/
响应体
html 文本/json 文本/js/css/图片…

1.5. post 请求体参数格式

Content-Type: application/x-www-form-urlencoded;charset=utf-8
用于键值对参数，参数的键值用=连接, 参数之间用&连接
例如: name=%E5%B0%8F%E6%98%8E&age=12
Content-Type: application/json;charset=utf-8
用于 json 字符串参数
例如: {“name”: “%E5%B0%8F%E6%98%8E”, “age”: 12}
Content-Type: multipart/form-data ：用于文件上传请求

1.6. 常见的响应状态码

200 OK 请求成功。一般用于 GET 与 POST 请求
201 Created 已创建。成功请求并创建了新的资源
401 Unauthorized 未授权/请求要求用户的身份认证
404 Not Found 服务器无法根据客户端的请求找到资源
500 Internal Server Error 服务器内部错误，无法完成请求

1.7. 不同类型的请求及其作用

GET: 从服务器端读取数据
POST: 向服务器端添加新数据
PUT: 更新服务器端已经数据
DELETE: 删除服务器端数据

1.8. API 的分类

REST API: restful
(1) 发送请求进行 CRUD 哪个操作由请求方式来决定
(2) 同一个请求路径可以进行多个操作
(3) 请求方式会用到 GET/POST/PUT/DELETE
非 REST API: restless
(1) 请求方式不决定请求的 CRUD 操作
(2) 一个请求路径只对应一个操作
(3) 一般只有 GET/POST

1.9. 使用 json-server 搭建 REST API

1.9.1. json-server 是什么?
用来快速搭建 REST API 的工具包

1.9.2. 使用 json-server

在线文档: https://github.com/typicode/json-server
下载: npm install -g json-server
目标根目录下创建数据库 json 文件: db.json

{
  "posts": [
   { "id": 1, "title": "json-server", "author": "typicode" }
   ],
  "comments": [
  { "id": 1, "body": "some comment", "postId": 1 }
  ],
  "profile": { "name": "typicode" }
}

启动服务器执行命令: json-server --watch db.json

1.9.3. 使用浏览器访问测试
http://localhost:3000/posts
http://localhost:3000/posts/1

1.9.4. 使用 axios 访问测试
在这里插入图片描述

第 2 章：XHR 的理解和使用

2.1. MDN

https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest

2.2. 理解

使用 XMLHttpRequest (XHR)对象可以与服务器交互, 也就是发送 ajax 请求
前端可以获取到数据，而无需让整个的页面刷新。
这使得 Web 页面可以只更新页面的局部，而不影响用户的操作。

2.3. 区别一般 http 请求与 ajax 请求

ajax 请求是一种特别的 http 请求
对服务器端来说, 没有任何区别, 区别在浏览器端
浏览器端发请求: 只有 XHR 或 fetch 发出的才是 ajax 请求, 其它所有的都是
非 ajax 请求
浏览器端接收到响应
(1) 一般请求: 浏览器一般会直接显示响应体数据, 也就是我们常说的刷新/
跳转页面
(2) ajax 请求: 浏览器不会对界面进行任何更新操作, 只是调用监视的回调
函数并传入响应相关数据

2.4. API

XMLHttpRequest(): 创建 XHR 对象的构造函数
status: 响应状态码值, 比如 200, 404
statusText: 响应状态文本
readyState: 标识请求状态的只读属性
0: 初始
1: open()之后
2: send()之后
3: 请求中
4: 请求完成
onreadystatechange: 绑定 readyState 改变的监听
responseType: 指定响应数据类型, 如果是’json’, 得到响应后自动解析响应
体数据
response: 响应体数据, 类型取决于 responseType 的指定
timeout: 指定请求超时时间, 默认为 0 代表没有限制
ontimeout: 绑定超时的监听
onerror: 绑定请求网络错误的监听
open(): 初始化一个请求, 参数为: (method, url[, async])
send(data): 发送请求
abort(): 中断请求
getResponseHeader(name): 获取指定名称的响应头值
getAllResponseHeaders(): 获取所有响应头组成的字符串
setRequestHeader(name, value): 设置请求头

2.5. XHR 的的 ajax 封装( 简单版 axios)

2.5.1. 特点

函数的返回值为 promise, 成功的结果为 response, 异常的结果为 error
能处理多种类型的请求: GET/POST/PUT/DELETE
函数的参数为一个配置对象

{
  url: '', // 请求地址
  method: '', // 请求方式 GET/POST/PUT/DELETE
  params: {}, // GET/DELETE 请求的 query 参数
  data: {}, // POST 或 DELETE 请求的请求体参数
}

响应 json 数据自动解析为 js

2.5.2. 编码实现

 <script>
    /*
      使用 XHR 封装发送 ajax 请求的通用函数
      返回值: promise
      参数为配置对象
      url: 请求地址
      params: 包含所有 query 请求参数的对
      象 {name: tom, age: 12} ==> name=tom&age=12
      data: 包含所有请求体参数数据的对象
      method: 为请求方式
    */
    function axios({ url, method = 'GET', params = {}, data = {} }) {
      method = method || 'GET'
      method = method.toUpperCase()
      // 将 params 中的参数属性拼接到 url 上
      // {name: tom: pwd: 123} ===> queryStr=name=tom&pwd=123
      // url + ? + queryStr
      let queryStr = ''
      Object.keys(params).forEach(key => {
        // &pwd=123
        queryStr += '&' + key + '=' + params[key]
      })
      // '&name=tom&pwd=123' 或者 ''
      if (queryStr) {
        queryStr = queryStr.substring(1) // 'name=tom&pwd=123'
        url += '?' + queryStr // /user?name=tom&pwd=123
      }
      return new Promise((resolve, reject) => {
        // 创建 XHR 对象
        const request = new XMLHttpRequest()
        // 打开连接(初始化请求对象)
        request.open(method, url, true)
        // 设置响应数据类型 ==> 自动解析 json 文本为 js 对象/数组, 保存给
        // response 属性上
        request.responseType = 'json'
        // 绑定监视 request 的状态改变的监听

        request.onreadystatechange = function () {
          // 如果请求还没有完成, 直接结束
          if (request.readyState !== 4) {
            return
          }
          const { status, statusText } = request
          // 如果成功了, 取出数据封装成成功的响应数据对象 response, 调用
          resolve(response)
          if (status >= 200 && status < 300) { // 在[200, 300)
            const response = {
              // data: JSON.parse(request.response),
              data: request.response,
              status,
              statusText
            }
            resolve(response)
          } else {
            // 如果失败了, 封装失败相关信息成 error 对象, 调用 reject(error)
            reject(new Error('request error status is ' + status))
          }
        }
        if (method === 'GET' || method === 'DELETE') {
          // 发送请求
          request.send()
        } else { // POST/PUT
          // 设置请求头
          request.setRequestHeader('Content-Type', 'application/json;charset = utf - 8')
          // 发送请求
          request.send(JSON.stringify(data))
        }
      })
    }

  </script>

2.5.3. 使用测试


  <script>
    function testGet() {
      axios({
        url: 'http://localhost:3000/comments',
        // url: 'http://localhost:3000/comments2',
        params: { id: 3 },
      }).then(response => {
        console.log('get success', response.data, response)
      }).catch(error => {
        alert(error.message)
      })
    }

    function testPost() {
      axios({
        url: 'http://localhost:3000/comments',
        // url: 'http://localhost:3000/comments2',
        method: 'POST',
        data: { body: 'aaaa', postId: 2 }
      }).then(response => {
        console.log('post success', response.data, response)
      }).catch(error => {
        alert(error.message)
      })
    }

    function testPut() {
      axios({
        url: 'http://localhost:3000/comments/3',
        // url: 'http://localhost:3000/comments/39',
        method: 'put',
        data: { body: 'abcdefg', "postId": 2 }
      }).then(response => {
        console.log('put success', response.data, response)
      }).catch(error => {
        alert(error.message)
      })
    }
    
    function testDelete() {
      axios({
        url: 'http://localhost:3000/comments/1',
        method: 'delete',
        params: {
          body: 'some comment'
        }
      }).then(response => {
        console.log('delete success', response.data, response)
      }).catch(error => {
        alert(error.message)
      })
    }
  </script>

第 3 章：axios

3.1. axios 是什么?

前端最流行的 ajax 请求库
react/vue 官方都推荐使用 axios 发 ajax 请求
文档: https://github.com/axios/axios

3.2. axios 特点

基本 promise 的异步 ajax 请求库
浏览器端/node 端都可以使用
支持请求／响应拦截器
支持请求取消
请求/响应数据转换
批量发送多个请求

3.3. axios 常用语法


axios(config): 通用/最本质的发任意类型请求的方式
axios(url[, config]): 可以只指定 url 发 get 请求
axios.request(config): 等同于 axios(config)
axios.get(url[, config]): 发 get 请求
axios.delete(url[, config]): 发 delete 请求
axios.post(url[, data, config]): 发 post 请求
axios.put(url[, data, config]): 发 put 请求
axios.defaults.xxx: 请求的默认全局配置
axios.interceptors.request.use(): 添加请求拦截器
axios.interceptors.response.use(): 添加响应拦截器
axios.create([config]): 创建一个新的 axios(它没有下面的功能)
axios.Cancel(): 用于创建取消请求的错误对象
axios.CancelToken(): 用于创建取消请求的 token 对象
axios.isCancel(): 是否是一个取消请求的错误
axios.all(promises): 用于批量执行多个异步请求
axios.spread(): 用来指定接收所有成功数据的回调函数的方法

3.4. 难点语法的理解和使用

3.4.1. axios.create(config)

根据指定配置创建一个新的 axios, 也就就每个新 axios 都有自己的配置
新 axios 只是没有取消请求和批量发请求的方法, 其它所有语法都是一致的
为什么要设计这个语法?
(1) 需求: 项目中有部分接口需要的配置与另一部分接口需要的配置不太一
样, 如何处理
(2) 解决: 创建 2 个新 axios, 每个都有自己特有的配置, 分别应用到不同要
求的接口请求中

3.4.2. 拦截器函数/ajax 请求/ 请求的回调函数的调用顺序

说明: 调用 axios()并不是立即发送 ajax 请求, 而是需要经历一个较长的流程
流程: 请求拦截器2 => 请求拦截器1 => 发ajax请求 => 响应拦截器1 => 响
应拦截器 2 => 请求的回调
注意: 此流程是通过 promise 串连起来的, 请求拦截器传递的是 config, 响应
拦截器传递的是 response

3.4.3. 取消请求

基本流程
配置 cancelToken 对象
缓存用于取消请求的 cancel 函数
在后面特定时机调用 cancel 函数取消请求
在错误回调中判断如果 error 是 cancel, 做相应处理
实现功能
点击按钮, 取消某个正在请求中的请求
在请求一个接口前, 取消前面一个未完成的请求

第 4 章：axios 源码分析

4.1. 源码目录结构

├── /dist/ # 项目输出目录
├── /lib/ # 项目源码目录
│ ├── /adapters/ # 定义请求的适配器 xhr、http
│ │ ├── http.js # 实现 http 适配器(包装 http 包)
│ │ └── xhr.js # 实现 xhr 适配器(包装 xhr 对象)
│ ├── /cancel/ # 定义取消功能
│ ├── /core/ # 一些核心功能
│ │ ├── Axios.js # axios 的核心主类
│ │ ├── dispatchRequest.js # 用来调用 http 请求适配器方法发送请求的函数
│ │ ├── InterceptorManager.js # 拦截器的管理器
│ │ └── settle.js # 根据 http 响应状态，改变 Promise 的状态
│ ├── /helpers/ # 一些辅助方法
│ ├── axios.js # 对外暴露接口
│ ├── defaults.js # axios 的默认配置
│ └── utils.js # 公用工具
├── package.json # 项目信息
├── index.d.ts # 配置 TypeScript 的声明文件
└── index.js # 入口文件

4.2. 源码分析

4.2.1. axios 与与 Axios 的关系?

从语法上来说: axios 不是 Axios 的实例
从功能上来说: axios 是 Axios 的实例
axios 是 Axios.prototype.request 函数 bind()返回的函数
axios 作为对象有 Axios 原型对象上的所有方法, 有 Axios 对象上所有属性

4.2.2. instance 与与 axios 的区别?

相同:
(1) 都是一个能发任意请求的函数: request(config)
(2) 都有发特定请求的各种方法: get()/post()/put()/delete()
(3) 都有默认配置和拦截器的属性: defaults/interceptors
不同:
(1) 默认匹配的值很可能不一样
(2) instance 没有 axios 后面添加的一些方法: create()/CancelToken()/all()

4.2.3. axios 运行的整体流程？

在这里插入图片描述

整体流程:
request(config) ==> dispatchRequest(config) ==> xhrAdapter(config)
request(config):
将请求拦截器 / dispatchRequest() / 响应拦截器通过 promise 链串连起来,
返回 promise
dispatchRequest(config):
转换请求数据 ===> 调用 xhrAdapter()发请求 ===> 请求返回后转换响应数
据. 返回 promise
xhrAdapter(config):
创建 XHR 对象, 根据 config 进行相应设置, 发送特定请求, 并接收响应数据,
返回 promise

4.2.4. axios 的请求/ 响应拦截器是什么?

在这里插入图片描述

请求拦截器:
在真正发送请求前执行的回调函数
可以对请求进行检查或配置进行特定处理
成功的回调函数, 传递的默认是 config(也必须是)
失败的回调函数, 传递的默认是 error
响应拦截器
在请求得到响应后执行的回调函数
可以对响应数据进行特定处理
成功的回调函数, 传递的默认是 response
失败的回调函数, 传递的默认是 error

4.2.5. axios 的请求/ 响应数据转换器是什么?

请求转换器: 对请求头和请求体数据进行特定处理的函数
if (utils.isObject(data)) {
setContentTypeIfUnset(headers, ‘application/json;charset=utf-8’);
return JSON.stringify(data);
}
响应转换器: 将响应体 json 字符串解析为 js 对象或数组的函数
response.data = JSON.parse(response.data)

4.2.6. response 的整体结构

{
  data,
  status,
  statusText,
  headers,
  config,
  request
}

4.2.7. error 的整体结构

{
  message,
  response,
  request,
}

4.2.8. 如何取消未完成的请求?

当配置了 cancelToken 对象时, 保存 cancel 函数
(1) 创建一个用于将来中断请求的 cancelPromise
(2) 并定义了一个用于取消请求的 cancel 函数
(3) 将 cancel 函数传递出来
调用 cancel()取消请求
(1) 执行 cacel 函数, 传入错误信息 message
(2) 内部会让 cancelPromise 变为成功, 且成功的值为一个 Cancel 对象
(3) 在 cancelPromise 的成功回调中中断请求, 并让发请求的 proimse 失败,
失败的 reason 为 Cacel 对象

补充：使用拦截器

import axios from 'axios'
// 配置请求根路径
// 本机地址
// axios.defaults.baseURL = 'http://127.0.0.1:8080/api/private/v1/'
// 远程后台地址
axios.defaults.baseURL = 'https://www.xxxxxx.xxx:8080/api/private/v1/'

// 在request 拦截器中, 展示进度条 NProgress.start()
// 请求在到达服务器之前，先会调用use中的这个回调函数来添加请求头信息
axios.interceptors.request.use(config => {
  NProgress.start()
  // console.log(config)
  // 为请求头对象，添加token验证的Authorization字段
  config.headers.Authorization = window.sessionStorage.getItem('token')
  // 在最后必须 return config
  return config
})
// response 拦截器中,  隐藏进度条NProgress.done()
axios.interceptors.response.use(config => {
  NProgress.done()
  return config
})
// 挂在到Vue实例，后面可通过this调用
Vue.prototype.$http = axios

牛先森家的牛奶

关注

0
点赞
踩
3

收藏

觉得还不错? 一键收藏
0
评论
axios使用分析

axios 从入门到源码分析axios 从入门到源码分析第 1 章：HTTP 相关1.1. MDN 文档1.2. HTTP1.3. HTTP 请求报文1.4. HTTP 响应报文1.5. post 请求体参数格式1.6. 常见的响应状态码1.7. 不同类型的请求及其作用1.8. API 的分类1.9. 使用 json-server 搭建 REST API第 2 章：XHR 的理解和使用2.1. MDN2.2. 理解2.3. 区别一般 http 请求与 ajax 请求2.4
复制链接

扫一扫