当前位置:首页 > axios一个基于promise的 HTTP 库,可以用在浏览器和 node.js 中,用来代替vue resourse

axios一个基于promise的 HTTP 库,可以用在浏览器和 node.js 中,用来代替vue resourse

发布于 2018-08-30 阅读 697 次 Javascript

axios一个基于promise的 HTTP 库,可以用在浏览器和 node.js 中,用来代替vue resourse,使用起来和jquery的ajax方法类似,也有各种请求的别名方法,这一点也和jquery很类似。

支持情况:

安装

使用 npm:

  1. $ npm install axios

使用 bower:

  1. $ bower install axios

使用 cdn:

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

例子

执行get请求
  1. // 为给定 ID 的 user 创建请求
  2. axios.get('/user?ID=12345')
  3. .then(function (response) {
  4. console.log(response);
  5. })
  6. .catch(function (error) {
  7. console.log(error);
  8. });
  9. // 可选地,上面的请求可以这样做
  10. axios.get('/user', {
  11. params: {
  12. ID: 12345
  13. }
  14. })
  15. .then(function (response) {
  16. console.log(response);
  17. })
  18. .catch(function (error) {
  19. console.log(error);
  20. });
执行post请求
  1. axios.post('/user', {
  2. firstName: 'Fred',
  3. lastName: 'Flintstone'
  4. })
  5. .then(function (response) {
  6. console.log(response);
  7. })
  8. .catch(function (error) {
  9. console.log(error);
  10. });
多个请求并发
  1. function getUserAccount() {
  2. return axios.get('/user/12345');
  3. }
  4. function getUserPermissions() {
  5. return axios.get('/user/12345/permissions');
  6. }
  7. axios.all([getUserAccount(), getUserPermissions()])
  8. .then(axios.spread(function (acct, perms) {
  9. // 两个请求现在都执行完成
  10. }));

axios API

可以通过向 axios 传递相关配置来创建请求

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

请求方法的别名

为方便起见,为所有支持的请求方法提供了别名

axios.request(config)

axios.get(url[, config])

axios.delete(url[, config])

axios.head(url[, config])

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

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

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

NOTE:在使用别名方法时, url、method、data 这些属性都不必在配置中指定。

并发

处理并发请求的助手函数

axios.all(iterable)
axios.spread(callback)

创建实例

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

  1. axios.create([config])
  2. var instance = axios.create({
  3. baseURL: 'https://some-domain.com/api/',
  4. timeout: 1000,
  5. headers: {'X-Custom-Header': 'foobar'}
  6. });

实例方法

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

axios#request(config)

axios#get(url[, config])

axios#delete(url[, config])

axios#head(url[, config])

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

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

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

请求配置

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

  1. {
  2. // `url` 是用于请求的服务器 URL
  3. url: '/user',
  4. // `method` 是创建请求时使用的方法
  5. method: 'get', // 默认是 get
  6. // `baseURL` 将自动加在 `url` 前面,除非 `url` 是一个绝对 URL。
  7. // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
  8. baseURL: 'https://some-domain.com/api/',
  9. // `transformRequest` 允许在向服务器发送前,修改请求数据
  10. // 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
  11. // 后面数组中的函数必须返回一个字符串,或 ArrayBuffer,或 Stream
  12. transformRequest: [function (data) {
  13. // 对 data 进行任意转换处理
  14. return data;
  15. }],
  16. // `transformResponse` 在传递给 then/catch 前,允许修改响应数据
  17. transformResponse: [function (data) {
  18. // 对 data 进行任意转换处理
  19. return data;
  20. }],
  21. // `headers` 是即将被发送的自定义请求头
  22. headers: {'X-Requested-With': 'XMLHttpRequest'},
  23. // `params` 是即将与请求一起发送的 URL 参数
  24. // 必须是一个无格式对象(plain object)或 URLSearchParams 对象
  25. params: {
  26. ID: 12345
  27. },
  28. // `paramsSerializer` 是一个负责 `params` 序列化的函数
  29. // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
  30. paramsSerializer: function(params) {
  31. return Qs.stringify(params, {arrayFormat: 'brackets'})
  32. },
  33. // `data` 是作为请求主体被发送的数据
  34. // 只适用于这些请求方法 'PUT', 'POST', 和 'PATCH'
  35. // 在没有设置 `transformRequest` 时,必须是以下类型之一:
  36. // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  37. // - 浏览器专属:FormData, File, Blob
  38. // - Node 专属: Stream
  39. data: {
  40. firstName: 'Fred'
  41. },
  42. // `timeout` 指定请求超时的毫秒数(0 表示无超时时间)
  43. // 如果请求话费了超过 `timeout` 的时间,请求将被中断
  44. timeout: 1000,
  45. // `withCredentials` 表示跨域请求时是否需要使用凭证
  46. withCredentials: false, // 默认的
  47. // `adapter` 允许自定义处理请求,以使测试更轻松
  48. // 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
  49. adapter: function (config) {
  50. /* ... */
  51. },
  52. // `auth` 表示应该使用 HTTP 基础验证,并提供凭据
  53. // 这将设置一个 `Authorization` 头,覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
  54. auth: {
  55. username: 'janedoe',
  56. password: 's00pers3cret'
  57. },
  58. // `responseType` 表示服务器响应的数据类型,可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
  59. responseType: 'json', // 默认的
  60. // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
  61. xsrfCookieName: 'XSRF-TOKEN', // default
  62. // `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称
  63. xsrfHeaderName: 'X-XSRF-TOKEN', // 默认的
  64. // `onUploadProgress` 允许为上传处理进度事件
  65. onUploadProgress: function (progressEvent) {
  66. // 对原生进度事件的处理
  67. },
  68. // `onDownloadProgress` 允许为下载处理进度事件
  69. onDownloadProgress: function (progressEvent) {
  70. // 对原生进度事件的处理
  71. },
  72. // `maxContentLength` 定义允许的响应内容的最大尺寸
  73. maxContentLength: 2000,
  74. // `validateStatus` 定义对于给定的HTTP 响应状态码是 resolve 或 reject promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`),promise 将被 resolve; 否则,promise 将被 rejecte
  75. validateStatus: function (status) {
  76. return status >= 200 && status < 300; // 默认的
  77. },
  78. // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
  79. // 如果设置为0,将不会 follow 任何重定向
  80. maxRedirects: 5, // 默认的
  81. // `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项:
  82. // `keepAlive` 默认没有启用
  83. httpAgent: new http.Agent({ keepAlive: true }),
  84. httpsAgent: new https.Agent({ keepAlive: true }),
  85. // 'proxy' 定义代理服务器的主机名称和端口
  86. // `auth` 表示 HTTP 基础验证应当用于连接代理,并提供凭据
  87. // 这将会设置一个 `Proxy-Authorization` 头,覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
  88. proxy: {
  89. host: '127.0.0.1',
  90. port: 9000,
  91. auth: : {
  92. username: 'mikeymike',
  93. password: 'rapunz3l'
  94. }
  95. },
  96. // `cancelToken` 指定用于取消请求的 cancel token
  97. // (查看后面的 Cancellation 这节了解更多)
  98. cancelToken: new CancelToken(function (cancel) {
  99. })
  100. }

摘自:https://www.kancloud.cn/yunye/axios/234845