axios

安装

  1. npm install axios

特性

image.png

使用

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. //第一个参数,是第一个接口的值
  9. .then(axios.spread(function (acct, perms) {
  10. // 两个请求现在都执行完成
  11. }));

axios API

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

  1. // 发送 POST 请求
  2. axios({
  3. method: 'post',
  4. url: '/user/12345',
  5. //post类型使用data,get类型使用params
  6. data: {
  7. firstName: 'Fred',
  8. lastName: 'Flintstone'
  9. }
  10. });

请求配置

image.png

  1. {
  2. // `url` 是用于请求的服务器 URL
  3. url: '/user',
  4. // `method` 是创建请求时使用的方法
  5. method: 'get', // default
  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, headers) {
  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, // default
  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', // default
  60. // `responseEncoding` indicates encoding to use for decoding responses
  61. // Note: Ignored for `responseType` of 'stream' or client-side requests
  62. responseEncoding: 'utf8', // default
  63. // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
  64. xsrfCookieName: 'XSRF-TOKEN', // default
  65. // `xsrfHeaderName` is the name of the http header that carries the xsrf token value
  66. xsrfHeaderName: 'X-XSRF-TOKEN', // default
  67. // `onUploadProgress` 允许为上传处理进度事件
  68. onUploadProgress: function (progressEvent) {
  69. // Do whatever you want with the native progress event
  70. },
  71. // `onDownloadProgress` 允许为下载处理进度事件
  72. onDownloadProgress: function (progressEvent) {
  73. // 对原生进度事件的处理
  74. },
  75. // `maxContentLength` 定义允许的响应内容的最大尺寸
  76. maxContentLength: 2000,
  77. // `validateStatus` 定义对于给定的HTTP 响应状态码是 resolve 或 reject promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`),promise 将被 resolve; 否则,promise 将被 rejecte
  78. validateStatus: function (status) {
  79. return status >= 200 && status < 300; // default
  80. },
  81. // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
  82. // 如果设置为0,将不会 follow 任何重定向
  83. maxRedirects: 5, // default
  84. // `socketPath` defines a UNIX Socket to be used in node.js.
  85. // e.g. '/var/run/docker.sock' to send requests to the docker daemon.
  86. // Only either `socketPath` or `proxy` can be specified.
  87. // If both are specified, `socketPath` is used.
  88. socketPath: null, // default
  89. // `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项:
  90. // `keepAlive` 默认没有启用
  91. httpAgent: new http.Agent({ keepAlive: true }),
  92. httpsAgent: new https.Agent({ keepAlive: true }),
  93. // 'proxy' 定义代理服务器的主机名称和端口
  94. // `auth` 表示 HTTP 基础验证应当用于连接代理,并提供凭据
  95. // 这将会设置一个 `Proxy-Authorization` 头,覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
  96. proxy: {
  97. host: '127.0.0.1',
  98. port: 9000,
  99. auth: {
  100. username: 'mikeymike',
  101. password: 'rapunz3l'
  102. }
  103. },
  104. // `cancelToken` 指定用于取消请求的 cancel token
  105. // (查看后面的 Cancellation 这节了解更多)
  106. cancelToken: new CancelToken(function (cancel) {
  107. })
  108. }

常见状态码

401,403,404,500,501,502
400:Bad Request—客户端请求的语法错误,服务器无法理解
401:没有权限(例如:没有带校验信息)
403:forbidden—服务器理解请求客户端的请求,但是拒绝执行此请求
404;NOT Found—服务器无法根据客户端的请求找到资源(网页)。(与401类似)‘
500:Internal Server Error — 服务器内部错误,无法完成请求
501:Not Implemented—服务器不支持请求的功能,无法完成请求
502:Bad Gateway—作为网关或者代理工作的服务器尝试执行请求时,从远程服务器接收到了一个无效的响应
503:Service Unavailable—由于超载或系统维护,服务器暂时的无法处理客户端的请求。延时的长度可包含在服务器的Retry-After头信息中

