vue项目详解（2）- axios封装及使用

axios

axios 简介

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

axios 安装

$ npm install axios

或者使用cdn

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

vue项目axios封装

创建文件夹并引用

• 创建axios.js文件夹
• 在 main.js 中引入。注册到原型上。
  • import https from “./axios/axios.js”; //引入封装的axios
  • Vue.prototype.https = https; //引入到原型上。
• 使用 this.https.post（） 因为是绑定在vue的原型上，所以用this就可以直接使用。

axios 的封装

在axios.js中引入axios

		import axios from 'axios'; // 引入axios
		import QS from 'qs'; // 引入qs模块，用来序列化post类型的数据，后面会提到
		// vant的Message提示框组件，大家可根据自己的ui组件更改。
		import { Message } from 'element-ui';
		import router from "../router"; //引入，为了跳转登录页。

请求超时设置

通过axios.defaults.timeout设置默认的请求超时时间。例如超过了10s，就会告知用户当前请求超时，请刷新等。

axios.defaults.timeout = 10000

请求拦截器

我们在发送请求前可以进行一个请求的拦截，那么我们拦截请求是用来做什么的呢？比如，有些请求是需要用户登录之后才能访问的，
或者post请求的时候，我们需要序列化我们提交的数据。这时候，我们可以在请求被发送之前进行一个拦截，从而进行我们想要的操作。

		axios.interceptors.request.use(
		    config => {

		        // 每次发送请求之前判断localStorage中是否存在登录的用户信息
		        // 如果存在，则统一在http请求的header都加上用户信息，这样后台根据用户信息判断你的登录情况
		        // 即使本地存在token，也有可能token是过期的，所以在响应拦截器中要对返回状态进行判断
		        if (localStorage.getItem('Authorization')) {
		            config.headers.Authorization = localStorage.getItem('Authorization');
		        }
		        return config;
		    },
		    error => {
		        return Promise.error(error);
		    }
		);

响应拦截器

根据请求响应的数据及返回状态码，进行最基本的判断；

axios.interceptors.response.use(
response => {
// 如果返回的状态码为200，说明接口请求成功，可以正常拿到数据
// 否则的话抛出错误
if (response.status === 200) {
// if (response.data.statusCode == ‘10001’) {
// // 失败时 跳转登录页
// router.push({
// path: “/login”
// });
// }
return Promise.resolve(response);
} else {
return Promise.reject(response);
}
},
// 服务器状态码不是2开头的的情况
// 这里可以跟你们的后台开发人员协商好统一的错误状态码
// 然后根据返回的状态码进行一些操作，例如未登录提示，错误提示等等
error => {
// 1.判断请求超时
// if (error.code === ‘ECONNABORTED’ && error.message.indexOf(‘timeout’) !== -1) {
// console.log(‘根据你设置的timeout/真的请求超时 判断请求现在超时了，你可以在这里加入超时的处理方案’)
// return service.request(originalRequest);//例如再重复请求一次
// }

    if (error.response.status) {
        switch (error.response.status) {
            // 401: 未登录
            // 未登录则跳转登录页面，并携带当前页面的路径
            // 在登录成功后返回当前页面，这一步需要在登录页操作。
            case 401:
                router.replace({
                    path: '/login',
                    query: {
                        redirect: router.currentRoute.fullPath
                    }
                });
                break;

                // 404请求不存在
            case 404:
                Message({
                    message: '网络请求不存在',
                    duration: 1500,
                    forbidClick: true
                });
                break;
                // 其他错误，直接抛出错误提示
            default:
                Message({
                    message: error.response.data.message,
                    duration: 1500,
                    forbidClick: true
                });
        }
        return Promise.reject(error.response);
    }
}

);

get和post封装

get方法：我们通过定义一个get函数，get函数有两个参数，第一个参数表示我们要请求的url地址，第二个参数是我们要携带的请求参数。get函数返回一个promise对象，当axios其请求成功时resolve服务器返回值，请求失败时reject错误值。最后通过export抛出get函数。

post方法：原理同get基本一样，但是要注意的是，post方法必须要使用对提交从参数对象进行序列化的操作，所以这里我们通过node的qs模块来序列化我们的参数。这个很重要，如果没有序列化操作，后台是拿不到你提交的数据的。这就是文章开头我们import QS from ‘qs’;的原因。

		// 封装到一个对象中
		let https = {
		    get(url, params) {
		        return new Promise((resolve, reject) => {
		            axios.get(url, {
		                params: params
		            }).then(res => {
		                resolve(res.data);
		            }).catch(err => {
		                reject(err.data)
		            })
		        })
		    },
		    post(url, params, json) {
		        let headers = {},
		            data;
		        headers['Content-type'] = json ? 'application/json;charset=UTF-8' : 'application/x-www-form-urlencoded;charset=UTF-8';
		        data = json ? params : QS.stringify(params);
		        return new Promise((resolve, reject) => {
		            axios.post(url, data, { headers: headers })
		                .then(res => {
		                    resolve(res.data);
		                })
		                .catch(err => {
		                    reject(err.data)
		                })
		        })
		    }
		}

输出https

export default https;

项目中使用

            login(){ // 验证通过  登陆
                this.https.get('/service',{
                    data:{
                        command: 'userLogin',
                        platform: 'web',
                        account: this.utils.getAES(this.userName),
                        password: this.utils.getAES(this.password),
                        confirmLogin: '0'
                    }
                }).then((res)=>{
                    if(res.statusCode == '10001'){
                        localStorage.clear(); // 清除所有的 localStorage；
                        localStorage.setItem("Authorization",res.data.token);  //保存token。
                        this.$router.push("/organizerPage")
                    }else if(res.statusCode == '10008'){
                        this.retreatPopup = true;
                    }else{
                        this.$message({
                            message: res.msg ,
                            type: 'error',
                            duration: 1000
                        });
                    }
                }).catch((res)=>{
                    console.log(res);
                })
            },

请求配置详解

	
	{
	  // `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) {
	  })
	}