基于axios请求封装的vue应用

最新推荐文章于 2023-03-21 21:56:58 发布
最新推荐文章于 2023-03-21 21:56:58 发布
阅读量2.6k 收藏 78
点赞数 21
分类专栏： # Vue
浩明
本文链接：https://blog.csdn.net/YHM_MM/article/details/116356237
版权

目录

什么是axios？

Axios 是一个基于 promise 的 HTTP 库，可以用在浏览器和 node.js 中。

特性：

从浏览器中创建 XMLHttpRequests
从 node.js 创建 http 请求
支持 Promise API
拦截请求和响应
转换请求数据和响应数据
取消请求
自动转换 JSON 数据
客户端支持防御 XSRF

Promises

axios 依赖原生的 ES6 Promise 实现而被支持. 如果你的环境不支持 ES6 Promise，你可以使用 polyfill.

axios的请求类型？

安装好node的一套环境：

一下三种引用方式:
npm install axios -先在node中安装axios，api封装中引入axios即可
bower install axios --npm中安装 bower，在bower中引入axios包

bower：
Bower可以管理包含HTML，CSS，JavaScript，字体甚至图像文件的组件。Bower不会串联或缩小代码或执行其他任何操作-只会安装所需的正确版本的软件包及其依赖项。
直接vue中引入js文件
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

axios封装默认的自定义配置
const instance = axios.create({
{
   // `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) {
  })
}
}).then(function(response){
// `data` 由服务器提供的响应
  data: {},

  // `status` 来自服务器响应的 HTTP 状态码
  status: 200,

  // `statusText` 来自服务器响应的 HTTP 状态信息
  statusText: 'OK',

  // `headers` 服务器响应的头
  headers: {},

   // `config` 是为请求提供的配置信息
  config: {},
 // 'request'
  // `request` is the request that generated this response
  // It is the last ClientRequest instance in node.js (in redirects)
  // and an XMLHttpRequest instance the browser
  request: {}
});
配置的加载优先级

高到低顺序：

第一步：配置默认值
在请求中设置的配置项

instance.get('/longRequest', {
 timeout: 5000
});

第二部：全局的 axios 默认值
在api文件中设置的配置项

instance.defaults.timeout = 2500;

第三步：自定义实例默认值
在创建axios实例中设置的配置项

var instance = axios.create();
拦截器
// 添加请求拦截器
axios.interceptors.request.use(function (config) {
    // 在发送请求之前做些什么
    return config;
  }, function (error) {
    // 对请求错误做些什么
    return Promise.reject(error);
  });

// 添加响应拦截器
axios.interceptors.response.use(function (response) {
    // 对响应数据做点什么
    return response;
  }, function (error) {
    switch (err.response.status) {
      case 400:
        err.message = '错误请求';
        break;
      case 401:
        err.message = '未授权，请重新登录';
        break;
      case 403:
        err.message = '拒绝访问';
        break;
      case 404:
        err.message = '请求错误,未找到该资源';
        break;
      case 405:
        err.message = '请求方法未允许';
        break;
      case 408:
        err.message = '请求超时';
        break;
       case 415:
        err.message = '服务器无法处理请求附带的媒体格式';
        break;
      case 500:
        err.message = '服务器出错';
        break;
      case 501:
        err.message = '网络未实现';
        break;
      case 502:
        err.message = '网络错误';
        break;
      case 503:
        err.message = '服务不可用';
        break;
      case 504:
        err.message = '网络超时';
        break;
      case 505:
        err.message = 'http版本不支持该请求';
        break;
      default:
        err.message = `连接错误${err.response.status}`;
    }
  } else {
    err.message = '连接到服务器失败';
  }
  return Promise.resolve(err.response);
  });

import Vue from ‘vue’;
import axios from ‘axios’;

get请求
axios.get({
	method:'get',
	url:'xxxx',
	reponseType:'',//相应类型
	parems:{//入参
	}
}).then(function(response){
	....
})
post请求
axios({
  method: 'post',
  url: '/user/12345',
  data: {
    firstName: 'Fred',
    lastName: 'Flintstone'
  }
}).then(function(res){

});
delete请求
axios({
  method: 'delete',
  url: '/user/12345',
 //入参一：挂载到请求后面
 parmes：{
 }
 //入参二：挂载到请求体内
 data{
}
}).then(function(res){

});
put请求：更新整个对象资源
axios({
  method: 'put',
  url: '/user/12345',
 data{
}
}).then(function(res){

});
patch请求：更新对象的局部资源
axios({
  method: 'patch',
  url: '/user/12345',
 data{
}
}).then(function(res){

});

