当前位置:   article > 正文

Axios的配置_axios baseurl

axios baseurl

1. Axios请求配置

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

  1. {
  2. // `url` 是用于请求的服务器 URL
  3. url: '/user',
  4. // `method` 是创建请求时使用的方法
  5. method: 'get', // 默认值
  6. // `baseURL` 将自动加在 `url` 前面,除非 `url` 是一个绝对 URL。
  7. // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
  8. baseURL: 'https://some-domain.com/api/',
  9. // `transformRequest` 允许在向服务器发送前,修改请求数据
  10. // 它只能用于 'PUT', 'POST' 和 'PATCH' 这几个请求方法
  11. // 数组中最后一个函数必须返回一个字符串, 一个Buffer实例,ArrayBuffer,FormData,或 Stream
  12. // 你可以修改请求头。
  13. transformRequest: [function (data, headers) {
  14. // 对发送的 data 进行任意转换处理
  15. return data;
  16. }],
  17. // `transformResponse` 在传递给 then/catch 前,允许修改响应数据
  18. transformResponse: [function (data) {
  19. // 对接收的 data 进行任意转换处理
  20. return data;
  21. }],
  22. // 自定义请求头
  23. headers: {'X-Requested-With': 'XMLHttpRequest'},
  24. // `params` 是与请求一起发送的 URL 参数
  25. // 必须是一个简单对象或 URLSearchParams 对象
  26. params: {
  27. ID: 12345
  28. },
  29. // `paramsSerializer`是可选方法,主要用于序列化`params`
  30. // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
  31. paramsSerializer: function (params) {
  32. return Qs.stringify(params, {arrayFormat: 'brackets'})
  33. },
  34. // `data` 是作为请求体被发送的数据
  35. // 仅适用 'PUT', 'POST', 'DELETE 和 'PATCH' 请求方法
  36. // 在没有设置 `transformRequest` 时,则必须是以下类型之一:
  37. // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  38. // - 浏览器专属: FormData, File, Blob
  39. // - Node 专属: Stream, Buffer
  40. data: {
  41. firstName: 'Fred'
  42. },
  43. // 发送请求体数据的可选语法
  44. // 请求方式 post
  45. // 只有 value 会被发送,key 则不会
  46. data: 'Country=Brasil&City=Belo Horizonte',
  47. // `timeout` 指定请求超时的毫秒数。
  48. // 如果请求时间超过 `timeout` 的值,则请求会被中断
  49. timeout: 1000, // 默认值是 `0` (永不超时)
  50. // `withCredentials` 表示跨域请求时是否需要使用凭证(是否携带cookie,false为不携带)
  51. withCredentials: false, // default
  52. // `adapter` 允许自定义处理请求,这使测试更加容易。
  53. // 返回一个 promise 并提供一个有效的响应 (参见 lib/adapters/README.md)。
  54. adapter: function (config) {
  55. /* ... */
  56. },
  57. // `auth` HTTP Basic Auth
  58. auth: {
  59. username: 'janedoe',
  60. password: 's00pers3cret'
  61. },
  62. // `responseType` 表示浏览器将要响应的数据类型
  63. // 选项包括: 'arraybuffer', 'document', 'json', 'text', 'stream'
  64. // 浏览器专属:'blob'
  65. responseType: 'json', // 默认值
  66. // `responseEncoding` 表示用于解码响应的编码 (Node.js 专属)
  67. // 注意:忽略 `responseType` 的值为 'stream',或者是客户端请求
  68. // Note: Ignored for `responseType` of 'stream' or client-side requests
  69. responseEncoding: 'utf8', // 默认值
  70. // `xsrfCookieName` 是 xsrf token 的值,被用作 cookie 的名称(实行保护作用)
  71. xsrfCookieName: 'XSRF-TOKEN', // 默认值
  72. // `xsrfHeaderName` 是带有 xsrf token 值的http 请求头名称
  73. xsrfHeaderName: 'X-XSRF-TOKEN', // 默认值
  74. // `onUploadProgress` 允许为上传处理进度事件
  75. // 浏览器专属
  76. onUploadProgress: function (progressEvent) {
  77. // 处理原生进度事件
  78. },
  79. // `onDownloadProgress` 允许为下载处理进度事件
  80. // 浏览器专属
  81. onDownloadProgress: function (progressEvent) {
  82. // 处理原生进度事件
  83. },
  84. // `maxContentLength` 定义了node.js中允许的HTTP响应内容的最大字节数
  85. maxContentLength: 2000,
  86. // `maxBodyLength`(仅Node)定义允许的http请求内容的最大字节数
  87. maxBodyLength: 2000,
  88. // `validateStatus` 定义了对于给定的 HTTP状态码是 resolve 还是 reject promise。
  89. // 如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`),
  90. // 则promise 将会 resolved,否则是 rejected。
  91. validateStatus: function (status) {
  92. return status >= 200 && status < 300; // 默认值
  93. },
  94. // `maxRedirects` 定义了在node.js中要遵循的最大重定向数。
  95. // 如果设置为0,则不会进行重定向
  96. maxRedirects: 5, // 默认值
  97. // `socketPath` 定义了在node.js中使用的UNIX套接字。
  98. // e.g. '/var/run/docker.sock' 发送请求到 docker 守护进程。
  99. // 只能指定 `socketPath` 或 `proxy` 。
  100. // 若都指定,这使用 `socketPath` 。
  101. socketPath: null, // default
  102. // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http
  103. // and https requests, respectively, in node.js. This allows options to be added like
  104. // `keepAlive` that are not enabled by default.
  105. httpAgent: new http.Agent({ keepAlive: true }),
  106. httpsAgent: new https.Agent({ keepAlive: true }),
  107. // `proxy` 定义了代理服务器的主机名,端口和协议。
  108. // 您可以使用常规的`http_proxy` 和 `https_proxy` 环境变量。
  109. // 使用 `false` 可以禁用代理功能,同时环境变量也会被忽略。
  110. // `auth`表示应使用HTTP Basic auth连接到代理,并且提供凭据。
  111. // 这将设置一个 `Proxy-Authorization` 请求头,它会覆盖 `headers` 中已存在的自定义 `Proxy-Authorization` 请求头。
  112. // 如果代理服务器使用 HTTPS,则必须设置 protocol 为`https`
  113. proxy: {
  114. protocol: 'https',
  115. host: '127.0.0.1',
  116. port: 9000,
  117. auth: {
  118. username: 'mikeymike',
  119. password: 'rapunz3l'
  120. }
  121. },
  122. // see https://axios-http.com/zh/docs/cancellation
  123. cancelToken: new CancelToken(function (cancel) {
  124. }),
  125. // `decompress` indicates whether or not the response body should be decompressed
  126. // automatically. If set to `true` will also remove the 'content-encoding' header
  127. // from the responses objects of all decompressed responses
  128. // - Node only (XHR cannot turn off decompression)
  129. decompress: true // 默认值
  130. }

