跳至主要內容

Axios基本使用

CharHua大约 9 分钟JavaScriptAxios网络请求前后端交互

Axios基本使用

一、安装

  1. 使用npm包管理器：

    npm install axios

  2. 使用yarn：

    yarn add axios

  3. 使用CDN：

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

二、基本网络请求

1、引入文件

//使用ESM
import axios from 'axios';
//使用CMJ
const axios = require('axios');

  • 在Typescript中使用axios时，往往需要引入类型注解：

    //使用ESM
import axios, { AxiosRequestConfig } from 'axios';
//使用CMJ
const axios = require('axios').default;
// axios.<method> 能够提供自动完成和参数类型推断功能

2、基本使用

1、Axios API 单个请求

当我们发起GET或POST请求，可有几种方式：

  1. 使用GET和POST API

    const getData = axios.get('https://www.httpbin.org/get', {
  params: {
    name: 'zwh'
  }
});
//axios返回一个Promise

    由于返回值为Promise，因此我们可以调用then()或者使用async/await来获取异步请求的结果：

    getData.then((res: any) => {
  console.log(res.data);
});
    • 当然也可以发送POST请求：
    axios
  .post('https://www.httpbin.org/post', {
    info: {
      name: 'zwh'
    }
  })
  .then((res: any) => {
    console.log(res.data);
  });

  2. 使用request API

    const request = axios.request({
  url: 'https://www.httpbin.org/post',
  method: 'POST',
  data: {   //发送数据的字段data，可选
    info:{
      name:'zwh'
    }
  }
});

  3. 使用axios ()

    const axiosData = axios({
  url: 'https://www.httpbin.org/post',
  method: 'GET'
});

当然，axios也可以发起其他请求，他们可以是以别名方式，或者以request API、axios()等方式。

  • 请求方式和参数结构如下（来自axios官网）：
axios.request(config)
axios.get(url[, config])
axios.delete(url[, config])
axios.head(url[, config])
axios.options(url[, config])
axios.post(url[, data[, config]])
axios.put(url[, data[, config]])
axios.patch(url[, data[, config]])

2、Axios API 多个请求

  • 使用axios.all()方法可以同时进行多个请求，并且一起返回结果。
axios.all([
    axios.get('https://www.httpbin.org/get', { params: { name: 'zwh' } }),
    axios.post('https://www.httpbin.org/post', { data: { name: 'zwh' } })
  ])
  .then((res) => {
    console.log(res[0].data)
    console.log(res[1].data)
  })

3、Axios 实例

我们可以创建多个axios实例，以便实现多个互不干扰的网络请求。

  • 利用axios.create()创建axios实例：

    const instance = axios.create({
  baseURL: 'https://www.httpbin.org/',
  timeout: '5000'
});

instance.request({
    url: '/get',
    method: 'GET'
  }).then((res: any) => {
    console.log(res.data);
  });

创建使用axios实例与直接调用axios是一样的，区别在于创建的实例间不相互干扰。

  • 实例可以用的请求方法：

    axios#request(config)
axios#get(url[, config])
axios#delete(url[, config])
axios#head(url[, config])
axios#options(url[, config])
axios#post(url[, data[, config]])
axios#put(url[, data[, config]])
axios#patch(url[, data[, config]])
axios#getUri([config])

4、Axios 配置

使用API进行网络请求时，通常会传入url，数据等参数，也可以传入config参数。

  • 注意，使用Typescript时，一些参数需要加类型注解，例如设置拦截器时：
//注册axios实例
const instance = axios.create({
  baseURL: 'https://www.httpbin.org/',
  timeout: '5000'
});

//请求拦截器
instance.interceptors.request.use(
  (config: AxiosRequestConfig) => {
    console.log('请求成功拦截');
    return config;
  },
  (err: any) => {
    console.log('请求失败回调');
  }
);