提供封装后的另一种写法：
axios.get(url[, config])
axios.delete(url[, config])
axios.post(url[, data[, config]])
axios.put(url[, data[, config]])
axios.patch(url[, data[, config]])

并发请求

axios.all(iterable)
axios.spread(callback)
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) {//对应请求的响应体
    // 两个请求现在都执行完成
  }));

axios与ajax的区别？

axios：
从 node.js 创建 http 请求
支持 Promise API
客户端支持防止CSRF
提供了一些并发请求的接口（重要，方便了很多的操作）
ajax：
3.JQuery整个项目太大，单纯使用ajax却要引入整个JQuery非常的不合理（采取个性化打包的方案又不能享受CDN服务）

axios怎样自定义封装？

1、建立接口请求封装、响应、拦截、认证、等基础配置文件 index.js

引入静态资源
import axios from 'axios';
 import qs from 'qs';
import apiMap from './apiMap';

设置全局默认参数
axios.defaults.withCredentials = false;
axios.defaults.headers.post['Content-Type'] = 'application/json;charset=UTF-8';

设置请求默认参数
const instance = axios.create({
    baseURL: process.env.API_ROOT,
    timeout: 15 * 1000,
    auth: {
    	...
    },
    headers: {
      'Content-Type': 'application/json;charset=utf-8',
      'X-Requested-With': 'XMLHttpRequest',
    },
  },
);
设置请求拦截：
instance.interceptors.request.use(function (config) {
...
})
设置相应拦截：
// 响应拦截器即异常处理
instance.interceptors.response.use(response =>
   response
, (err) => {
  if (err && err.response) {
    switch (err.response.status) {
      case 400:
        err.message = '错误请求';
        break;
      case 401:
        err.message = '未授权，请重新登录';
        break;
      case 403:
        err.message = '拒绝访问';
        break;
      case 404:
        err.message = '请求错误,未找到该资源';
        break;
      case 405:
        err.message = '请求方法未允许';
        break;
      case 408:
        err.message = '请求超时';
        break;
       case 415:
        err.message = '服务器无法处理请求附带的媒体格式';
        break;
      case 500:
        err.message = '服务器出错';
        break;
      case 501:
        err.message = '网络未实现';
        break;
      case 502:
        err.message = '网络错误';
        break;
      case 503:
        err.message = '服务不可用';
        break;
      case 504:
        err.message = '网络超时';
        break;
      case 505:
        err.message = 'http版本不支持该请求';
        break;
      default:
        err.message = `连接错误${err.response.status}`;
    }
  } else {
    err.message = '连接到服务器失败';
  }
  return Promise.resolve(err.response);
});
封装接口请求：
const  api={
	/**
	
	* get 方法封装
	
	* @param url
	
	* @param params
	
	* @returns {Promise}
	
	*/
	
	get (url, params = {}) {
	  return new Promise((resolve, reject) => {
		  instance.get(apiMap[url],params).then(res => {
	      resolve(res.data)
	    }).catch(err => {
	      reject(err)
	    })
	  })
	},
	
	/**
	
	* post
	
	* @param url
	
	* @param params
	
	* @returns {Promise}
	
	*/
	
	post (url, params = {}) {
	  return new Promise((resolve, reject) => {
	    instance.post(apiMap[url], params)
	      .then(res => {
	        resolve(res.data)
	      }, err => {
	        reject(err)
	      })
	  })
	},
	
	/**
	
	* delete 方法封装
	
	* @param url
	
	* @param params
	
	* @returns {Promise}
	
	*/
	
	delete (url, params = {}) {
	  return new Promise((resolve, reject) => {
	    instance.delete(apiMap[url] ,params).then(res => {
	      resolve(res.data)
	    }).catch(err => {
	      reject(err)
	    })
	  })
	},
	
	/**
	
	* put 方法封装
	
	* @param url
	
	* @param params
	
	* @returns {Promise}
	
	*/
	
	put (url, params = {}) {
	  return new Promise((resolve, reject) => {
	    instance.put(apiMap[url], params).then(res => {
	      resolve(res.data)
	    }).catch(err => {
	      reject(err)
	    })
	  })
	},
	
	/**
	
	* patch 方法封装
	
	* @param url
	
	* @param params
	
	* @returns {Promise}
	
	*/
	
	patch (url, params = {}) {
	  return new Promise((resolve, reject) => {
	    instance.patch(apiMap[url], params).then(res => {
	      resolve(res.data)
	    }).catch(err => {
	      reject(err)
	    })
	  })
	}
}