2. axios默认配置

  1. // 默认配置
  2. axios.defaults.method = 'GET'; //设置默认的请求类型为GET
  3. axios.defaults.baseURL = 'http://localhost:3000'; //设置基础URL
  4. axios.defaults.params = {id:100};
  5. axios.defaults.timeout = 3000;
  6. btns[0].onclick = function () {
  7. axios({
  8. url: '/posts',
  9. }).then(response => {
  10. console.log(response);
  11. })
  12. }

3. axios创建实例对象,发送ajax请求

  1. // 创建实例对象
  2. const duanzi = axios.create({
  3. // baseURL: 'https://api.apiopen.top',
  4. baseURL: 'https://api',
  5. timeout: 2000
  6. });
  7. duanzi({
  8. url: '/getJoke',
  9. }).then(response => {
  10. console.log(response);
  11. })

4. axios拦截器

拦截器:在请求或响应被 then 或 catch 处理前拦截它们

  1. <script>
  2. //设置请求拦截器-1 config 配置对象
  3. axios.interceptors.request.use(function (config) {
  4. // 在发送请求前做些什么
  5. console.log('请求拦截器 成功 - 1');
  6. // 修改config中的参数
  7. config.params = {a:100}
  8. return config
  9. }, function (error) {
  10. // 对请求错误做些什么
  11. console.log('请求拦截器 失败 -1');
  12. return Promise.reject(error)
  13. });
  14. //设置请求拦截器-2
  15. axios.interceptors.request.use(function (config) {
  16. // 在发送请求前做些什么
  17. console.log('请求拦截器 成功 - 2');
  18. // 修改config中的参数
  19. // config.timeout = 2000;
  20. return config
  21. // throw '参数出了问题'
  22. }, function (error) {
  23. // 对请求错误做些什么
  24. console.log('请求拦截器 失败 -2');
  25. return Promise.reject(error)
  26. });
  27. // 设置响应拦截器-1
  28. axios.interceptors.response.use(function (response) {
  29. // 2xx 范围内的状态码都会触发该函数.
  30. // 对响应数据做点什么
  31. console.log('响应拦截器 成功 -1');
  32. console.log(response);
  33. // return response
  34. return response.data
  35. },function(error){
  36. console.log('响应拦截器 失败 -1');
  37. return Promise.reject(error)
  38. });
  39. // 设置响应拦截器-2
  40. axios.interceptors.response.use(function (response) {
  41. console.log('响应拦截器 成功 -2');
  42. return response
  43. },function(error){
  44. console.log('响应拦截器 失败 -2');
  45. return Promise.reject(error)
  46. });
  47. // 发送请求
  48. axios({
  49. method:'GET',
  50. url:'http://localhost:3000/posts'
  51. }).then(response=>{
  52. console.log('自定义回调处理成功的结果');
  53. console.log(response);
  54. }).catch(reason=>{
  55. console.log('自定义失败的回调');
  56. })
  57. </script>

5. 使用axios取消请求 

由于服务在本地发送请求时未及时取消,结果就已经响应,所以现在取消请求看不到效果,那们可以在服务器端做一个延时响应,服务端我这里使用的是json-server,想要做一个延时响应,可以在启动服务时使用命令行:json-server --watch db.json --d 2000

在终端启动服务--延时2s:json-server --watch db.json --d 2000

此时取消请求成功:

 问题:如果用户一直发起请求

结果:服务器压力会变得很大

解决方法:当用户发起请求时,查看上一次请求是否还在发送,若上一个请求还在发送,则先将上一个请求取消,重新发送新的请求

  1. <script>
  2. // 获取按钮
  3. const btns = document.querySelectorAll('button')
  4. // 2. 声明全局变量
  5. let cancel = null
  6. // 发送请求
  7. btns[0].onclick = function(){
  8. // 检测上一次请求是否已经完成
  9. if(cancel !== null){
  10. // 取消上一次的请求
  11. cancel()
  12. }
  13. axios({
  14. method:'GET',
  15. url:'http://localhost:3000/posts',
  16. // 1. 添加配置对象的属性
  17. cancelToken :new axios.CancelToken(function(c){
  18. // 3. 将c的值复制给cancel
  19. cancel = c
  20. })
  21. }).then(response=>{
  22. console.log(response);
  23. // 将cancel的值初始化
  24. cancel =null
  25. })
  26. }
  27. // 绑定第二个事件 取消请求
  28. btns[1].onclick = function(){
  29. cancel()
  30. }
  31. </script>

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/weixin_40725706/article/detail/459144
推荐阅读
相关标签
  

闽ICP备14008679号