axios的使用说明

时间 2019-11-15

标签 axios 使用说明繁體版

原文原文链接

1 axios中文文档

什么是 axios？

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

axios

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

特性

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

浏览器支持


Latest ✔	Latest ✔	Latest ✔	Latest ✔	Latest ✔	8+ ✔

安装

使用 npm:
使用 bower:html

npm install axios
复制代码

bower install axios
复制代码

使用 cdn:vue

案例

执行 GET 请求java

// 为给定 ID 的 user 建立请求
axios.get('/user?ID=12345')
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });

// 上面的请求也能够这样作
axios.get('/user', {
    params: {
      ID: 12345
    }
})
.then(function (response) {
    console.log(response);
})
.catch(function (error) {
    console.log(error);  
});
复制代码

执行 POST 请求node

axios.post('/user', {
    firstName: 'Fred',
    lastName: 'Flintstone'
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });
复制代码

执行多个并发请求jquery

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 API

能够经过向 axios 传递相关配置来建立请求 ios

axios(config)

// 发送 POST 请求
axios({
  method: 'post',
  url: '/user/12345',
  data: {
    firstName: 'Fred',
    lastName: 'Flintstone'
  }
});
复制代码

// 获取远端图片
axios({
  method:'get',
  url:'http://bit.ly/2mTM3nY',
  responseType:'stream'
})
  .then(function(response) {
  response.data.pipe(fs.createWriteStream('ada_lovelace.jpg'))
});
复制代码

axios(url[, config])

// 发送 GET 请求（默认的方法）
axios('/user/12345');
复制代码

请求方法的别名

为方便起见，为全部支持的请求方法提供了别名 git

axios.request(config)

axios.get(url[, config])

axios.delete(url[, config])

axios.head(url[, config])

axios.options(url[, config])

axios.post(url[, data[, config]])

axios.put(url[, data[, config]])

axios.patch(url[, data[, config]])

注意

在使用别名方法时， url、method、data 这些属性都没必要在配置中指定。 es6

并发

处理并发请求的助手函数

axios.all(iterable)

axios.spread(callback)

建立实例

可使用自定义配置新建一个 axios 实例

axios.create([config])

const instance = axios.create({
  baseURL: 'https://some-domain.com/api/',
  timeout: 1000,
  headers: {'X-Custom-Header': 'foobar'}
});
复制代码

实例方法

如下是可用的实例方法。指定的配置将与实例的配置合并。

axios#request(config)

axios#get(url[, config])

axios#delete(url[, config])

axios#head(url[, config])

axios#options(url[, config])

axios#post(url[, data[, config]])

axios#put(url[, data[, config]])

axios#patch(url[, data[, config]])

请求配置

这些是建立请求时能够用的配置选项。只有 url 是必需的。若是没有指定 method，请求将默认使用 get方法。

{
   // `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: {}
}
复制代码

使用 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);
});
复制代码

在使用 catch 时，或传递 rejection callback 做为 then 的第二个参数时，响应能够经过 error 对象可被使用，正如在错误处理这一节所讲。

配置默认值

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

全局的 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';
复制代码

自定义实例默认值

// 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;
复制代码

配置的优先顺序

配置会以一个优先顺序进行合并。这个顺序是：在 lib/defaults.js 找到的库的默认值，而后是实例的 defaults 属性，最后是请求的 config 参数。后者将优先于前者。这里是一个例子：

// 使用由库提供的配置的默认值来建立实例
// 此时超时配置的默认值是 `0`
var instance = axios.create();

// 覆写库的超时默认值
// 如今，在超时前，全部请求都会等待 2.5 秒
instance.defaults.timeout = 2500;

// 为已知须要花费很长时间的请求覆写超时设置
instance.get('/longRequest', {
  timeout: 5000
});
复制代码

拦截器

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

若是你想在稍后移除拦截器，能够这样：

const myInterceptor = axios.interceptors.request.use(function () {/*...*/});
axios.interceptors.request.eject(myInterceptor);
复制代码

能够为自定义 axios 实例添加拦截器

const instance = axios.create();
instance.interceptors.request.use(function () {/*...*/});
复制代码

错误处理

