axios基本用法

╰+哭是因爲堅強的太久メ 2021-09-15 02:54 510阅读 0赞

# 一.axios #

1.什么是axios

axios 是一个基于Promise 用于浏览器和 nodejs 的 HTTP 客户端。简单的理解就是ajax的封装

它本身具有以下特征：

a.从浏览器中创建 XMLHttpRequest  
     b.从 node.js 发出 http 请求  
     c.支持 Promise API  
     e.拦截请求和响应  
     f.转换请求和响应数据  
    g.取消请求  
    h.自动转换JSON数据

i.客户端支持防止 CSRF/XSRF

2.安装

[ nodeJs + webpack+vue+ element ui 环境安装][nodeJs _ webpack_vue_ element ui]

# 二.axios  API #

(1).向 axios 传递相关配置来创建请求

1.axios(config)
    // 发送 POST 请求
    axios({
      method: 'post',
      url: '/user/12345',
      data: {
        firstName: 'Fred',
        lastName: 'Flintstone'
      }
    });
    
    2.axios(url[, config])
    // 发送 GET 请求（默认的方法）
    axios('/user/12345');

(2).axios提供了一下几种请求方式

1.axios.get(url[, config])  执行 GET 请求
    	eg:
    
    	// 向具有指定ID的用户发出请求
    	axios.get('/user?ID=12345')
    	  .then(function (response) {
    		console.log(response);
    	  })
    	  .catch(function (error) {
    		console.log(error);
    	  });
    	  
    	// 也可以通过 params 对象传递参数
    	axios.get('/user', {
    		params: {
    		  ID: 12345
    		}
    	  })
    	  .then(function (response) {
    		console.log(response);
    	  })
    	  .catch(function (error) {
    		console.log(error);
    	  });
    
    2.axios.post(url[, data[, config]]) 执行 POST 请求
    	eg:
    	axios.post('/user', {
    		firstName: 'Fred',
    		lastName: 'Flintstone'
    	  })
    	  .then(function (response) {
    		console.log(response);
    	  })
    	  .catch(function (error) {
    		console.log(error);
    	  });
    3.axios.request(config)
    
    4.axios.head(url[, config])
    
    5.axios.delete(url[, config])
    
    6.axios.put(url[, data[, config]])
    
    7.axios.patch(url[, data[, config]])
    
    8.axios.all(iterable)执行多个并发请求
    
        eg:
    		function getUserAccount() {
    		  return axios.get('/user/12345');
    		}
    
    		function getUserPermissions() {
    		  return axios.get('/user/12345/permissions');
    		}
    
    		axios.all([getUserAccount(), getUserPermissions()])
    		  .then(axios.spread(function (acct, perms) {
    			// 两个请求现在都执行完成
    		  }));
    9.axios.spread(callback)
    
    
    注意：处理并发请求的助手函数axios.all(iterable)      axios.spread(callback)

(3).请求配置

这些是创建请求时可以用的配置选项。只有 url 是必需的。如果没有指定 method，请求将默认使用 get 方法。

//config
    
    {
      // `url` 是用于请求的服务器 URL
      url: '/user',
    
      // `method` 是创建请求时使用的方法
      method: 'get', // 默认是 get
    
      // `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
      // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
      baseURL: 'https://some-domain.com/api/',
    
      // `transformRequest` 允许在向服务器发送前，修改请求数据
      // 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
      // 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream
      transformRequest: [function (data) {
        // 对 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, // 默认的
    
      // `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', // 默认的
    
      // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
      xsrfCookieName: 'XSRF-TOKEN', // default
    
      // `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称
      xsrfHeaderName: 'X-XSRF-TOKEN', // 默认的
    
      // `onUploadProgress` 允许为上传处理进度事件
      onUploadProgress: function (progressEvent) {
        // 对原生进度事件的处理
      },
    
      // `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; // 默认的
      },
    
      // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
      // 如果设置为0，将不会 follow 任何重定向
      maxRedirects: 5, // 默认的
    
      // `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) {
      })
    }

(4).响应结构

某个请求的响应包含以下信息

{
      // `data` 由服务器提供的响应
      data: {},
    
      // `status` 来自服务器响应的 HTTP 状态码
      status: 200,
    
      // `statusText` 来自服务器响应的 HTTP 状态信息
      statusText: 'OK',
    
      // `headers` 服务器响应的头
      headers: {},
    
      // `config` 是为请求提供的配置信息
      config: {}
    }

