Java登陆第四十一天——Axios

Vue 推荐使用 axios 来完成 ajax 请求。

axios中文文档

Axios

Axios是一款基于Promise，用于发送HTTP请求和处理HTTP响应的工具库。

内部也是使用原生的ajax对象发送HTTP请求。

所以，在使用它前需要导入依赖。

npm install axios

提供了一个函数：axios()

语法格式如下：

//查看源码，默认导出了axios函数
export default axios;


axios({
method:'请求方式',
url:'请求URL'，
data:{ key:"POST请求方式时，传递数据使用data,GET使用不生效" },
params:{ key:"GET请求方式时，传递键值对数据使用params,POST使用同样也是键值对数据" }
})

Axios的特点：

  1. axios函数的返回值是经过包装的Promise对象。

    • 所以也可以链式调用Promise对象的API。

  2. POST使用data，GET使用params。

  3. 如果axios函数运行出错，返回的Promise对象就是已失败状态。

  4. 如果axios函数运行无误，返回的Promise对象就是已完成状态。

案例

请求的URL：https://api.uomg.com/api/rand.qinghua?format=json

请求方式：GET或POST

数据返回格式：{"code":1,"content":"我努力不是为了你而是因为你。"}
		👆符合JSON格式的字符串，简称JSON串。（内容就是所谓的情话= =）

查看axios函数返回的包装对象

App.vue

<script setup>
import axios from 'axios';

axios({
  method: "GET",
  url: "https://api.uomg.com/api/rand.qinghua",
  params: {
    format: "json"
  }
}).then(function (data) {
  console.log(data)
}).catch(function (data) {
  console.log(data)
})
</script>

效果展示
image

包装对象解析

  • config：axios()函数，发送HTTP请求的配置信息。(其中包含请求头)

  • data：服务器响应体，会被封装到该对象内。(也就是服务器返回的数据)

  • headers：服务器响应头，会被封装到该对象内。

  • request：发送该HTTP请求的原生ajax对象。

  • status：响应状态码。

  • statusText：响应状态码描述。

也可以查看他人的axiox包装对象解析

Axios get和post函数

axios()函数太过麻烦？请看以下函数。

Axios还提供了两个函数：*get()和post()**

语法格式如下：

//get(url,请求配置)
axios.get( 'url' , {key:value} )

//post(url,要传递的数据,请求配置)
axios.post( 'url',{key:value},{key:value} )

请求配置如下，是键值对数据。

