百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

详解网络请求Axios

myzbx 2025-01-01 21:41 16 浏览

Axios是什么?

Axios 是一个基于 promise 的 HTTP 库,可以用在浏览器和 node.js 中。我们知道 Promise 是 js 异步的一种解决方案,它最大的特性就是可以通过 .then 的方式来进行链式调用。

其实说白了axios是对ajax的封装,axios有的ajax都有,ajax有的axios不一定有,总结一句话就是axios是ajax,ajax不止axios。

为什么选择axios?

  1. vue的作者尤雨溪推荐使用axios.
  2. 符合前后端分离的趋势,及前端的MVVM的浪潮

功能特点:

  • 在浏览器中发送XMLHttpRequests请求
  • 在node.js中发送http请求
  • 支持Promise API
  • 拦截请求和响应
  • 转换请求和响应数据
  • 取消请求
  • 自动转换 JSON 数据
  • 客户端支持防御 XSRF
  • 支持多种请求方式:

  • axios(config)
  • axios.request(config)
  • axios.get(url, [, config])
  • axios.delete(url, [, config])
  • axios.head(url, [, config])
  • axios.post(url, [,data[,config] ])
  • axios.put(url, [,data[,config] ])
  • axios.patch(url, [,data[,config] ])
  • Axios的基本使用

    axios的使用比较简单,文档讲得也非常清晰,你应该先阅读axios的官方文档:axios文档。

    在html页面中直接引入使用:

    <script src="https://unpkg.com/axios/dist/axios.min.js"></script>

    Html页面基本使用

    以下案例中的get请求地址为crmeb相关演示站地址,可用于测试获取!

    1. 获取一个get请求
    <script>
      const url = 'https://store.crmeb.net/api/pc/get_category_product'
      axios({
        url: url,
        method: 'get',  // 这里可以省略,默认为get
      }).then(res => {
        // 返回请求到的数据
        console.log(res)
      }).catch(err => {
        // 返回错误信息
        console.log(err)
      })  
    </script>
    1. 在get请求的url中传参,只需要定义一个params:{}即可!
    <script>
      const url = 'https://store.crmeb.net/api/pc/get_category_product'
      axios({
        url: url,
        method: 'get',  // 这里可以省略,默认为get
        // 这里的键值对会拼接成这样url?page=1&limit=3
        params: {
          page: 1,
          limit: 3
        }
      }).then(res => {
        // 返回请求到的数据
        console.log(res)
      }).catch(err => {
        // 返回错误信息
        console.log(err)
      })  
    </script>
    1. 发送一个post请求,与get请求类似,只需要将method改为post,定义一个data:{}即可,data中的数据则是服务器需要接收的字段数据!
    <script>
    axios({
      method: 'post',
      url: '/user/12345',
      data: {
        firstName: 'Fred',
        lastName: 'Flintstone'
      }
    }).then(res => {
        // 返回请求到的数据
        console.log(res)
      }).catch(err => {
        // 返回错误信息
        console.log(err)
      });
    </script>
    1. 发送一个并发请求

    如果在开发中需要等到多个接口的数据同时请求到后才能继续后边的逻辑,那么即可使用并发请求,axios并发请求,使用all方法,all方法的参数为一个数组,数组的每个值可以为一次请求,请求完成后直接.then即可合并两次请求的数据,返回结果为一个数组!

    <script>
    axios.all([
        axios({
            url: 'https://store.crmeb.net/api/pc/get_products',
            params: {
                page: 1,
                limit: 20,
                cid: 57,
                sid: 0,
                priceOrder: '', 
                news: 0,
            }
        }),
        axios({
            url: 'https://store.crmeb.net/api/pc/get_company_info',
        })
    ]).then(results => {
        console.log(results)
    })
    </script>

    如果你想自动把这个数组展开的话在then()方法中传入axios.spread()方法即可,如下所示:

    <script>
    axios.all([
        axios({
            url: 'https://store.crmeb.net/api/pc/get_products',
            params: {
                page: 1,
                limit: 20,
                cid: 57,
                sid: 0,
                priceOrder: '', 
                news: 0,
            }
        }),
        axios({
            url: 'https://store.crmeb.net/api/pc/get_company_info',
        })
    ]).then(axios.spread((res1, res2) => {
        console.log(res1);
        console.log(res2);
    }))
    </script>

    但在使用vue组件化开发的时候一般我们会通过npm安装,引入项目!

    组件化开发中使用

    1. 使用npm进行安装
    npm install axios --save

    一般在实际项目中我们并不会像上边这样直接去使用axios请求数据,而是将axios封装在一个单独的文件,这样做的目的主要是用来抽取公共逻辑到一个配置文件里,对这些公共逻辑做一个封装,即使某一天这个axios框架不维护了,或者出现了重大bug也不再修复的时候,我们可以只修改配置文件即可达到全局修改的目的,如果把每次请求逻辑都写到对应的组件中,那修改起来简直就是一个噩梦!

    1. 封装一个axios的请求文件request.js

    在项目的src目录下创建一个network文件夹,再在其中创建一个request.js文件,路径为:src/network/request.js

    // src/network/request.js
    
    // 引入axios
    import axios from 'axios'
    
    // 这里未使用default导出,是为了以后的扩展,便于导出多个方法
    export function request(config){
        // 创建axios实例
        const instance = axios.create({
            // 这里定义每次请求的公共数据,例如全局请求头,api根地址,过期时间等
            // 具体参数可参考axios的官方文档
            baseURL: 'http://demo26.crmeb.net/api',
            timeout: 5000
        })
        
        // 拦截请求,如果获取某个请求需要携带一些额外数据
        instance.interceptors.request.use(
            config => {
                console.log(config);
                return config;
            }, err => {
                console.log(err);
            })
            
        // 拦截响应
        instance.interceptors.response.use(
            res => {
                console.log(res)
                return res.data
            }, err => {
                console.log(err)
            }
        )
        
        // 发送请求
        return instance(config)  
    1. 使用我们封装的request请求

    一般我们会将所有的请求放在一个api.js文件中,将每次请求封装为一个方法,比如我这里会在request.js的同目录创建一个api.js文件封装我们所有的请求。

    import { request } from '../api/request'
    
    // 获取分类
    export const getHomeCategory = () => {
        return request({
            url: '/category'
        })
    }
    
    // 获取banner图
    export const getHomeBanner = () => {
        return request({
            url: '/pc/get_banner'
        })
    }

    之后再在组件中引入调用导出的相关接口方法即可,如:

    import { getHomeBanner } from "../network/api"
    
    getHomeBanner().then(res => {
    	console.log(res)
    })

    以上就是一个简单的封装,其中有个拦截请求和拦截响应,可能很多初学的人理解起来有点吃力,我在这里以个人浅见阐述,希望能带给你些许启发!

    何为拦截器?

    还是发挥阅读理解能力,拦截拦截其实就是此路是我开,此树是我栽,要想过此路,留下买路钱,拦截请求就是比如某些请求需要携带一些额外的信息才能访问,实际项目中最常见的就是需要登录后才能查看的信息,请求中就必须携带token才能访问,就可以在这里处理,还有拦截响应,比如请求到数据之后,发现不符合要求,先拦下来处理一下,再返回给前端,这就是一个拦截器的基本工作流程!

  • axios有一个全局拦截的方式:axios.interceptors()
  • 拦截成功后必须return返回,否则数据无法请求到
  • 如下所示:

      // 拦截请求,如果获取某个请求需要携带一些额外数据
        instance.interceptors.request.use(
            config => {
                console.log(config);
                return config;
            }, err => {
                console.log(err);
            })
            
        // 拦截响应
        instance.interceptors.response.use(
            res => {
                console.log(res)
                return res.data
            }, err => {
                console.log(err)
            }
        )

    axios还为我们提供了一些全局配置,如下:

    axios.defaults.baseURL = 'https://api.example.com';
    axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
    axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

    当然也可以将其配置在我们之前创建的axios实例中,使其只作用于某个实例!

    然后来看一下 axios 的所有配置信息:

    数据来自axios中文文档

    {
       // `url` 是用于请求的服务器 URL
      url: '/user',
    
      // `method` 是创建请求时使用的方法
      method: 'get', // default
    
      // `baseURL` 将自动加在 `url` 前面,除非 `url` 是一个绝对 URL。
      // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
      baseURL: 'https://some-domain.com/api/',
    
      // `transformRequest` 允许在向服务器发送前,修改请求数据
      // 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
      // 后面数组中的函数必须返回一个字符串,或 ArrayBuffer,或 Stream
      transformRequest: [function (data, headers) {
        // 对 data 进行任意转换处理
        return data;
      }],
    
      // `transformResponse` 在传递给 then/catch 前,允许修改响应数据
      transformResponse: [function (data) {
        // 对 data 进行任意转换处理
        return data;
      }],
    
      // `headers` 是即将被发送的自定义请求头
      headers: {'X-Requested-With': 'XMLHttpRequest'},
    
      // `params` 是即将与请求一起发送的 URL 参数
      // 必须是一个无格式对象(plain object)或 URLSearchParams 对象
      params: {
        ID: 12345
      },
    
       // `paramsSerializer` 是一个负责 `params` 序列化的函数
      // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
      paramsSerializer: function(params) {
        return Qs.stringify(params, {arrayFormat: 'brackets'})
      },
    
      // `data` 是作为请求主体被发送的数据
      // 只适用于这些请求方法 'PUT', 'POST', 和 'PATCH'
      // 在没有设置 `transformRequest` 时,必须是以下类型之一:
      // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
      // - 浏览器专属:FormData, File, Blob
      // - Node 专属: Stream
      data: {
        firstName: 'Fred'
      },
    
      // `timeout` 指定请求超时的毫秒数(0 表示无超时时间)
      // 如果请求话费了超过 `timeout` 的时间,请求将被中断
      timeout: 1000,
    
       // `withCredentials` 表示跨域请求时是否需要使用凭证
      withCredentials: false, // default
    
      // `adapter` 允许自定义处理请求,以使测试更轻松
      // 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
      adapter: function (config) {
        /* ... */
      },
    
     // `auth` 表示应该使用 HTTP 基础验证,并提供凭据
      // 这将设置一个 `Authorization` 头,覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
      auth: {
        username: 'janedoe',
        password: 's00pers3cret'
      },
    
       // `responseType` 表示服务器响应的数据类型,可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
      responseType: 'json', // default
    
      // `responseEncoding` indicates encoding to use for decoding responses
      // Note: Ignored for `responseType` of 'stream' or client-side requests
      responseEncoding: 'utf8', // default
    
       // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
      xsrfCookieName: 'XSRF-TOKEN', // default
    
      // `xsrfHeaderName` is the name of the http header that carries the xsrf token value
      xsrfHeaderName: 'X-XSRF-TOKEN', // default
    
       // `onUploadProgress` 允许为上传处理进度事件
      onUploadProgress: function (progressEvent) {
        // Do whatever you want with the native progress event
      },
    
      // `onDownloadProgress` 允许为下载处理进度事件
      onDownloadProgress: function (progressEvent) {
        // 对原生进度事件的处理
      },
    
       // `maxContentLength` 定义允许的响应内容的最大尺寸
      maxContentLength: 2000,
    
      // `validateStatus` 定义对于给定的HTTP 响应状态码是 resolve 或 reject  promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`),promise 将被 resolve; 否则,promise 将被 rejecte
      validateStatus: function (status) {
        return status >= 200 && status < 300; // default
      },
    
      // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
      // 如果设置为0,将不会 follow 任何重定向
      maxRedirects: 5, // default
    
      // `socketPath` defines a UNIX Socket to be used in node.js.
      // e.g. '/var/run/docker.sock' to send requests to the docker daemon.
      // Only either `socketPath` or `proxy` can be specified.
      // If both are specified, `socketPath` is used.
      socketPath: null, // default
    
      // `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项:
      // `keepAlive` 默认没有启用
      httpAgent: new http.Agent({ keepAlive: true }),
      httpsAgent: new https.Agent({ keepAlive: true }),
    
      // 'proxy' 定义代理服务器的主机名称和端口
      // `auth` 表示 HTTP 基础验证应当用于连接代理,并提供凭据
      // 这将会设置一个 `Proxy-Authorization` 头,覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
      proxy: {
        host: '127.0.0.1',
        port: 9000,
        auth: {
          username: 'mikeymike',
          password: 'rapunz3l'
        }
      },
    
      // `cancelToken` 指定用于取消请求的 cancel token
      // (查看后面的 Cancellation 这节了解更多)
      cancelToken: new CancelToken(function (cancel) {
      })
    }

    相关推荐

    一键生成高颜值图表!让你的文字瞬间有画面感,职场人必备!

    哈喽,打工人们!忙碌的周中,大熊又来给你们带来一个超实用的效率神器啦!这次的宝藏网站绝对是那种用过就离不开的"真香"型产品!假设你明天就要做重要汇报,可面对一大堆密密麻麻的文字材料,你...

    批量将 Word 转换为 PDF/Excel/Txt/图片等多种格式

    Word文档是我们工作中经常会打交道的一种文档格式,我们也经常会有需要对Word文档进行格式转换的需求,比如将Word格式转换为PDF、将Word文档转换为Excel、将Word...

    绝了!一键用AI生成高颜值动态PPT(附详细步骤+Prompt)

    大家好,我是一名酷爱研究AI的产品经理,最近我有个新发现:那些花了你3天做出来的PPT,现在用AI可以1小时搞定!而且颜值还高!为什么AI做PPT比传统方式效率高10倍?我用一张图就能告诉你:AI生成...

    ztext - 简单几行代码创建酷炫3D特效文字的开源JS库

    把网页上的文字变成酷炫的3D风格,还能制作旋转动效,有了ztext.js,只需要几行代码。ztext能做什么ztext.js是一个能把常规的平面文字变成3D样式的前端开源代码库,让开发者...

    文字内插入小图片,也太可爱了吧(文字中怎么插图片)

    图文排版H5手机版秀米有小伙伴留言问添加图片的时候可不可以把图片添加到文字之间比如下面这句话中的小贴纸图片后面可以接着输入文字其实吧这就是咱们的『文字内插入小图片』功能嘛可以用来在文字内加个表情包又...

    Linux环境下C++代码性能分析方法(linux怎么写c++代码)

    技术背景在开发C++应用程序时,找出代码中运行缓慢的部分是进行性能优化的关键。在Linux系统上,有多种工具和方法可用于对C++代码进行性能分析,每种方法都有其特点和适用场景。实现步骤手动中断调试法在...

    SVG互动图文,让你的文章更有趣!教你4种简单易学的黑科技玩法!

    如果你是一个公众号创作者,那么你一定想知道如何让你的文章更加吸引人,更加有趣,更加有创意。你可能已经尝试过各种图文排版技巧,但是你是否知道,有一种黑科技可以让你的文章变得更加酷炫,更加互动,更加爆款?...

    Videoscribe怎么实现实心中文汉字的手绘制作

    很多朋友在制作手绘视频的时候,不知道怎么输入实心的中文汉字,之前我们已经给大家分享了怎么输入汉字的方法,但是有一点遗憾的是输出的汉字是空心的手绘展示,在视觉上并不是非常的美观。经过大家不断的探索,终于...

    一款用于将文本转化成图表的现代化脚本语言

    大家好,又见面了,我是GitHub精选君!今天要给大家推荐一个GitHub开源项目terrastruct/d2,该项目在GitHub有超过10.3kStar,用一句话介绍该项目就是:...

    探秘 Web 水印技术(制作水印网站)

    作者:fransli,腾讯PCG前端开发工程师Web水印技术在信息安全和版权保护等领域有着广泛的应用,对防止信息泄露或知识产品被侵犯有重要意义。水印根据可见性可分为可见水印和不可见水印(盲水印)...

    不忍心卸载的五款神仙工具(不忍心卸载的五款神仙工具是什么)

    001.效率工具uTools-装机必备的生产力工具集uTools是一款非常强大的可以装下几乎所有效率工具的电脑生产力工具集,目前拥有Windows、Mac和Linux三个版本。软件界面...

    「SVG」飞花令!这份最高检工作报告“超有料”

    原标题:【SVG】飞花令!这份最高检工作报告“超有料”栏目主编:秦红文字编辑:沈佳灵来源:作者:最高人民检察院...

    svg|2025政府工作报告,有没有你关心的数据?

    ··<setattributeName="visibility"begin="click+0s"dur="1ms"fill="freeze"restart="never"to="hi...

    videoscribe只能输入英文,如何输入中文文本?

    videoscribe只能输入英文,如何输入中文文本?打开VideoScribe软件,打开要添加中文字体的位置。打开Photoshop并在文件中创建一个新的透明背景图层。注意:必须是透明背景层。...

    五个流行的SVG在线编辑器(svg编辑工具)

    随着响应网络的发展,越来越多的高质量的SVG在线编辑器被公众所熟知。SVG矢量图形也越来越受欢迎,以便在任何设备上呈现图像,甚至一些易于使用的SVG在线编辑器,可以替代PS,本文总结了五种流行的SVG...