Vue.js快速入门之四：axios安装和使用_安装axios

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

特性：

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

一、安装

        使用npm进行安装

npm install --save axios

二、axios API

三、并发请求

        处理并发请求的助手函数：

        这里用简单代码，来了解下两者之间关系，先定义两个请求，代码如下：

//请求一
function getFirst(){
    return axios.get("/api/test/01");
}
 
//请求二
function getSecond(){
    return axios.get("/api/test/02");
}

        先不使用spread，代码如下：

axios.all([getFirst(), getSecond()]).then(res => {
    //这里返回的res结构是个数组，结构：[first请求返回值, second请求返回值]
    console.log(res)
});

        这里我们使用spread看看返回结果是怎样的，代码如下：

axios.all([getFirst(), getSecond()]).then(
    axios.spread( (firstData, secondData) => {
        //这里不难看出，是将数组里元素转换成多个对象，通过Promise返回了
        console.log(firstData, secondData);
    } )
);

四、Content-Type

五、请求配置

        创建请求时可以配置选项，这里只有URL是必需的，其他项没有配置情况下会选择默认项。

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

六、响应结构

        请求的响应结果包含以下信息。

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

七、配置默认值

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

        8.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';

        8.2 自定义实例默认值，代码如下：

// Set config defaults when creating the instance
const instance = axios.create({
  baseURL: 'https://api.example.com'
});
 
// Alter defaults after instance has been created
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

八、拦截器

        在请求或响应被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);
});

九、axios进行自定义封装

        如果对axios进行全局配置，后自定义实例进行默认配置，后者将优先于前者。

        axios安装好可以直接使用了，为什么还要自定义一个新实例，再次封装呢。其实在实际的项目开发中，特别是中大型项目，一个系统所有请求的数据源不可能只有一个，会有很多数据源。每个数据源请求和响应也会存在差异，这时就存在特殊性了，需要根据实际情况来进行处理。

        所以一般情况下，不管项目规模，建议都要进行自定义封装，以便提升可扩展性。

        我们在src中创建utils目录，在里面新建request.js文件，代码如下：

import axios from 'axios'
import { Message, Loading } from 'element-ui'
import store from '@/store/index'
 
//配置全局数据请求类型
axios.defaults.headers['Content-Type'] = "application/json;charset=utf-8";
 
//自定义实例
const service = axios.create({
	baseURL: "",				//数据请求地址
	timeout: 30 * 1000
})
 
//配置加载参数
let loadingOption = {
	text: "正在努力加载中...",
	background: "rgba(0, 0, 0, .5)"
}, loading;
 
//请求拦截器
service.interceptors.request.use(config => {
	//开始加载
	loading = Loading.service(loadingOption);
	//数据转换
	config.data = 'object'===typeof config.data ? JSON.stringify(config.data) : config.data;
	//追加访问令牌
	config.headers['authtoken'] = store.getters.authtoken;
	return config;
}, error => {
	loading.close();
	return Promise.reject(error);
});
 
//响应拦截器
service.interceptors.response.use(response => {
	loading.close();
	if(response.status == 200){
		return response['data'];
	}
	return Promise.reject(response);
}, error => {
	loading.close();
	return Promise.reject(error);
});
 
export default service;

十、开始使用新实例

        新实例的使用方法，和axios是一样，这里我们创建一个api.js来实现个案例，代码如下：

import service from '@/utils/request'
 
// 为给定 ID 的 user 创建请求
service.get('/user?ID=12345').then(response => {
	console.log(response);
}).catch(function (error) {
	console.log(error);
});
 
// 上面的请求也可以这样做
service.get('/user', {
	params: {
		ID: 12345
	}
}).then( response => {
	console.log(response);
}).catch( error => {
	console.log(error);
});

axios的文档地址：Axios 中文文档 | Axios 中文网 | Axios 是一个基于 promise 的网络请求库，可以用于浏览器和 node.js

axios的源码地址：https://github.com/axios/axios