使用 then 时，你将接收下面这样的响应：
    
    axios.get('/user/12345')
      .then(function(response) {
        console.log(response.data);
        console.log(response.status);
        console.log(response.statusText);
        console.log(response.headers);
        console.log(response.config);
      });

(5).配置的默认值/defaults

你可以指定将被用在各个请求的配置默认值

1.全局的 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';
    
    2.自定义实例默认值
    // 创建实例时设置配置的默认值
    var instance = axios.create({
      baseURL: 'https://api.example.com'
    });
    
    // 在实例已创建后修改默认值
    instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;
    
    3.配置的优先顺序
    配置会以一个优先顺序进行合并。这个顺序是：在 lib/defaults.js 找到的库的默认值，然后是实例的 defaults 属性，最后是请求的 config 参数。后者将优先于前者。
    这里是一个例子：
    
    // 使用由库提供的配置的默认值来创建实例
    // 此时超时配置的默认值是 `0`
    var instance = axios.create();
    
    // 覆写库的超时默认值
    // 现在，在超时前，所有请求都会等待 2.5 秒
    instance.defaults.timeout = 2500;
    
    // 为已知需要花费很长时间的请求覆写超时设置
    instance.get('/longRequest', {
      timeout: 5000
    });

(6).拦截器

在请求或响应被 then 或 catch 处理前拦截它们。

// 添加请求拦截器
    axios.interceptors.request.use(function (config) {
        // 在发送请求之前做些什么
        return config;
      }, function (error) {
        // 对请求错误做些什么
        return Promise.reject(error);
      });
    
    // 添加响应拦截器
    axios.interceptors.response.use(function (response) {
        // 对响应数据做点什么
        return response;
      }, function (error) {
        // 对响应错误做点什么
        return Promise.reject(error);
      });

1.如果你想在稍后移除拦截器，可以这样：
    var myInterceptor = axios.interceptors.request.use(function () {/*...*/});
    axios.interceptors.request.eject(myInterceptor);
    2.可以为自定义 axios 实例添加拦截器
    var instance = axios.create();
    instance.interceptors.request.use(function () {/*...*/});

(7).错误处理

axios.get('/user/12345')
      .catch(function (error) {
        if (error.response) {
          // 请求已发出，但服务器响应的状态码不在 2xx 范围内
          console.log(error.response.data);
          console.log(error.response.status);
          console.log(error.response.headers);
        } else {
          // Something happened in setting up the request that triggered an Error
          console.log('Error', error.message);
        }
        console.log(error.config);
      });

可以使用 validateStatus 配置选项定义一个自定义 HTTP 状态码的错误范围。
    axios.get('/user/12345', {
      validateStatus: function (status) {
        return status < 500; // 状态码在大于或等于500时才会 reject
      }
    })

[请查看官网][Link 1]

# 三.注意细节 #

1. 引用 axios 时

Vue.prototype.axios = axios  Vue.prototype.$axios = axios    Vue.prototype.$http = axios  其实是都一个东西，只是vue的原型链上加个变量（且变量不同），值是axios对象 。

只是 一个是jquery封装过的异步调用方法    一个是vue推荐的第三方异步封装方法  他们都是调用的axios对象

只是调用的时候 axios.post(\{..\})   this.$axios.post(\{...\})     this.$http.post(\{....\})

# 四.案例 #

1.本地data.json(f放在src同级)