axios.get('/user/12345')
  .catch(function (error) {
    if (error.response) {
      // The request was made and the server responded with a status code
      // that falls out of the range of 2xx
      console.log(error.response.data);
      console.log(error.response.status);
      console.log(error.response.headers);
    } else if (error.request) {
      // The request was made but no response was received
      // `error.request` is an instance of XMLHttpRequest in the browser and an instance of
      // http.ClientRequest in node.js
      console.log(error.request);
    } else {
      // Something happened in setting up the request that triggered an Error
      console.log('Error', error.message);
    }
    console.log(error.config);
  });
复制代码

Y可使用 validateStatus 配置选项定义一个自定义 HTTP 状态码的错误范围。

axios.get('/user/12345', {
  validateStatus: function (status) {
    return status < 500; // Reject only if the status code is greater than or equal to 500
  }
})
复制代码

取消

使用 cancel token 取消请求

Axios 的 cancel token API 基于cancelable promises proposal，它还处于第一阶段。

可使用 CancelToken.source 工厂方法建立 cancel token，像这样：

const CancelToken = axios.CancelToken;
const source = CancelToken.source();

axios.get('/user/12345', {
  cancelToken: source.token
}).catch(function(thrown) {
  if (axios.isCancel(thrown)) {
    console.log('Request canceled', thrown.message);
  } else {
     // 处理错误
  }
});

axios.post('/user/12345', {
  name: 'new name'
}, {
  cancelToken: source.token
})

// 取消请求（message 参数是可选的）
source.cancel('Operation canceled by the user.');
复制代码

还能够经过传递一个 executor 函数到 CancelToken 的构造函数来建立 cancel token：

const CancelToken = axios.CancelToken;
let cancel;

axios.get('/user/12345', {
  cancelToken: new CancelToken(function executor(c) {
    // executor 函数接收一个 cancel 函数做为参数
    cancel = c;
  })
});

// cancel the request
cancel();
复制代码

注意: 可使用同一个 cancel token 取消多个请求

使用 application/x-www-form-urlencoded format

默认状况下，axios将JavaScript对象序列化为JSON。要以application / x-www-form-urlencoded格式发送数据，您可使用如下选项之一。

浏览器

在浏览器中，您可使用URLSearchParams API，以下所示：

const params = new URLSearchParams();
params.append('param1', 'value1');
params.append('param2', 'value2');
axios.post('/foo', params);
复制代码

请注意，全部浏览器都不支持URLSearchParams（请参阅caniuse.com），但可使用polyfill（确保填充全局环境）。

或者，您可使用qs库编码数据：

const qs = require('qs');
axios.post('/foo', qs.stringify({ 'bar': 123 }));
复制代码

或者以另外一种方式（ES6），

import qs from 'qs';
const data = { 'bar': 123 };
const options = {
  method: 'POST',
  headers: { 'content-type': 'application/x-www-form-urlencoded' },
  data: qs.stringify(data),
  url,
};
axios(options);
复制代码

Node.js

在node.js中，您可使用querystring模块，以下所示：

const querystring = require('querystring');
axios.post('http://something.com/', querystring.stringify({ foo: 'bar' }));
复制代码

您也可使用qs库。

Semver

在axios达到1.0版本以前，破坏性更改将以新的次要版本发布。例如0.5.1和0.5.4将具备相同的API，但0.6.0将具备重大变化。

Promises

axios 依赖原生的 ES6 Promise 实现而被支持. 若是你的环境不支持 ES6 Promise，你可使用 polyfill. ##3 TypeScript axios包括TypeScript定义。

import axios from 'axios';
axios.get('/user?ID=12345');
复制代码

资源

Credits

axios深受Angular提供的、$http服务的启发。最终，axios是为了在Angular以外使用而提供独立的相似$http服的务。

2 axios在项目中的运用

/** * 全站http配置 * * axios参数说明 * isSerialize是否开启form表单提交 * isToken是否须要token */

import axios from 'axios'
import store from '@/store/';
import router from '@/router/router'
import { serialize } from '@/util/util'
import {getToken,getRoleTitle} from '@/util/auth' // 获取相对应的权限
import {Message} from 'element-ui' // 调用弹窗组件
import website from '@/config/website'; // statusWhiteList 经过此处，获取白名单，默认[400]
import NProgress from 'nprogress' // progress bar vue中的进度条
import 'nprogress/nprogress.css' // progress bar style
import Cookies from 'js-cookie'

