Vue.js Ajax(axios)

Vue.js 2.0 recomienda usar axios para realizar solicitudes ajax.

Axios es una librería HTTP basada en Promise que se puede usar en el navegador y en node.js.

Dirección de código abierto en Github:https://github.com/axios/axios

Método de instalación

Usar CDN:

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

o

<script src="https://cdn.staticfile.org/axios/0.18.0/axios.min.js"></script>

Usar npm:

$ npm install axios

Usar bower:

$ bower install axios

Usar yarn:

$ yarn add axios

Compatibilidad con navegadores

---

Método GET

Podemos leer datos JSON fácilmente:

Usoresponse.dataLeer datos JSON:

El formato para pasar parámetros con el método GET es el siguiente:

---

Método POST

El formato para pasar parámetros con el método POST es el siguiente:

---

Ejecutar múltiples solicitudes concurrentes

---

axios API

Puedes crear solicitudes pasando la configuración correspondiente a axios.

Alias de los métodos de solicitud

Para mayor comodidad, el equipo oficial proporciona alias para todos los métodos de solicitud compatibles. Puedes usar estos alias directamente para realizar solicitudes:

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

Nota:Al usar los métodos de alias, no es necesario especificar las propiedades url, method y data en la configuración.

Concurrencia

Funciones auxiliares para manejar solicitudes concurrentes:

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

Crear una instancia

Puedes crear una nueva instancia de axios con configuración personalizada:

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

Métodos de instancia

A continuación se muestran los métodos de instancia disponibles. La configuración especificada se fusionará con la configuración de la instancia:

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

Opciones de configuración de la solicitud

A continuación se muestran las opciones de configuración disponibles al crear solicitudes. Ten en cuenta que solo url es obligatoria. Si no se especifica method, la solicitud usará get por defecto.

{
  // `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, https://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 o  reject  promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` o  `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) {
  })
}

Estructura de la respuesta

La respuesta de una solicitud axios contiene la siguiente información:

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

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

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

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

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

Al usar then, recibirás una respuesta como la siguiente:

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

Al usar catch,catcho al pasar rejectrejection callbackcomothensegundo parámetro de then, la respuesta puede sererrorutilizada a través del objeto error.

Valores predeterminados de configuración

Puedes especificar valores predeterminados de configuración que se usarán en las distintas solicitudes.

Valores predeterminados globales de 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';

Valores predeterminados de instancia personalizada:

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

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

Orden de prioridad de configuración

La configuración se fusiona según un orden de prioridad. El orden es: los valores predeterminados de la librería que se encuentran en lib/defaults.js, luego la propiedad defaults de la instancia y, por último, el parámetro config de la solicitud. Este último tiene prioridad sobre los anteriores. Aquí tienes un ejemplo:

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

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

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

Interceptores

Intercepta las solicitudes o respuestas antes de que sean manejadas por then o 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 quieres eliminar el interceptor más tarde, puedes hacerlo así:

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

Puedes agregar interceptores a una instancia personalizada de axios.

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

Manejo de errores:

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

Puedes usar la opción de configuración validateStatus para definir un rango de error personalizado para códigos de estado HTTP.

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

Cancelación

Cancela solicitudes usando un cancel token.

La API de cancel token de Axios se basa encancelable promises proposal

Puedes usar el método de fábrica CancelToken.source para crear un cancel token, así:

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

También puedes crear un cancel token pasando una función executor al constructor de CancelToken:

var CancelToken = axios.CancelToken;
var cancel;

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

// 取消请求
cancel();

Nota: Puedes cancelar múltiples solicitudes usando el mismo cancel token.

Usar application/x-www-form-urlencoded en las solicitudes

Axios serializa de forma predeterminada los objetos de JavaScript como JSON. Si quieres usar el formato application/x-www-form-urlencoded, puedes usar la siguiente configuración.

Navegador

En el entorno del navegador, puedes usar la API URLSearchParams:

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

URLSearchParams no es compatible con todos los navegadores.

Además, puedes usar la librería qs para codificar los datos:

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

Entorno Node.js

En node.js, puedes usar el módulo querystring:

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

Por supuesto, al igual que en el navegador, también puedes usar la librería qs.

Promises

Axios depende de la implementación nativa de ES6 Promise, por lo quees compatible.。

Si tu entorno no es compatible con ES6 Promise, puedes usarpolyfill。

Soporte de TypeScript

Axios incluye las definiciones de TypeScript.

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

Otras extensiones