Vue js 中使用 Axios 进行 AJAX 请求（五）

在现代前端开发中，AJAX 请求是必不可少的一部分。Vue.js 2.0 推荐使用 Axios 来完成 AJAX 请求。Axios 是一个基于 Promise 的 HTTP 库，可以在浏览器和 Node.js 中使用。本文将详细介绍如何在 Vue.js 中使用 Axios 进行 GET 和 POST 请求，以及如何处理多个并发请求和配置 Axios 实例。

安装 Axios

使用 CDN

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

或

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

使用 npm

npm install axios

使用 Bower

bower install axios

使用 Yarn

yarn add axios

浏览器支持

Axios 支持所有现代浏览器，包括 IE8 及以上版本。

GET 请求

简单的 GET 请求

我们可以使用 Axios 轻松地读取 JSON 数据。以下是一个简单的示例：

<div id="app">

<h1>网站列表</h1>
  <div v-for="site in info">{{ site.name }}</div>
</div>

<script type="text/javascript">
  new Vue({
    el: '#app',
    data() {
      return {
        info: null
      }
    },
    mounted() {
      axios.get('https://www.runoob.com/try/ajax/json_demo.json')
        .then(response => (this.info = response.data.sites))
        .catch(error => console.log(error));
    }
  });
</script>

传递参数

GET 请求可以通过 URL 直接传递参数，也可以通过 params 对象传递参数：

// 直接在 URL 上添加参数
axios.get('/user?ID=12345')
  .then(response => console.log(response))
  .catch(error => console.log(error));

// 通过 params 对象传递参数
axios.get('/user', {
  params: {
    ID: 12345
  }
})
.then(response => console.log(response))
.catch(error => console.log(error));

POST 请求

简单的 POST 请求

以下是一个简单的 POST 请求示例：

<div id="app">

<h1>提交表单</h1>

<p>{{ info }}</p>
</div>

<script type="text/javascript">
  new Vue({
    el: '#app',
    data() {
      return {
        info: null
      }
    },
    mounted() {
      axios.post('https://www.runoob.com/try/ajax/demo_axios_post.php')
        .then(response => (this.info = response.data))
        .catch(error => console.log(error));
    }
  });
</script>

传递参数

POST 请求可以通过 data 对象传递参数：

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

执行多个并发请求

有时我们需要同时发送多个请求并处理它们的结果。Axios 提供了 axios.all 和 axios.spread 方法来帮助我们实现这一点：

function getUserAccount() {
  return axios.get('/user/12345');
}

function getUserPermissions() {
  return axios.get('/user/12345/permissions');
}

axios.all([getUserAccount(), getUserPermissions()])
  .then(axios.spread((acct, perms) => {
    // 两个请求现在都执行完成
  }));

Axios API

创建请求

可以通过向 axios 传递相关配置来创建请求：

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

// GET 请求远程图片
axios({
  method: 'get',
  url: 'https://static.jyshare.com/images/runoob-logo.png',
  responseType: 'stream'
}).then(response => {
  response.data.pipe(fs.createWriteStream('ada_lovelace.jpg'));
});

// 发送 GET 请求（默认的方法）
axios('/user/12345');

请求方法的别名

为了方便使用，Axios 为所有支持的请求方法提供了别名：

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

并发处理

处理并发请求的助手函数：

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

创建实例

可以使用自定义配置新建一个 Axios 实例：

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

实例方法

以下是可用的实例方法。指定的配置将与实例的配置合并：

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

请求配置项

以下是创建请求时可用的配置选项，注意只有 url 是必需的。如果没有指定 method，请求将默认使用 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` 序列化的函数
  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 或 reject  promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `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) {
  })
}

响应结构

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

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

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

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

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

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

使用 then 时，会接收下面这样的响应：

axios.get("/user/12345")
  .then(function (response) {
    console.log(response.data);
  })
  .catch(function (error) {
    console.log(error);
  });

总结

通过本文，我们详细介绍了如何在 Vue.js 中使用 Axios 进行 AJAX 请求。从安装 Axios 到发送 GET 和 POST 请求，再到处理多个并发请求和配置 Axios 实例，希望这些内容能帮助你在项目中更好地使用 Axios。如果你有任何问题或建议，欢迎留言交流！