axios 手册

一、安装

• yarn:

 $ yarn add axios
 

• npm:

 $ npm install axios
 

• bower:

 $ bower install axios

• jsDelivr CDN:

  <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>

• unpkg CDN:

  <script src="https://unpkg.com/axios/dist/axios.min.js"></script>

如果没有安装 yarn ，可以点击此处

二、使用

// 引入 axios 实例
import axios from 'axios'

// 发起一个post请求
axios({
  method: 'post',
  url: '/user/12345',
  data: {
    firstName: 'Fred',
    lastName: 'Flintstone'
  }
});

// 发起一个 GET 请求 (默认请求方式)
axios('/user/12345');

三、 请求配置

{
  // `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, // 默认值

  // `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'
    }
  },
}

四、封装 axios 请求

// 文件：request/index.js

import axios from 'axios'
// 设置基础路径
axios.defaults.baseURL = 'http://www.dujie.com/api';
// 设置数据最久返回时间 到时间离开返回，如没有请求成功算超时
axios.defaults.timeout = 3000;

function server(method, url, data = {}, token = '') {
    return axios({
        method,
        url,
        params: method == 'get' ? data : {},
        data: method == 'post' ? data : {},
        headers: { 'Authorization': 'Bearer ' + token }
    })
}
export default server;

// 文件: request/api/home.js

// 引入 servise 函数
import servise from '../'

// 地址封装
let urls = {
    login:'login',
}

// 登录接口
function login(data) {
  return  servise('post',urls.login,data)
}

export default {
    login,
}

五、拦截

import axios from 'axios'

// 基础设置
let service = axios.create({
    // 基础路径
    baseURL: "http://js.hdxinghe.com/api/",
    // 请求返回时间
    timeout: 3000,

})

// 请求时的拦截
// 第一个函数是 请求 成功的回调函数
// 第二个函数是 请求 失败的回调函数
http.interceptors.request.use(res => {
    console.log(res.url)
    // 判断请求地址中是否带'/auth/'字符串
    // 如果带那么就需要加 token (注意！！！这个是规则自定义的并不是公共的)
    if (/\/auth\//.test(res.url)) {
        res.headers.Authorization = 'Bearer' + user.$state.access_token;

    }
    // 返回参数配置
    return res;
}, err => {
    // 返回错误
    return Promise.reject(err)
})

// 回来时的拦截
// 第一个函数是 响应 成功的回调函数
// 第二个函数是 响应 失败的回调函数
http.interceptors.response.use(res => {
    // 返回响应数据
    return res.data;
}, err => {
    // 返回错误
    return Promise.reject(err);

})

// 封装请求需要的参数
function services(method, url, params = {}, token = '') {
    return service({
        method,
        url,
        params: method == 'get' ? params : {},
        data: method == 'post' ? params : {},
        headers: { 'Authorization': 'Bearer ' + token }
    })
}

// export 导出函数（只能一个）
export default services

六、解决跨域

// 文件：vite.config.js 
// 如果不是 vite 项目，可以找后缀带 config.js 的文件 如果是 ts 就是后缀带 config.ts

import { fileURLToPath, URL } from 'node:url'

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [vue()],
  resolve: {
    alias: {
      '@': fileURLToPath(new URL('./src', import.meta.url))
    }
  },
  // 解决跨域的代码
  server:{
    proxy:{
      // 匹配 /abc 之后 把 /abc 换成 target内容 
      // abc 可以任意修改 
      // 如果你请求的是 https://www.dujie.com/abc 就会跳转到百度
      // 但 https://www.dujie.com 这样就不会
      '/abc':{
        target: 'https://www.budai.com',
        changeOrigin: true,
        secure:false,
        // 修改  path 内容
        rewrite:(path) => path.replace(/\/abc/,'')
      }
    }
  }
})

七、相关网址

axios Api

点击跳转