Vue3 Ajax(axios)

Vue empfiehlt die Verwendung von axios für Ajax-Anfragen.

Axios ist eine Promise-basierte HTTP-Bibliothek, die in Browsern und node.js verwendet werden kann.

GitHub-Open-Source-Adresse:https://github.com/axios/axios

Installationsmethoden

CDN verwenden:

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

oder

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

Mit npm:

$ npm install axios

Bower verwenden:

$ bower install axios

Yarn verwenden:

$ yarn add axios

Verwendungsmethoden

Importieren Sie das standardmäßig exportierte axios-Objekt aus dem Axios-Modul:

import axios from 'axios';

1. Eine GET-Anfrage stellen

Eine Anfrage für einen Benutzer mit einer angegebenen ID stellen:

Beispiel

axios.get('/user?ID=12345')
.then(function (response) {
// Erfolgsbehandlung
console.log(response);
})
.catch(function (error) {
// Fehlerbehandlung
console.log(error);
})
.finally(function () {
// Wird immer ausgeführt
});

Die obige Anfrage kann auch wie folgt implementiert werden:

Beispiel

axios.get('/user', {
params: {
ID: 12345
}
})
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
})
.finally(function () {
// Wird immer ausgeführt
});

Wenn Sie async/await verwenden möchten, fügen Sie das Schlüsselwort async zur äußeren Funktion/Methode hinzu.

Beispiel

async function getUser() {
try {
const response = await axios.get('/user?ID=12345');
console.log(response);
} catch (error) {
console.error(error);
}
}

Hinweis:async/await ist Teil von ECMAScript 2017 und wird im Internet Explorer und in älteren Browsern nicht unterstützt, daher mit Vorsicht verwenden.

2. Eine POST-Anfrage stellen

Beispiel

axios.post('/user', {
firstName: 'Fred',
lastName: 'Flintstone'
})
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});

Mehrere gleichzeitige Anfragen ausführen:

Beispiel

Browser-Unterstützung

GET-Methode

Wir können JSON-Daten einfach lesen:

GET-Beispiel