{
    	"seller": {
    		"name": "粥品香坊（回龙观）",
    		"description": "蜂鸟专送",
    		"deliveryTime": 38,
    		"score": 4.2,
    		"serviceScore": 4.1,
    		"foodScore": 4.3,
    		"rankRate": 69.2,
    		"minPrice": 20,
    		"deliveryPrice": 4,
    		"ratingCount": 24,
    		"sellCount": 90,
    		"bulletin": "粥品香坊其烹饪粥料的秘方源于中国千年古法，在融和现代制作工艺，由世界烹饪大师屈浩先生领衔研发。坚守纯天然、0添加的良心品质深得消费者青睐，发展至今成为粥类的引领品牌。是2008年奥运会和2013年园博会指定餐饮服务商。",
    		"supports": [{
    			"type": 0,
    			"description": "在线支付满28减5"
    		}, {
    			"type": 1,
    			"description": "VC无限橙果汁全场8折"
    		}, {
    			"type": 2,
    			"description": "单人精彩套餐"
    		}, {
    			"type": 3,
    			"description": "该商家支持发票,请下单写好发票抬头"
    		}, {
    			"type": 4,
    			"description": "已加入“外卖保”计划,食品安全保障"
    		}],
    		"avatar": "http://static.galileo.xiaojukeji.com/static/tms/seller_avatar_256px.jpg",
    		"pics": ["http://fuss10.elemecdn.com/8/71/c5cf5715740998d5040dda6e66abfjpeg.jpeg?imageView2/1/w/180/h/180", "http://fuss10.elemecdn.com/b/6c/75bd250e5ba69868f3b1178afbda3jpeg.jpeg?imageView2/1/w/180/h/180", "http://fuss10.elemecdn.com/f/96/3d608c5811bc2d902fc9ab9a5baa7jpeg.jpeg?imageView2/1/w/180/h/180", "http://fuss10.elemecdn.com/6/ad/779f8620ff49f701cd4c58f6448b6jpeg.jpeg?imageView2/1/w/180/h/180"],
    		"infos": ["该商家支持发票,请下单写好发票抬头", "品类:其他菜系,包子粥店", "北京市昌平区回龙观西大街龙观置业大厦底商B座102单元1340", "营业时间:10:00-20:30"]
    	}
    }

2.修改webpack-dev-conf.js

[最新的vue没有dev-server.js文件，如何进行后台数据模拟？][vue_dev-server.js]

//第一步
    const express = require('express')
    const app = express()//请求server
    var appData = require('../data.json')//加载本地数据文件
    var seller = appData.seller //获取对应的本地数据
    var goods = appData.goods
    var ratings = appData.ratings
    var apiRoutes = express.Router()
    app.use('/api', apiRoutes)//通过路由请求数据
    
    //第二步
    before(app) {  
    	app.get('/api/seller', (req, res) => {  
    		res.json({  
    			// 这里是你的json内容  
    			errno: 0,  
    			data: seller  
    		})  
    	}),
    	app.post('/api/seller', (req, res) => {  
    		res.json({  
    			// 这里是你的json内容  
    			errno: 0,  
    			data: seller  
    		})  
    	})
    }

3.axios.vue

<template>
    	<div>
    		<h1>axios基础介绍</h1>
    		<button @click="get">get请求</button>
    		<button @click="post">post请求</button>
    		<button @click="http">aixos</button>
    		<p>{
       {msg}}</p>
    	</div>
    </template>
    
    <script>
    import axios from 'axios'
    export default {
    	data () {
    		return {
    			msg:'',
    		}
    	},
    	created(){
    		//全局拦截器
    		axios.interceptors.request.use(function (config) {  
    		    // 在发送请求之前做些什么  
    		    console.log('config')
    		    console.log(config)
    		    return config;  
    		}, function (error) {  
    		    // 对请求错误做些什么  
    		    return Promise.reject(error);  
    		}); 
    	},
    	methods: {
    		get(){
    			//1.简单的获取
    			// axios.get("/api/seller").then(res =>{
    			// 	this.msg = res;
    			// })
    			//2.传参数
    			axios.get("/api/seller",{
    				//传参数
    				params:{userid:"999"},
    				//请求头部
    				headers:{
    					token:"jack"
    				}
    			}).then(res =>{
    				this.msg = res;
    			}).catch(function(error){
    				//获取错误
    				console.log("error:"+error)
    			})
    		},
    		post(){
    			axios.post("/api/seller",{
    				//传参数
    					userid:"888"
    				},{
    					headers:{//请求头部
    					token:"tom"
    				}
    			}).then(res =>{
    				this.msg = res;
    			}).catch(function(error){
    				//获取错误
    				console.log("error:"+error)
    			})
    		},
    		http(){
    			//注意：get  传参是params   post传参是data
    			axios({
    				url:"/api/seller",
    				methods:"get",
    				params:{
    					userid:"101"
    				},
    				headers:{
    					token:"http-test"
    				}
    			}).then(res =>{
    				this.msg = res;
    			})
    		}
    
    	}
    }
    </script>
    
    <style  lang="scss">
    </style>

![20180608160128990][]

[nodeJs _ webpack_vue_ element ui]: https://blog.csdn.net/gao_xu_520/article/details/79650540
[Link 1]: https://www.kancloud.cn/yunye/axios/234845
[vue_dev-server.js]: https://blog.csdn.net/gao_xu_520/article/details/80271457
[20180608160128990]: /images/20210813/7181df09feff4db6a49ff4956ae2e1f8.png