Vue 网络请求框架 axios 使用教程

前期回顾

1. Vue 学习入门指南

2. Vue 入门环境搭建

3. Visual Studio Code 使用指南

axios 是一个基于Promise 用于浏览器和 nodejs 的 HTTP 客户端，网络请求框架。

支持的浏览器：

1、安装axios

1.打开vs code ，导入咱们以前建立好的vue项目 helloword ，打开终端，敲入下面的安装命令：

$ npm install axios --save

   2.安装完成后，你就好在package.json --》dependencies 里面看到咱们加入的网络请求库：axios ，这里简单介绍一下 dependencies ，相似于android 的Gradle ，添加依赖库，因此的依赖库均会在这里

2、axios 使用

1.找到要加入如网络请求的界面，这里以App.vue 做为例子2.加入一个按钮做为事件点击

<button v-on:click="clickTest">获取 干货集中营 数据</button>

    3.导入axios

import axios from 'axios'

    4.编写事件，因为咱们的事件方法名字叫：clickTest，因此咱们须要在methods里面新增一个clickTest方法，来处理网络请求事件,这里咱们拿干货集中营里面的api来作测试

接口地址：https://gank.io/api/v2/banners

//按钮点击测试    clickTest() {      axios        .get("https://gank.io/api/v2/banners")        .then(function (response) {          console.log(response.data);          console.log(response.status);          console.log(response.statusText);          console.log(response.headers);          console.log(response.config);        })        .catch(function (error) {          console.log(error);        });    },

5. 执行终端命令，访问地址：http://localhost:8080/ 点击按钮事件，测试咱们的代码是否正确，效果如图，咱们把网络请求数据已经输出到控制台了

npm run serve

3、API 指南

1. GET 请求

// 直接在 URL 上添加参数 ID=12345axios.get('/user?ID=12345')  .then(function (response) {    console.log(response.data);    console.log(response.status);    console.log(response.statusText);    console.log(response.headers);    console.log(response.config);  })  .catch(function (error) {    console.log(error);  });
// 也能够经过 params 设置参数：axios.get('/user', {    params: {      ID: 12345    }  })  .then(function (response) {    console.log(response);  })  .catch(function (error) {    console.log(error);  });

2. POST 请求

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

3. 执行并发请

function getUserAccount() {  return axios.get('/user/12345');}
function getUserPermissions() {  return axios.get('/user/12345/permissions');}axios.all([getUserAccount(), getUserPermissions()])  .then(axios.spread(function (acct, perms) {    // 两个请求如今都执行完成  }));

4. 配置拦截器，用于拦截请求

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

5. 请求配置项全部参数

下面是对应的参数，咱们须要变动那个，只须要修改对应的值便可，没修改，系统会执行默认值

{  // `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 或 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) {  })}

6. 配置基础地址(baseURL)

这次只配置了几个经常使用的参数，如baseUrl，请求超时限制、Content-Type等，若有用到其余参数，请参考第五条--》请求配置项全部参数

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

官方文档：https://github.com/axios/axios