Java登陸第四十一天——Axios

rowbed發表於2024-04-09
JavaiOS

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

嗯...怎麼不算情話呢。

相關文章