export default api;

2、创建一个key-vlue形式的接口文件，方便接口请求管理 apiMap.js

export default {
  // 主题列表
  key: 'path'
};

3、将index文件引入vue入口文件中

引入vue资源
import Vue from 'vue'
引入viewui插件
import ViewUI from 'view-design';
引入viewuicss文件
import 'view-design/dist/styles/iview.css';
导入文件|默认不需要加文件后缀
import Api from '/index';
全局绑定|$ 为实例属性设置作用域
Vue.prototype.$api = Api;

4、具体调用：

	this.$api.get('接口key',参数).then(data=>{
	   //业务处理
	}).catch(reason=>{
        console.log(reason.message);
        console.log(reason.stack);
      });

全局参数配置：

创建配置文件index.js：
import Vue from 'vue';
import Vuex from 'vuex';
import State from './state';
Vue.use(Vuex);
const store = new Vuex.Store(State);
export default store;
创建全局参数详细文件state.js
export default {
	state: {   //这里放全局参数
		test: 0
	},
	mutations:{   //设置值
		test(state,value)=>state.test=value;
	},
	getters:{//返回值
		test: state =>state.test;
	}
};
调用方式：
var data = this.$store.getter.test;
var data = this.$store.commit('test',数据);

Vue.use(Vuex);
判断vue是否已经注册过vuex插件；
将vuexInit函数混入到vue的beforeCreate生命周期中;
实例化vue时，会在vue每个实例上添加 s t o r e 属 性 ， 并 将 v u e x 的 实 例 绑 定 到 store属性，并将vuex的实例绑定到 store属性，并将vuex的实例绑定到store属性上。