点击查看请求配置 
{
  // `url` 是用于请求的服务器 URL
  url: '/user',

  // `method` 是创建请求时使用的方法
  method: 'get', // 默认值

  // `baseURL` 将自动加在 `url` 前面，除非 `url` 是一个绝对 URL。
  // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
  baseURL: 'https://some-domain.com/api/',

  // `transformRequest` 允许在向服务器发送前，修改请求数据
  // 它只能用于 'PUT', 'POST' 和 'PATCH' 这几个请求方法
  // 数组中最后一个函数必须返回一个字符串， 一个Buffer实例，ArrayBuffer，FormData，或 Stream
  // 你可以修改请求头。
  transformRequest: [function (data, headers) {
    // 对发送的 data 进行任意转换处理

    return data;
  }],

  // `transformResponse` 在传递给 then/catch 前，允许修改响应数据
  transformResponse: [function (data) {
    // 对接收的 data 进行任意转换处理

    return data;
  }],

  // 自定义请求头
  headers: {'X-Requested-With': 'XMLHttpRequest'},

  // `params` 是与请求一起发送的 URL 参数
  // 必须是一个简单对象或 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', 'DELETE 和 'PATCH' 请求方法
  // 在没有设置 `transformRequest` 时，则必须是以下类型之一:
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - 浏览器专属: FormData, File, Blob
  // - Node 专属: Stream, Buffer
  data: {
    firstName: 'Fred'
  },
  
  // 发送请求体数据的可选语法
  // 请求方式 post
  // 只有 value 会被发送，key 则不会
  data: 'Country=Brasil&City=Belo Horizonte',

  // `timeout` 指定请求超时的毫秒数。
  // 如果请求时间超过 `timeout` 的值，则请求会被中断
  timeout: 1000, // 默认值是 `0` (永不超时)

  // `withCredentials` 表示跨域请求时是否需要使用凭证
  withCredentials: false, // default

  // `adapter` 允许自定义处理请求，这使测试更加容易。
  // 返回一个 promise 并提供一个有效的响应 （参见 lib/adapters/README.md）。
  adapter: function (config) {
    /* ... */
  },

  // `auth` HTTP Basic Auth
  auth: {
    username: 'janedoe',
    password: 's00pers3cret'
  },

  // `responseType` 表示浏览器将要响应的数据类型
  // 选项包括: 'arraybuffer', 'document', 'json', 'text', 'stream'
  // 浏览器专属：'blob'
  responseType: 'json', // 默认值

  // `responseEncoding` 表示用于解码响应的编码 (Node.js 专属)
  // 注意：忽略 `responseType` 的值为 'stream'，或者是客户端请求
  // Note: Ignored for `responseType` of 'stream' or client-side requests
  responseEncoding: 'utf8', // 默认值

  // `xsrfCookieName` 是 xsrf token 的值，被用作 cookie 的名称
  xsrfCookieName: 'XSRF-TOKEN', // 默认值

  // `xsrfHeaderName` 是带有 xsrf token 值的http 请求头名称
  xsrfHeaderName: 'X-XSRF-TOKEN', // 默认值

  // `onUploadProgress` 允许为上传处理进度事件
  // 浏览器专属
  onUploadProgress: function (progressEvent) {
    // 处理原生进度事件
  },

  // `onDownloadProgress` 允许为下载处理进度事件
  // 浏览器专属
  onDownloadProgress: function (progressEvent) {
    // 处理原生进度事件
  },

  // `maxContentLength` 定义了node.js中允许的HTTP响应内容的最大字节数
  maxContentLength: 2000,

  // `maxBodyLength`（仅Node）定义允许的http请求内容的最大字节数
  maxBodyLength: 2000,

  // `validateStatus` 定义了对于给定的 HTTP状态码是 resolve 还是 reject promise。
  // 如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`)，
  // 则promise 将会 resolved，否则是 rejected。
  validateStatus: function (status) {
    return status >= 200 && status < 300; // 默认值
  },

  // `maxRedirects` 定义了在node.js中要遵循的最大重定向数。
  // 如果设置为0，则不会进行重定向
  maxRedirects: 5, // 默认值

  // `socketPath` 定义了在node.js中使用的UNIX套接字。
  // e.g. '/var/run/docker.sock' 发送请求到 docker 守护进程。
  // 只能指定 `socketPath` 或 `proxy` 。
  // 若都指定，这使用 `socketPath` 。
  socketPath: null, // default

  // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http
  // and https requests, respectively, in node.js. This allows options to be added like
  // `keepAlive` that are not enabled by default.
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),

  // `proxy` 定义了代理服务器的主机名，端口和协议。
  // 您可以使用常规的`http_proxy` 和 `https_proxy` 环境变量。
  // 使用 `false` 可以禁用代理功能，同时环境变量也会被忽略。
  // `auth`表示应使用HTTP Basic auth连接到代理，并且提供凭据。
  // 这将设置一个 `Proxy-Authorization` 请求头，它会覆盖 `headers` 中已存在的自定义 `Proxy-Authorization` 请求头。
  // 如果代理服务器使用 HTTPS，则必须设置 protocol 为`https`
  proxy: {
    protocol: 'https',
    host: '127.0.0.1',
    port: 9000,
    auth: {
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  },

  // see https://axios-http.com/zh/docs/cancellation
  cancelToken: new CancelToken(function (cancel) {
  }),

  // `decompress` indicates whether or not the response body should be decompressed 
  // automatically. If set to `true` will also remove the 'content-encoding' header 
  // from the responses objects of all decompressed responses
  // - Node only (XHR cannot turn off decompression)
  decompress: true // 默认值

}

get和post的特点：

  1. 请求配置不是必须的。

POST请求栗子

App.vue

<script setup>
import {ref, reactive} from 'vue';
import axios from 'axios';

let msg = reactive({
  code: '',
  content: ''
})

async function next() {
  //await后续代码会等待await的执行结果，这里的pro变量，是一个状态已完成的promise对象
  let pro = await axios.post('https://api.uomg.com/api/rand.qinghua', {format: "json"});
  //返回该对象的data
  return pro.data
}

async function say() {
  let data = await next();//把data的值取出来
  console.log(data)
  //使用响应式数据接收，也可以使用ES6提供的Object.assign(对象1,对象2)
  //如果对象1和对象2有同名属性，对象2的值会覆盖对象1的值。
  msg.code=data.code;
  msg.content=data.content;
}
</script>
<template>
  <h3>{{msg}}</h3>
  <button @click="say()">说情话</button>
</template>

<style scoped>
</style>

效果展示
image

嗯...怎么不算情话呢。

posted @ 2024-04-09 18:42  rowbed  阅读(15)  评论(0)  编辑  收藏  举报