设置全局axios

方法一

在main.js中引入axios,并将axios放到vue的原型中,例如:
Vue.prototype.$axios=axios

跨域问题

1

在服务端设置白名单

2

设置一个本地代理服务器,用代理服务器请求接口服务器,在通过代理服务器将数据发送给浏览器(页面)

手动创建vue.config.js

在更目录下创建vue.config.js配置文件
关于打包的信息都可以使用vue.config.js配置
QQ截图20220318144829.png

  1. //过程:客户端发起请求,被代理服务器拦截,然后代理服务器将数据放松给目标服务器
  2. module.exports ={
  3. // 用来设置本地开发服务的
  4. devServer: {
  5. //代理
  6. proxy: {
  7. //拦截一个请求
  8. // 如果请求接口有/api,就将这个请求代理到target的url这个地址中
  9. "/api" : {
  10. trget: "<url>",
  11. //是否返回数据
  12. changeOrigin:true,
  13. //路径重写
  14. pathRewrite:{
  15. //通过正则
  16. //将以/api开头的路径中的/api替换成空字符串
  17. "^/api":""
  18. }
  19. }
  20. }
  21. }
  22. }
  1. 1引入axios
  2. 2.发送请求
  3. 3.解决跨域,服务器代理
  4. 1:新建vue.config.js(项目更目录)
  5. 2:写代理配置
  6. module.exports ={
  7. // 用来设置本地开发服务的
  8. devServer: {
  9. proxy: {
  10. // 如果请求接口有/api,就将这个请求代理到target的<url>这个地址中
  11. "/api" : {
  12. trget: "http://192.168.0.13:8080/",
  13. changeOrigin:true,
  14. //路径重写
  15. pathRewrite:{
  16. //通过正则
  17. //将以/api开头的路径中的/api替换成空字符串
  18. "^/api":""
  19. }
  20. }
  21. }
  22. }
  23. }

get请求提交的数据格式:query String
post请求提交的数据: Payload
form表单提交的数据:form data
image.png

创建axios实例

image.png

用法

image.png
创建一个axios.js文件
在文件中二次封axios
将二次封装的axios放到vue原型上(或者直接在要使用的文件中引用)
例如:
下面qs引用错误,地址应该为:’qs’
image.png

拦截器

有点像生命周期
image.png
image.png
可以提高开发效率
请求拦截器
image.png
响应拦截器
image.png

  1. // 1. 引入 axios
  2. // 2. 发请求
  3. // 3. 解决跨域 服务器代理
  4. - 1.新建vue.config.js (项目根目录)
  5. - 2.写代理配置
  6. module.exports = {
  7. devServer: {
  8. proxy: {
  9. // 拦截请求
  10. "/api": {
  11. target: "http://192.168.0.39:8081", // 目标服务器地址,不需要写路径,路径在客服端写
  12. changeOrigin: true,
  13. pathRewrite: {
  14. "^/api": "", // 约定所有的接口路径都是以/api开头 用路径重写即可
  15. },
  16. },
  17. },
  18. },
  19. };
  20. axios 二次封装
  21. import axios from "axios";
  22. import qs from "qs";
  23. const hxios = axios.create({
  24. baseURL: "/api",
  25. transformRequest: [
  26. function (data, headers) {
  27. return qs.stringify(data);
  28. },
  29. ],
  30. timeout: 4000,
  31. });
  32. hxios.interceptors.request.use(
  33. function (config) {
  34. // 在发送请求之前做些什么
  35. return config;
  36. },
  37. function (error) {
  38. // 对请求错误做些什么 包含了状态码
  39. return Promise.reject(error);
  40. }
  41. );
  42. hxios.interceptors.response.use(
  43. function (response) {
  44. // 对响应数据做点什么
  45. return response;
  46. },
  47. function (error) {
  48. // 对响应错误做点什么
  49. console.log(error, "-------------");
  50. return Promise.reject("你出错了!但是呢就不告诉哪里错了");
  51. }
  52. );
  53. export default hxios;