vue3【使用axios并封装axios请求】
蜗牛~~
05-12 2969
由于 Vue3中，在setup中无法通过this获取组件实例，console.log(this)打印出来的值是undefined。1、我们可以通过window.location.protocol和window.location.host获取协议和主机ip端口，然后统一设置axios的默认请求baseURL。来绑定的，例如 Vue.prototype.$toast = Toast。proxy是getCurrentInstance()对象中的一个属性，然后通过对象的解构赋值方式拿到proxy。
vue.cli项目封装全局axios，封装请求，封装公共的api和调用请求的全过程
热门推荐
JCat的博客
09-03 10万+
vue项目的前期配置 封装axios实例 封装API
Vue项目 封装 axios请求 （直接复制可用）
HelloWord176的博客
07-11 284
首先先在你的项目中安装 axios $ npm install axios 安装完成之后可以在 package.json 文件中看到 然后在项目 src 文件夹下创建一个文件来进行请求的封装 然后 request 文件是对 axios 的处理 ，里面包含 请求头的配置 已经请求拦截和响应拦截相关的一些配置，api 文件夹主要就是 对接口的封装。项目中用到的接口 都可以写道这里面 1. 先看 request 文件 代码如下：(当然这写注释可以删掉) // 这是一个封装请求接口的文件 import ax
一个比较全面的基于axios的封装
Crazymryan的博客
03-28 545
❝以下文章来自于“前端咖”公众号❞在几个公司工作过，我发现我很少看到考虑的比较全面的ajax封装。可能是因为我待过的公司不够优秀吧，也可能是因为我所在的团队不够优秀吧。基于这样的一个情况...
Vue中基于axios的 请求通用模块封装 基本思路
m0_59128154的博客
09-11 273
// 通用接口调用文件 import request from 'axios' // 引入 vuex import store from '@/store' // 引入 vue-router import router from '@/router' // 定义基地址 export const baseURL = '' // 创建一个独立的实例对象 const axios = request.create({ baseURL: baseURL }) // 请求拦截器 axios.intercept
axios.interceptors.request.use简介
最新发布
码字不易，大家的支持就是我坚持下去的动力
03-21 4259
是一个拦截器，它可以在发送请求之前对请求进行拦截并进行一些处理。它的参数是一个函数，该函数接受一个config对象作为参数，其中包含了请求的各种配置信息。以下是configurl: 请求的 URL 地址。method: 请求的 HTTP 方法，如 GET、POST 等。headers: 请求头信息，可以设置一些自定义的头部信息，如认证信息等。params: GET 请求中的查询参数，会被拼接在 URL 后面，如foo=bar。data。
axios拦截器： axios.interceptors.request.use，axios.interceptors.response.use
Allen的博客
12-01 4178
axios拦截器： axios.interceptors.request.use，axios.interceptors.response.use
vue+ts下对axios的封装实现
10-15
在Vue.js和TypeScript的开发环境中，我们常常需要对第三方库如axios进行封装，以便更好地管理和定制网络请求。本文将详细介绍如何在Vue+TS项目中对axios进行封装，包括设置拦截器来处理请求和响应。 首先，确保你...
vue axios封装 axios 请求
03-27
vue axios封装 axios 请求
vue+axios 请求封装
小妹的博客
01-13 179
import axios from 'axios' import router from '../router/index' import { Message } from 'element-ui' import {   showFullScreenL...
axios[interceptors]网络请求之拦截器的实现-解读
JackieDYH的博客
04-25 1933
我们在使用 Axios 的过程中，或多或少地要用到它的拦截器，可是axios 的拦截器怎么使用，内部又是怎么实现的？ 我们在使用 Axios 的过程中，或多或少地要用到它的拦截器，例如要实现： 数据转换； 添加额外的数据； 输出或上报接口的请求时间、失败率等数据； 这些需求，使用拦截器就能非常容易地实现。那么 axios 的拦截器怎么使用，内部又是怎么实现的，这篇文章让我们一探究竟。 1. 拦截器的使用 在 axios 中，拦截器分为请求拦截器和响应拦截器。顾名思义
axios拦截器之axios.interceptors.request.use和axios.interceptors.response.use（附示例代码）
阿小绿的博客
08-08 7万+
1.请求拦截器（在请求之前进行一些配置） axios.interceptors.request.use(function(config){ //比如是否需要设置 token config.headers.token='wwwwwsdsdf' return config }) 2.响应了拦截器（在响应之后对数据进行一些处理） axios.interceptors.response.use(res=>{ let data=res.data //比如响应一些报错信息 return data }
axios拦截器之axios.interceptors.request.use和axios.interceptors.response.use
C++ 爱好者 make_it_simple888
11-18 3780
https://blog.csdn.net/qq_42899245/article/details/107876734 axios.interceptors.request.use(function(config){ //比如是否需要设置 token config.headers.token='wwwwwsdsdf' return config }) axios.interceptors.response.use(res=>{ let data=res.data //比如响应一些报
vue+axios请求封装
qj11803017的博客
09-18 102
1.在request.ts封装 import axios from 'axios' import config from './config' import {Dialog, Toast} from 'vant' import qs from 'qs' const Axios = axios.create({ timeout: 1000 * 6}); // 请求拦截器，内部根据返回值，重新组装，统一管理。 Axios.interceptors.request.use( config =>
axios中的拦截器的使用
垂钓老翁的博客
09-27 921
1、请求拦截器 // use(两个参数) axios.interceptors.request.use(req => { // 在发送请求前要做的事儿 ... return req }, err => { // 在请求错误时要做的事儿 ... // 该返回的数据则是axios.catch(err)中接收的数据 return Promise.reject(err) }) 2、响应拦截器 // use(两个参数) axios.intercep
06-axios拦截器的使用
weixin_51295096的博客
09-03 170
官方解释: 在请求或响应被 then 或 catch 处理前拦截它们。 官方示例代码: // 添加请求拦截器 axios.interceptors.request.use(function (config) { // 在发送请求之前做些什么 return config; }, function (error) { // 对请求错误做些什么 return Promise.reject(error); }); // 添加响应拦截器 axios.interceptors.
评论 28
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

知青先生

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值