Vue3 : Ajax(axios)

Vue recommande d'utiliser axios pour les requêtes ajax.

Axios est une bibliothèque HTTP basée sur les promesses qui peut être utilisée dans les navigateurs et node.js.

Adresse open source GitHub :https://github.com/axios/axios

Méthodes d'installation

Utilisation du CDN :

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

ou

<script src="https://lf26-cdn-tos.bytecdntp.com/cdn/expire-1-M/axios/0.26.0/axios.min.js" type="application/javascript"></script>

Avec npm :

$ npm install axios

Utilisation de Bower :

$ bower install axios

Utilisation de Yarn :

$ yarn add axios

Méthodes d'utilisation

Importez l'objet axios exporté par défaut depuis le module Axios :

import axios from 'axios';

1. Effectuer une requête GET

Effectuer une requête pour un utilisateur avec un ID donné :

La requête ci-dessus peut également être implémentée comme ceci :

Si vous souhaitez utiliser async/await, ajoutez le mot-clé async à la fonction/méthode externe.

Remarque :async/await fait partie d'ECMAScript 2017 et n'est pas pris en charge dans Internet Explorer et les navigateurs plus anciens, donc utilisez-le avec prudence.

2. Effectuer une requête POST

Exécution de plusieurs requêtes simultanées :

Prise en charge des navigateurs

Méthode GET

Nous pouvons simplement lire les données JSON :

Utilisationresponse.dataLire les données JSON :

Le format de passage des paramètres dans la méthode GET est le suivant :

Méthode POST

Le format de passage des paramètres dans la méthode POST est le suivant :

Exécution de plusieurs requêtes simultanées

API axios

Vous pouvez créer une requête en transmettant une configuration appropriée à axios.

Alias pour les méthodes de requête

Pour plus de commodité, la documentation officielle fournit des alias pour toutes les méthodes de requête prises en charge, et vous pouvez utiliser ces alias directement pour effectuer des requêtes :

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

Remarque :Lorsque vous utilisez des méthodes alias, les propriétés url, method et data n'ont pas besoin d'être spécifiées dans la configuration.

Concurrence

Fonctions utilitaires pour gérer les requêtes concurrentes :

axios.all(iterable)
axios.spread(callback)

Création d'une instance

Vous pouvez créer une nouvelle instance axios avec une configuration personnalisée :

axios.create([config])
const instance = axios.create({
  baseURL: 'https://some-domain.com/api/',
  timeout: 1000,
  headers: {'X-Custom-Header': 'foobar'}
});

Méthodes d'instance

Les méthodes d'instance suivantes sont disponibles. La configuration spécifiée sera fusionnée avec la configuration de l'instance :

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

Options de configuration de requête

Voici les options de configuration disponibles lors de la création d'une requête. Notez que seul url est requis. Si method n'est pas spécifié, la requête utilisera par défaut la méthode get.

{
  // `url` 是用于请求的服务器 URL
  url: "/user",

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

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

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

    return data;
  }],

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

    return data;
  }],

  // `headers` 是即将被发送的自定义请求头
  headers: {"X-Requested-With": "XMLHttpRequest"},

  // `params` 是即将与请求一起发送的 URL 参数
  // 必须是一个无格式对象(plain object)或 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", 和 "PATCH"
  // 在没有设置 `transformRequest` 时，必须是以下类型之一：
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - 浏览器专属：FormData, File, Blob
  // - Node 专属： Stream
  data: {
    firstName: "Fred"
  },

  // `timeout` 指定请求超时的毫秒数(0 表示无超时时间)
  // 如果请求花费了超过 `timeout` 的时间，请求将被中断
  timeout: 1000,

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

  // `adapter` 允许自定义处理请求，以使测试更轻松
  // 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
  adapter: function (config) {
    /* ... */
  },

  // `auth` 表示应该使用 HTTP 基础验证，并提供凭据
  // 这将设置一个 `Authorization` 头，覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
  auth: {
    username: "janedoe",
    password: "s00pers3cret"
  },

  // `responseType` 表示服务器响应的数据类型，可以是 "arraybuffer", "blob", "document", "json", "text", "stream"
  responseType: "json", // 默认的

  // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
  xsrfCookieName: "XSRF-TOKEN", // default

  // `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称
  xsrfHeaderName: "X-XSRF-TOKEN", // 默认的

  // `onUploadProgress` 允许为上传处理进度事件
  onUploadProgress: function (progressEvent) {
    // 对原生进度事件的处理
  },

  // `onDownloadProgress` 允许为下载处理进度事件
  onDownloadProgress: function (progressEvent) {
    // 对原生进度事件的处理
  },

  // `maxContentLength` 定义允许的响应内容的最大尺寸
  maxContentLength: 2000,

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

  // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
  // 如果设置为0，将不会 follow 任何重定向
  maxRedirects: 5, // 默认的

  // `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项：
  // `keepAlive` 默认没有启用
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),

  // "proxy" 定义代理服务器的主机名称和端口
  // `auth` 表示 HTTP 基础验证应当用于连接代理，并提供凭据
  // 这将会设置一个 `Proxy-Authorization` 头，覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
  proxy: {
    host: "127.0.0.1",
    port: 9000,
    auth: : {
      username: "mikeymike",
      password: "rapunz3l"
    }
  },

  // `cancelToken` 指定用于取消请求的 cancel token
  // （查看后面的 Cancellation 这节了解更多）
  cancelToken: new CancelToken(function (cancel) {
  })
}

Structure de la réponse

La réponse d'une requête axios contient les informations suivantes :

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

  // `status`  HTTP 状态码
  status: 200,

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

  // `headers` 服务器响应的头
  headers: {},

  // `config` 是为请求提供的配置信息
  config: {}
}

