{"path":"234845","ref":"readme.md","title":"使用说明","content":"##Axios\n\n[![npm version](https:\/\/img.shields.io\/npm\/v\/axios.svg?style=flat-square)](https:\/\/www.npmjs.org\/package\/axios)\n[![build status](https:\/\/img.shields.io\/travis\/mzabriskie\/axios.svg?style=flat-square)](https:\/\/travis-ci.org\/mzabriskie\/axios)\n[![code coverage](https:\/\/img.shields.io\/coveralls\/mzabriskie\/axios.svg?style=flat-square)](https:\/\/coveralls.io\/r\/mzabriskie\/axios)\n[![npm downloads](https:\/\/img.shields.io\/npm\/dm\/axios.svg?style=flat-square)](http:\/\/npm-stat.com\/charts.html?package=axios)\n[![gitter chat](https:\/\/img.shields.io\/gitter\/room\/mzabriskie\/axios.svg?style=flat-square)](https:\/\/gitter.im\/mzabriskie\/axios)\n\nAxios 是一个基于 promise 的 HTTP 库，可以用在浏览器和 node.js 中。\n\n## Features\n\n- 从浏览器中创建 [XMLHttpRequests](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/API\/XMLHttpRequest)\n- 从 node.js 创建 [http](http:\/\/nodejs.org\/api\/http.html) 请求\n- 支持 [Promise](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Promise) API\n- 拦截请求和响应\n- 转换请求数据和响应数据\n- 取消请求\n- 自动转换 JSON 数据\n- 客户端支持防御 [XSRF](http:\/\/en.wikipedia.org\/wiki\/Cross-site_request_forgery)\n\n## 浏览器支持\n\n|![Chrome](https:\/\/raw.github.com\/alrra\/browser-logos\/master\/chrome\/chrome_48x48.png) | ![Firefox](https:\/\/raw.github.com\/alrra\/browser-logos\/master\/firefox\/firefox_48x48.png) | ![Safari](https:\/\/raw.github.com\/alrra\/browser-logos\/master\/safari\/safari_48x48.png) | ![Opera](https:\/\/raw.github.com\/alrra\/browser-logos\/master\/opera\/opera_48x48.png) | ![Edge](https:\/\/raw.github.com\/alrra\/browser-logos\/master\/edge\/edge_48x48.png) | ![IE](https:\/\/raw.github.com\/alrra\/browser-logos\/master\/internet-explorer\/internet-explorer_48x48.png) |\n|--- | --- | --- | --- | --- | --- |\n|Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | 8+ ✔ |\n\n[![Browser Matrix](https:\/\/saucelabs.com\/open_sauce\/build_matrix\/axios.svg)](https:\/\/saucelabs.com\/u\/axios)\n\n## 安装\n\n使用 npm:\n\n```bash\n$ npm install axios\n```\n\n使用 bower:\n\n```bash\n$ bower install axios\n```\n\n使用 cdn:\n\n```html\n<script src=\"https:\/\/unpkg.com\/axios\/dist\/axios.min.js\"><\/script>\n```\n\n## Example\n\n执行 `GET` 请求\n\n```js\n\/\/ 为给定 ID 的 user 创建请求\naxios.get('\/user?ID=12345')\n  .then(function (response) {\n    console.log(response);\n  })\n  .catch(function (error) {\n    console.log(error);\n  });\n\n\/\/ 可选地，上面的请求可以这样做\naxios.get('\/user', {\n    params: {\n      ID: 12345\n    }\n  })\n  .then(function (response) {\n    console.log(response);\n  })\n  .catch(function (error) {\n    console.log(error);\n  });\n```\n\n执行 `POST` 请求\n\n```js\naxios.post('\/user', {\n    firstName: 'Fred',\n    lastName: 'Flintstone'\n  })\n  .then(function (response) {\n    console.log(response);\n  })\n  .catch(function (error) {\n    console.log(error);\n  });\n```\n\n执行多个并发请求\n\n```js\nfunction getUserAccount() {\n  return axios.get('\/user\/12345');\n}\n\nfunction getUserPermissions() {\n  return axios.get('\/user\/12345\/permissions');\n}\n\naxios.all([getUserAccount(), getUserPermissions()])\n  .then(axios.spread(function (acct, perms) {\n    \/\/ 两个请求现在都执行完成\n  }));\n```\n\n## axios API\n\n可以通过向 `axios` 传递相关配置来创建请求\n\n##### axios(config)\n\n```js\n\/\/ 发送 POST 请求\naxios({\n  method: 'post',\n  url: '\/user\/12345',\n  data: {\n    firstName: 'Fred',\n    lastName: 'Flintstone'\n  }\n});\n```\n\n##### axios(url[, config])\n\n```js\n\/\/ 发送 GET 请求（默认的方法）\naxios('\/user\/12345');\n```\n\n### 请求方法的别名\n\n为方便起见，为所有支持的请求方法提供了别名\n\n##### axios.request(config)\n##### axios.get(url[, config])\n##### axios.delete(url[, config])\n##### axios.head(url[, config])\n##### axios.post(url[, data[, config]])\n##### axios.put(url[, data[, config]])\n##### axios.patch(url[, data[, config]])\n\n###### NOTE\n在使用别名方法时， `url`、`method`、`data` 这些属性都不必在配置中指定。\n\n### 并发\n\n处理并发请求的助手函数\n\n##### axios.all(iterable)\n##### axios.spread(callback)\n\n### 创建实例\n\n可以使用自定义配置新建一个 axios 实例\n\n##### axios.create([config])\n\n```js\nvar instance = axios.create({\n  baseURL: 'https:\/\/some-domain.com\/api\/',\n  timeout: 1000,\n  headers: {'X-Custom-Header': 'foobar'}\n});\n```\n\n### 实例方法\n\n以下是可用的实例方法。指定的配置将与实例的配置合并\n\n##### axios#request(config)\n##### axios#get(url[, config])\n##### axios#delete(url[, config])\n##### axios#head(url[, config])\n##### axios#post(url[, data[, config]])\n##### axios#put(url[, data[, config]])\n##### axios#patch(url[, data[, config]])\n\n## 请求配置\n\n这些是创建请求时可以用的配置选项。只有 `url` 是必需的。如果没有指定 `method`，请求将默认使用 `get` 方法。\n\n```js\n{\n  \/\/ `url` 是用于请求的服务器 URL\n  url: '\/user',\n\n  \/\/ `method` 是创建请求时使用的方法\n  method: 'get', \/\/ 默认是 get\n\n  \/\/ `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。\n  \/\/ 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL\n  baseURL: 'https:\/\/some-domain.com\/api\/',\n\n  \/\/ `transformRequest` 允许在向服务器发送前，修改请求数据\n  \/\/ 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法\n  \/\/ 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream\n  transformRequest: [function (data) {\n    \/\/ 对 data 进行任意转换处理\n\n    return data;\n  }],\n\n  \/\/ `transformResponse` 在传递给 then\/catch 前，允许修改响应数据\n  transformResponse: [function (data) {\n    \/\/ 对 data 进行任意转换处理\n\n    return data;\n  }],\n\n  \/\/ `headers` 是即将被发送的自定义请求头\n  headers: {'X-Requested-With': 'XMLHttpRequest'},\n\n  \/\/ `params` 是即将与请求一起发送的 URL 参数\n  \/\/ 必须是一个无格式对象(plain object)或 URLSearchParams 对象\n  params: {\n    ID: 12345\n  },\n\n  \/\/ `paramsSerializer` 是一个负责 `params` 序列化的函数\n  \/\/ (e.g. https:\/\/www.npmjs.com\/package\/qs, http:\/\/api.jquery.com\/jquery.param\/)\n  paramsSerializer: function(params) {\n    return Qs.stringify(params, {arrayFormat: 'brackets'})\n  },\n\n  \/\/ `data` 是作为请求主体被发送的数据\n  \/\/ 只适用于这些请求方法 'PUT', 'POST', 和 'PATCH'\n  \/\/ 在没有设置 `transformRequest` 时，必须是以下类型之一：\n  \/\/ - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams\n  \/\/ - 浏览器专属：FormData, File, Blob\n  \/\/ - Node 专属： Stream\n  data: {\n    firstName: 'Fred'\n  },\n\n  \/\/ `timeout` 指定请求超时的毫秒数(0 表示无超时时间)\n  \/\/ 如果请求话费了超过 `timeout` 的时间，请求将被中断\n  timeout: 1000,\n\n  \/\/ `withCredentials` 表示跨域请求时是否需要使用凭证\n  withCredentials: false, \/\/ 默认的\n\n  \/\/ `adapter` 允许自定义处理请求，以使测试更轻松\n  \/\/ 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).\n  adapter: function (config) {\n    \/* ... *\/\n  },\n\n  \/\/ `auth` 表示应该使用 HTTP 基础验证，并提供凭据\n  \/\/ 这将设置一个 `Authorization` 头，覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头\n  auth: {\n    username: 'janedoe',\n    password: 's00pers3cret'\n  },\n\n  \/\/ `responseType` 表示服务器响应的数据类型，可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'\n  responseType: 'json', \/\/ 默认的\n\n  \/\/ `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称\n  xsrfCookieName: 'XSRF-TOKEN', \/\/ default\n\n  \/\/ `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称\n  xsrfHeaderName: 'X-XSRF-TOKEN', \/\/ 默认的\n\n  \/\/ `onUploadProgress` 允许为上传处理进度事件\n  onUploadProgress: function (progressEvent) {\n    \/\/ 对原生进度事件的处理\n  },\n\n  \/\/ `onDownloadProgress` 允许为下载处理进度事件\n  onDownloadProgress: function (progressEvent) {\n    \/\/ 对原生进度事件的处理\n  },\n\n  \/\/ `maxContentLength` 定义允许的响应内容的最大尺寸\n  maxContentLength: 2000,\n\n  \/\/ `validateStatus` 定义对于给定的HTTP 响应状态码是 resolve 或 reject  promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`)，promise 将被 resolve; 否则，promise 将被 rejecte\n  validateStatus: function (status) {\n    return status >= 200 && status < 300; \/\/ 默认的\n  },\n\n  \/\/ `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目\n  \/\/ 如果设置为0，将不会 follow 任何重定向\n  maxRedirects: 5, \/\/ 默认的\n\n  \/\/ `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项：\n  \/\/ `keepAlive` 默认没有启用\n  httpAgent: new http.Agent({ keepAlive: true }),\n  httpsAgent: new https.Agent({ keepAlive: true }),\n\n  \/\/ 'proxy' 定义代理服务器的主机名称和端口\n  \/\/ `auth` 表示 HTTP 基础验证应当用于连接代理，并提供凭据\n  \/\/ 这将会设置一个 `Proxy-Authorization` 头，覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。\n  proxy: {\n    host: '127.0.0.1',\n    port: 9000,\n    auth: : {\n      username: 'mikeymike',\n      password: 'rapunz3l'\n    }\n  },\n\n  \/\/ `cancelToken` 指定用于取消请求的 cancel token\n  \/\/ （查看后面的 Cancellation 这节了解更多）\n  cancelToken: new CancelToken(function (cancel) {\n  })\n}\n```\n\n## 响应结构\n\n某个请求的响应包含以下信息\n\n```js\n{\n  \/\/ `data` 由服务器提供的响应\n  data: {},\n\n  \/\/ `status` 来自服务器响应的 HTTP 状态码\n  status: 200,\n\n  \/\/ `statusText` 来自服务器响应的 HTTP 状态信息\n  statusText: 'OK',\n\n  \/\/ `headers` 服务器响应的头\n  headers: {},\n\n  \/\/ `config` 是为请求提供的配置信息\n  config: {}\n}\n```\n\n使用 `then` 时，你将接收下面这样的响应：\n\n```js\naxios.get('\/user\/12345')\n  .then(function(response) {\n    console.log(response.data);\n    console.log(response.status);\n    console.log(response.statusText);\n    console.log(response.headers);\n    console.log(response.config);\n  });\n```\n\n在使用 `catch` 时，或传递 [rejection callback](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Promise\/then) 作为 `then` 的第二个参数时，响应可以通过 `error` 对象可被使用，正如在[错误处理](#handling-errors)这一节所讲。\n\n## 配置的默认值\/defaults\n\n你可以指定将被用在各个请求的配置默认值\n\n### 全局的 axios 默认值\n\n```js\naxios.defaults.baseURL = 'https:\/\/api.example.com';\naxios.defaults.headers.common['Authorization'] = AUTH_TOKEN;\naxios.defaults.headers.post['Content-Type'] = 'application\/x-www-form-urlencoded';\n```\n\n### 自定义实例默认值\n\n```js\n\/\/ 创建实例时设置配置的默认值\nvar instance = axios.create({\n  baseURL: 'https:\/\/api.example.com'\n});\n\n\/\/ 在实例已创建后修改默认值\ninstance.defaults.headers.common['Authorization'] = AUTH_TOKEN;\n```\n\n### 配置的优先顺序\n\n配置会以一个优先顺序进行合并。这个顺序是：在 `lib\/defaults.js` 找到的库的默认值，然后是实例的 `defaults` 属性，最后是请求的 `config` 参数。后者将优先于前者。这里是一个例子：\n\n```js\n\/\/ 使用由库提供的配置的默认值来创建实例\n\/\/ 此时超时配置的默认值是 `0`\nvar instance = axios.create();\n\n\/\/ 覆写库的超时默认值\n\/\/ 现在，在超时前，所有请求都会等待 2.5 秒\ninstance.defaults.timeout = 2500;\n\n\/\/ 为已知需要花费很长时间的请求覆写超时设置\ninstance.get('\/longRequest', {\n  timeout: 5000\n});\n```\n\n## 拦截器\n\n在请求或响应被 `then` 或 `catch` 处理前拦截它们。\n\n```js\n\/\/ 添加请求拦截器\naxios.interceptors.request.use(function (config) {\n    \/\/ 在发送请求之前做些什么\n    return config;\n  }, function (error) {\n    \/\/ 对请求错误做些什么\n    return Promise.reject(error);\n  });\n\n\/\/ 添加响应拦截器\naxios.interceptors.response.use(function (response) {\n    \/\/ 对响应数据做点什么\n    return response;\n  }, function (error) {\n    \/\/ 对响应错误做点什么\n    return Promise.reject(error);\n  });\n```\n\n如果你想在稍后移除拦截器，可以这样：\n\n```js\nvar myInterceptor = axios.interceptors.request.use(function () {\/*...*\/});\naxios.interceptors.request.eject(myInterceptor);\n```\n\n可以为自定义 axios 实例添加拦截器\n\n```js\nvar instance = axios.create();\ninstance.interceptors.request.use(function () {\/*...*\/});\n```\n\n## 错误处理\n\n```js\naxios.get('\/user\/12345')\n  .catch(function (error) {\n    if (error.response) {\n      \/\/ 请求已发出，但服务器响应的状态码不在 2xx 范围内\n      console.log(error.response.data);\n      console.log(error.response.status);\n      console.log(error.response.headers);\n    } else {\n      \/\/ Something happened in setting up the request that triggered an Error\n      console.log('Error', error.message);\n    }\n    console.log(error.config);\n  });\n```\n\n可以使用 `validateStatus` 配置选项定义一个自定义 HTTP 状态码的错误范围。\n\n```js\naxios.get('\/user\/12345', {\n  validateStatus: function (status) {\n    return status < 500; \/\/ 状态码在大于或等于500时才会 reject\n  }\n})\n```\n\n## 取消\n\n使用 *cancel token* 取消请求\n\n> Axios 的 cancel token API 基于[cancelable promises proposal](https:\/\/github.com\/tc39\/proposal-cancelable-promises)，它还处于第一阶段。\n\n可以使用 `CancelToken.source` 工厂方法创建 cancel token，像这样：\n\n```js\nvar CancelToken = axios.CancelToken;\nvar source = CancelToken.source();\n\naxios.get('\/user\/12345', {\n  cancelToken: source.token\n}).catch(function(thrown) {\n  if (axios.isCancel(thrown)) {\n    console.log('Request canceled', thrown.message);\n  } else {\n    \/\/ 处理错误\n  }\n});\n\n\/\/ 取消请求（message 参数是可选的）\nsource.cancel('Operation canceled by the user.');\n```\n\n还可以通过传递一个 executor 函数到 `CancelToken` 的构造函数来创建 cancel token：\n\n```js\nvar CancelToken = axios.CancelToken;\nvar cancel;\n\naxios.get('\/user\/12345', {\n  cancelToken: new CancelToken(function executor(c) {\n    \/\/ executor 函数接收一个 cancel 函数作为参数\n    cancel = c;\n  })\n});\n\n\/\/ 取消请求\ncancel();\n```\n\nNote : 可以使用同一个 cancel token 取消多个请求\n\n## Semver\n\nUntil axios reaches a `1.0` release, breaking changes will be released with a new minor version. For example `0.5.1`, and `0.5.4` will have the same API, but `0.6.0` will have breaking changes.\n\n## Promises\n\naxios 依赖原生的 ES6 Promise 实现而[被支持](http:\/\/caniuse.com\/promises).\n如果你的环境不支持 ES6 Promise，你可以使用 [polyfill](https:\/\/github.com\/jakearchibald\/es6-promise).\n\n## TypeScript\naxios includes [TypeScript](http:\/\/typescriptlang.org) definitions.\n```typescript\nimport axios from 'axios';\naxios.get('\/user?ID=12345');\n```\n\n## Resources\n\n* [Changelog](https:\/\/github.com\/mzabriskie\/axios\/blob\/master\/CHANGELOG.md)\n* [Upgrade Guide](https:\/\/github.com\/mzabriskie\/axios\/blob\/master\/UPGRADE_GUIDE.md)\n* [Ecosystem](https:\/\/github.com\/mzabriskie\/axios\/blob\/master\/ECOSYSTEM.md)\n* [Contributing Guide](https:\/\/github.com\/mzabriskie\/axios\/blob\/master\/CONTRIBUTING.md)\n* [Code of Conduct](https:\/\/github.com\/mzabriskie\/axios\/blob\/master\/CODE_OF_CONDUCT.md)\n\n## Credits\n\naxios is heavily inspired by the [$http service](https:\/\/docs.angularjs.org\/api\/ng\/service\/$http) provided in [Angular](https:\/\/angularjs.org\/). Ultimately axios is an effort to provide a standalone `$http`-like service for use outside of Angular.\n\n## License\n\nMIT\n"}