所有配置项（axios官网）：

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

}
  • 注意：只有 url 是必需的。如果没有指定 method，请求将默认使用 GET 方法。

5、Axios 拦截器

我们可以使用拦截器，在应用某些场景发起网络请求时，做一些例如loading加载动画等效果。

//创建axios实例
const instance = axios.create({
  baseURL: 'https://www.httpbin.org/',
  timeout: '5000'
});
//添加请求方法
instance.request({
    url: '/get',
    method: 'GET'
  }).then((res: any) => {
    console.log(res.data);
  });

//请求拦截器
instance.interceptors.request.use(
  (config: AxiosRequestConfig) => {
    console.log('请求成功拦截');
    return config;
  },
  (err: any) => {
    console.log('请求失败回调');
  }
);
//响应拦截器
instance.interceptors.response.use(
  (config: AxiosRequestConfig) => {
    console.log('响应成功拦截');
    return config;
  },
  (err: any) => {
    console.log('响应失败回调');
  }
);
  • 我们可以在拦截器回调里写一些逻辑。

6、取消请求

某些情况我们会取消网络请求，此时可以用：

const controller = new AbortController();
axios
  .get('https://www.httpbin.org/get', {
    signal: controller.signal
  })
  .then(function (res: any) {
    console.log('请求数据，但需要取消');
  });
// 取消请求
controller.abort();
  • 以上方法在0.22.0版本以上推荐使用，因为在此官网不推荐使用CancelToken取消网络请求。

3、其他补充

来自官网的一些其他axios使用补充。

1、响应结构

一个请求的响应包含以下信息：

{
  // `data` 由服务器提供的响应
  data: {},

  // `status` 来自服务器响应的 HTTP 状态码
  status: 200,

  // `statusText` 来自服务器响应的 HTTP 状态信息
  statusText: 'OK',

  // `headers` 是服务器响应头
  // 所有的 header 名称都是小写，而且可以使用方括号语法访问
  // 例如: `response.headers['content-type']`
  headers: {},

  // `config` 是 `axios` 请求的配置信息
  config: {},

  // `request` 是生成此响应的请求
  // 在node.js中它是最后一个ClientRequest实例 (in redirects)，
  // 在浏览器中则是 XMLHttpRequest 实例
  request: {}
}

  • 其实上小节我们大量使用了then()方法获取异步请求结果，即使用then()时，可获得一些响应结果：

    axios.get('/user/12345')
  .then(function (response) {
    console.log(response.data);
    console.log(response.status);
    console.log(response.statusText);
    console.log(response.headers);
    console.log(response.config);
  });

  • 当然使用then()时，也可以传入第二个参数err以catch 错误，下一节将介绍使用错误处理。

2、错误处理

我们知道，axios请求返回值为Promise，因此我们可以用.catch()方法对请求异常进行处理。

axios.get('/user/12345')
  .catch(function (error) {
    if (error.response) {
      // 请求成功发出且服务器也响应了状态码，但状态代码超出了 2xx 的范围
      console.log(error.response.data);
      console.log(error.response.status);
      console.log(error.response.headers);
    } else if (error.request) {
      // 请求已经成功发起，但没有收到响应
      // `error.request` 在浏览器中是 XMLHttpRequest 的实例，
      // 而在node.js中是 http.ClientRequest 的实例
      console.log(error.request);
    } else {
      // 发送请求时出了点问题
      console.log('Error', error.message);
    }
    console.log(error.config);
  });

  • 当然，使用 validateStatus 配置选项，可以自定义抛出错误的 HTTP code。

    axios.get('/user/12345', {
  validateStatus: function (status) {
    return status < 500; // 处理状态码小于500的情况
  }
})

  • 使用 toJSON 可以获取更多关于HTTP错误的信息。

    axios.get('/user/12345')
  .catch(function (error) {
    console.log(error.toJSON());
  });

3、请求体编码

请参考官网：请求体编码open in new window

三、封装axios

待更新...