Lorsque vous utilisez then, vous recevrez une réponse comme ceci :

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);
  });

Lors de l'utilisationcatch, ou en passantcallback de rejetcommethenle deuxième argument, la réponse est accessible via leerrorobjet.

Valeurs de configuration par défaut

Vous pouvez spécifier des valeurs de configuration par défaut qui seront utilisées pour chaque requête.

Valeurs par défaut globales d'axios :

axios.defaults.baseURL = 'https://api.example.com';
axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

Valeurs par défaut d'instance personnalisée :

// 创建实例时设置配置的默认值
var instance = axios.create({
  baseURL: 'https://api.example.com'
});

// 在实例已创建后修改默认值
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

Ordre de priorité de la configuration

La configuration sera fusionnée selon un ordre de priorité. L'ordre est le suivant : les valeurs par défaut de la bibliothèque définies dans lib/defaults.js, puis la propriété defaults de l'instance, et enfin le paramètre config de la requête. Ce dernier est prioritaire sur le précédent. Voici un exemple :

// 使用由库提供的配置的默认值来创建实例
// 此时超时配置的默认值是 `0`
var instance = axios.create();

// 覆写库的超时默认值
// 现在，在超时前，所有请求都会等待 2.5 秒
instance.defaults.timeout = 2500;

// 为已知需要花费很长时间的请求覆写超时设置
instance.get('/longRequest', {
  timeout: 5000
});

Intercepteurs

Interceptez les requêtes ou les réponses avant qu'elles ne soient traitées par then ou catch.

// 添加请求拦截器
axios.interceptors.request.use(function (config) {
    // 在发送请求之前做些什么
    return config;
  }, function (error) {
    // 对请求错误做些什么
    return Promise.reject(error);
  });

// 添加响应拦截器
axios.interceptors.response.use(function (response) {
    // 对响应数据做点什么
    return response;
  }, function (error) {
    // 对响应错误做点什么
    return Promise.reject(error);
  });

Si vous souhaitez supprimer un intercepteur plus tard, vous pouvez procéder comme ceci :

var myInterceptor = axios.interceptors.request.use(function () {/*...*/});
axios.interceptors.request.eject(myInterceptor);

Vous pouvez ajouter des intercepteurs à une instance axios personnalisée.

var instance = axios.create();
instance.interceptors.request.use(function () {/*...*/});

Gestion des erreurs :

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 {
      // Something happened in setting up the request that triggered an Error
      console.log('Error', error.message);
    }
    console.log(error.config);
  });

Vous pouvez utiliser l'option de configuration validateStatus pour définir une plage personnalisée de codes de statut HTTP qui provoquent des erreurs.

axios.get('/user/12345', {
  validateStatus: function (status) {
    return status < 500; // 状态码在大于或等于500时才会 reject
  }
})

Annulation

Annuler des requêtes à l'aide d'un jeton d'annulation.

L'API de jeton d'annulation d'Axios est basée surla proposition de promesses annulables

Vous pouvez créer un jeton d'annulation à l'aide de la méthode de fabrique CancelToken.source, comme ceci :

var CancelToken = axios.CancelToken;
var source = CancelToken.source();

axios.get('/user/12345', {
  cancelToken: source.token
}).catch(function(thrown) {
  if (axios.isCancel(thrown)) {
    console.log('Request canceled', thrown.message);
  } else {
    // 处理错误
  }
});

// 取消请求（message 参数是可选的）
source.cancel('Operation canceled by the user.');

Vous pouvez également créer un jeton d'annulation en passant une fonction exécutrice au constructeur CancelToken :

var CancelToken = axios.CancelToken;
var cancel;

axios.get('/user/12345', {
  cancelToken: new CancelToken(function executor(c) {
    // executor 函数接收一个 cancel 函数作为参数
    cancel = c;
  })
});

// 取消请求
cancel();

Remarque: Vous pouvez utiliser le même jeton d'annulation pour annuler plusieurs requêtes.

Utilisation d'application/x-www-form-urlencoded dans les requêtes

axios sérialise les objets JavaScript en JSON par défaut. Si vous souhaitez utiliser le format application/x-www-form-urlencoded, vous pouvez utiliser la configuration suivante.

Navigateur

Dans un environnement de navigateur, vous pouvez utiliser l'API URLSearchParams :

const params = new URLSearchParams();
params.append('param1', 'value1');
params.append('param2', 'value2');
axios.post('/foo', params);

URLSearchParams n'est pas pris en charge par tous les navigateurs.

De plus, vous pouvez utiliser la bibliothèque qs pour encoder les données :

const qs = require('qs');
axios.post('/foo', qs.stringify({ 'bar': 123 }));

// Or in another way (ES6),

import qs from 'qs';
const data = { 'bar': 123 };
const options = {
  method: 'POST',
  headers: { 'content-type': 'application/x-www-form-urlencoded' },
  data: qs.stringify(data),
  url,
};
axios(options);

Environnement Node.js

Dans Node.js, vous pouvez utiliser le module querystring :

const querystring = require('querystring');
axios.post('http://something.com/', querystring.stringify({ foo: 'bar' }));

Bien sûr, comme dans le navigateur, vous pouvez également utiliser la bibliothèque qs.

Promesses

axios dépend de l’implémentation native de Promise ES6 pourêtre pris en charge.。

Si votre environnement ne prend pas en charge ES6 Promise, vous pouvez utiliser unpolyfill。

Prise en charge de TypeScript

axios inclut les définitions TypeScript.

import axios from "axios";
axios.get("/user?ID=12345");