const app = { data() { return { info: 'Ajax Test!!' } }, mounted () { axios .get('https://www.example.com/try/ajax/json_demo.json') .then(response => (this.info = response)) .catch(function (error) { //Behandlung von Anfragefehlern console.log(error); }); } } Vue.createApp(app).mount('#app')

Selbst ausprobieren »

Verwendungresponse.dataJSON-Daten lesen:

GET-Beispiel

<div id="app"> <h1>Webseitenliste</h1> <div v-for="site in info" > {{ site.name }} </div> </div> <script type = "text/javascript">```javascript const app = { data() { return { info: 'Ajax Testing!!' } }, mounted () { axios .get('https://www.example.com/try/ajax/json_demo.json') .then(response => (this.info = response.data.sites)) .catch(function (error) { // Behandlung von Anfragefehlern console.log(error); }); } } Vue.createApp(app).mount('#app') ```</script>

Selbst ausprobieren »

Das Format zum Übergeben von Parametern in der GET-Methode ist wie folgt:

Parameterbeschreibung

//Fügen Sie den Parameter ID=12345 direkt zur URL hinzu axios.get('/user?ID=12345') .then(function (response) { console.log(response); }) .catch(function (error) { console.log(error); }); //Sie können Parameter auch über params setzen: axios.get('/user', { params: { ID: 12345 } }) .dann(function (response) { console.log(response); }) .catch(function (error) { console.log(error); });

POST-Methode

POST Beispiel

const app = { data() { return { info: null } }, mounted () { axios .post('https://www.example.com/try/ajax/demo_axios_post.php') .then(response => (this.info = response)) .catch(function (error) { //Behandlung von Anfragefehlern console.log(error); }); } } Vue.createApp(app).mount('#app')

Selbst ausprobieren »

Das Format zum Übergeben von Parametern in der POST-Methode ist wie folgt:

Parameterbeschreibung

axios.post('/user', { firstName: 'Fred', //Parameter firstName lastName: 'Flintstone' //Parameter lastName }) .dann(function (response) { console.log(response); }) .catch(function (error) { console.log(error); });

Mehrere gleichzeitige Anfragen ausführen

Beispiel

axios API

Du kannst eine Anfrage erstellen, indem du eine entsprechende Konfiguration an axios übergibst.

Beispiel

axios(config) //Sende eine POST-Anfrage axios({ method: 'post', url: '/user/12345', data: { firstName: 'Fred', lastName: 'Flintstone' } }); //GET-Anfrage an ein Remote-Bild axios({ method:'get', url:'http://bit.ly/2mTM3nY', responseType:'stream' }) .then(function(response) { response.data.pipe(fs.createWriteStream('ada_lovelace.jpg')) }); axios(url[, config]) //Sende eine GET-Anfrage (Standardmethode) axios('/user/12345');

Aliase für Anfragemethoden

Der Einfachheit halber bietet die offizielle Dokumentation Aliase für alle unterstützten Anfragemethoden, und du kannst diese Aliase direkt verwenden, um Anfragen zu stellen:

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]])

Hinweis:Bei der Verwendung von Alias-Methoden müssen die Eigenschaften url, method und data nicht in der Konfiguration angegeben werden.

Parallelität

Hilfsfunktionen für die Behandlung gleichzeitiger Anfragen:

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

Erstellen einer Instanz

Sie können eine neue axios-Instanz mit benutzerdefinierter Konfiguration erstellen:

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

Instanzmethoden

Die folgenden Instanzmethoden sind verfügbar. Die angegebene Konfiguration wird mit der Konfiguration der Instanz zusammengeführt:

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]])

Request-Konfigurationsoptionen

Die folgenden Konfigurationsoptionen sind beim Erstellen einer Anfrage verfügbar. Beachten Sie, dass nur url erforderlich ist. Wenn method nicht angegeben ist, verwendet die Anfrage standardmäßig die Methode 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 oder  reject  promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` oder  `undefined`)，promise 将被 resolve; 否则，promise 将被 rejecte
  validateStatus: function (status) {
    return status &gt;= 200 &amp;&amp; status &lt; 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) {
  })
}

Antwortstruktur

Die Antwort einer axios-Anfrage enthält die folgenden Informationen:

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

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

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

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

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

Wenn du then verwendest, erhältst du eine Antwort wie diese:

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

Bei Verwendungcatch, oder durch Übergeben vonRejection-Callbackalsthendas zweite Argument, auf die Antwort kann über die zugegriffen werdenerrorObjekt.

Standard-Konfigurationswerte

Sie können Standard-Konfigurationswerte angeben, die für jede Anfrage verwendet werden.

Globale axios-Standardwerte:

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';

Benutzerdefinierte Instanz-Standardwerte:

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

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

Prioritätsreihenfolge der Konfiguration

Die Konfiguration wird unter Einhaltung einer Prioritätsreihenfolge zusammengeführt. Die Reihenfolge ist: die Bibliotheksstandardwerte in lib/defaults.js, dann die defaults-Eigenschaft der Instanz und schließlich der config-Parameter der Anfrage. Letzterer hat Vorrang vor Ersterem. Hier ist ein Beispiel:

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

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

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

Interceptors

Fange Anfragen oder Antworten ab, bevor sie von then oder catch behandelt werden.

// 添加请求拦截器
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);
  });

Wenn Sie einen Interceptor später entfernen möchten, können Sie das so machen:

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

Sie können Interceptors zu einer benutzerdefinierten axios-Instanz hinzufügen.

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

Fehlerbehandlung:

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

Sie können die Konfigurationsoption validateStatus verwenden, um einen benutzerdefinierten Bereich von HTTP-Statuscodes zu definieren, die Fehler verursachen.

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

Abbruch

Brechen Sie Anfragen mit einem Cancel-Token ab.

Axios' Cancel-Token-API basiert aufdem Vorschlag für abbrechbare Promises

Sie können einen Cancel-Token mit der Factory-Methode CancelToken.source erstellen, so:

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.');

Sie können einen Cancel-Token auch erstellen, indem Sie eine Executor-Funktion an den CancelToken-Konstruktor übergeben:

var CancelToken = axios.CancelToken;
var cancel;

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

// 取消请求
cancel();

Hinweis: Sie können dasselbe Cancel-Token verwenden, um mehrere Anfragen abzubrechen.

Verwendung von application/x-www-form-urlencoded in Anfragen

axios serialisiert JavaScript-Objekte standardmäßig in JSON. Wenn Sie das Format application/x-www-form-urlencoded verwenden möchten, können Sie die folgende Konfiguration verwenden.

Browser

In einer Browserumgebung können Sie die URLSearchParams-API verwenden:

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

URLSearchParams wird nicht von allen Browsern unterstützt.

Darüber hinaus können Sie die qs-Bibliothek verwenden, um die Daten zu kodieren:

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

Node.js-Umgebung

In Node.js können Sie das querystring-Modul verwenden:

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

Natürlich können Sie, wie im Browser, auch die qs-Bibliothek verwenden.

Promises

axios hängt von der nativen ES6-Promise-Implementierung ab, umunterstützt zu werden.。

Wenn Ihre Umgebung ES6 Promise nicht unterstützt, können SiePolyfill verwenden。

TypeScript-Unterstützung

axios enthält TypeScript-Definitionen.

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

Andere Erweiterungen

Referenzhandbuch

Praktischer Fall 1

Praxisbeispiel 2

Vue3 Ajax(axios)

Installationsmethoden

Verwendungsmethoden

Beispiel

Beispiel

Beispiel

Beispiel

Beispiel

Browser-Unterstützung

GET-Methode

GET-Beispiel

GET-Beispiel

Parameterbeschreibung

POST-Methode

POST Beispiel

Parameterbeschreibung

Mehrere gleichzeitige Anfragen ausführen

Beispiel

axios API

Beispiel

Aliase für Anfragemethoden

Parallelität

Erstellen einer Instanz

Instanzmethoden

Request-Konfigurationsoptionen

Antwortstruktur

Standard-Konfigurationswerte

Prioritätsreihenfolge der Konfiguration

Interceptors

Abbruch

Verwendung von application/x-www-form-urlencoded in Anfragen

Node.js-Umgebung

Promises

TypeScript-Unterstützung