axios.defaults.timeout = 20000; // 设置超时时间

// 返回其余状态吗
// 定义对于给定的HTTP 响应状态码是 resolve 或 reject promise 。
// 若是 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`)，
// promise 将被 resolve; 不然，promise 将被 rejecte

axios.defaults.validateStatus = function (status) {
    return status >= 200 && status <= 500; // 默认的
};

//跨域请求，容许保存cookie
axios.defaults.withCredentials = true;

// NProgress Configuration
// 经过设置为false关闭加载旋转器。(默认值是ture)
NProgress.configure({
    showSpinner: false
});

//HTTPrequest拦截-添加请求拦截器
axios.interceptors.request.use(config => {
    
    NProgress.start() // start progress bar 加载器开始加载
    
    const meta = (config.meta || {}); // 
    
    const isToken = meta.isToken === false;
    
    if (getToken() && !isToken) {
        config.headers['Admin.Authority.Token.cashloan'] = getToken();
        // 'Bearer ' + getToken() // 让每一个请求携带token--['Authorization']为自定义key 请根据实际状况自行修改
    }
    
    //headers中配置serialize为true开启序列化 是否开启form表单提交
    if (config.methods === 'post' && meta.isSerialize === true) {
        config.data =config.data => {
            let list = [];
            Object.keys(data).forEach(ele => {
                list.push(`${ele}=${data[ele]}`)
            })
            return list.join('&');
        };
    }
    
    return config
    
}, error => {
    return Promise.reject(error)
});

//HTTPresponse拦截-添加响应拦截器
axios.interceptors.response.use(res => {
    NProgress.done(); // 进度条关闭
    
    const status = Number(res.status) || 200; // 返回值必须是200
    
    const statusWhiteList = website.statusWhiteList || []; // 白名单 400
    
    const message = res.data.message || '未知错误'; // 肯定的返回值或者是'未知错误'
   
    const code = res.data.code
    
    if (code === 11002) {
        Message({
            message,
            type: "error"
        })
    }

    if (code === 10004) {
        Message({
            message: "有另外一台设备登陆",
            type: 'error'
        })
        store.dispatch('FedLogOut').then(() => router.push({
            path: '/login'
        }));
    }
    
    if (code === 10001) {
        Message({
            message: "请从新登陆",
            type: 'error'
        })
        Cookies.set('loading', true)
        store.dispatch('FedLogOut').then(() => router.push({
            path: '/login'
        }));
    }
    
    if (code === 10002) {
        Message({
            dangerouslyUseHTMLString: true,
            message: `接口为${res.request.custom.url}</br></br>${getRoleTitle()}没有权限`,
            type: 'error'
        })
    }

    if (code === 10003) {
        Message({
            dangerouslyUseHTMLString: true,
            message,
            type: 'error'
        })
    }

    if (code === 404) {
        Message({
            dangerouslyUseHTMLString: true,
            message: `接口为${res.request.custom.url}</br></br>${JSON.stringify(res.data)}`,
            type: 'error'
        })
     }

    if (code === 400) {
        
        if (res.data.message.includes('/')) {
            Message({
                dangerouslyUseHTMLString: true,
                message: message.split('/')[1],
                type: 'error'
            })
            return
        }

        Message({
            dangerouslyUseHTMLString: true,
            message: `${JSON.stringify(res.data)}`,
            type: 'error'
        })
         
    }

    if (code === 500) {
        if(!res.data.message.includes("TIMEOUT")){
            Message({
                dangerouslyUseHTMLString: true,
                message:`服务器故障，请稍后重试`,
                // message: `接口为${res.request.custom.url}</br></br>${JSON.stringify(res.data)}`,
                type: 'error'
            })
        }
     }

    //若是在白名单里则自行catch逻辑处理
    if (statusWhiteList.includes(status)) return Promise.reject(res);
    //若是是401则跳转到登陆页面
    if (status === 401) store.dispatch('FedLogOut').then(() => router.push({ path: '/login' }));
    // 若是请求为非200否者默认统一处理
    if (status !== 200) {
        Message({
            message: message,
            type: 'error'
        })
        return Promise.reject(new Error(message))
    }
    return res;
}, error => {
    NProgress.done();
    return Promise.reject(new Error(error));
})

export default axios;
复制代码