axios学习

axios#

Axios 是什么#

Axios 是一个基于 promise 的网络请求库，可以用于浏览器和 node.js

Axios 使用简单，包尺寸小且提供了易于扩展的接口。

使用 axios 直接使用 url 发送请求#

后端需配置可跨域，前端无需设置跨域

使用 axios 发送无参数 get 请求#

<template>
    <div>
        111
    </div>
</template>
<script>
import axios from 'axios'
axios({
    url: "http://127.0.0.1:5000/keynav/on_categorys/19",
    method: "get",
}).then(res => {
    console.log(res);
})
export default {}
</script>

上面的代码，完成之后，打开 f12，然后查看控制台即可看到结果

使用 axios 发送有参数 get 请求#

<template>
    <div>
        111
    </div>
</template>
<script>
import axios from 'axios'
axios({
    url: "http://127.0.0.1:5000/keynav/on_categorys",
    method: "get",
    params: {
        id： "1"
    }
}).then(res => {
    console.log(res);
})
export default {}
</script>

使用 axios 发送无参数 post 请求#

<template>
    <div>
        111
    </div>
</template>
<script>
import axios from 'axios'
axios({
    url: "http://127.0.0.1:5000/keynav/on_categorys/19",
    method: "post",
}).then(res => {
    console.log(res);
})
export default {}
</script>

使用 axios 发送有参数 post 请求#

<template>
    <div>
        111
    </div>
</template>
<script>
import axios from 'axios'
axios({
    url: "http://127.0.0.1:5000/keynav/on_categorys",
    method: "post",
    params: {
        id： "1"
    }
}).then(res => {
    console.log(res);
})
export default {}
</script>

使用 axios 处理并发请求#

并发请求（返回结果是数组）#

<template>
    <div>
        111
    </div>
</template>
<script>
import axios from 'axios'
axios.all([
    axios.get("http://127.0.0.1:5000/keynav/category"),
    axios.get("http://127.0.0.1:5000/keynav/on_categorys", { params: { id: 19 } }),
]).then(res => {
    console.log(res);
}).catch(err => {
    console.log(err);
})
export default {}
</script>

使用 spread 方法处理响应数组结果（把数组的每一个元素变成一个对象）#

<template>
    <div>
        111
    </div>
</template>
<script>
import axios from 'axios'
axios.all([
    axios.get("http://127.0.0.1:5000/keynav/category"),
    axios.get("http://127.0.0.1:5000/keynav/on_categorys", { params: { id: 19 } }),
]).then(
    axios.spread((res1, res2) => {
        console.log(res1);
        console.log(res2);
    })
).catch(err => {
    console.log(err);
})
export default {}
</script>

全局配置#

<template>
    <div>
        111
    </div>
</template>
<script>
import axios from 'axios'
axios.defaults.baseURL = 'http://127.0.0.1:5000/keynav'
axios.defaults.timeout = 5000;
axios.get("/on_categorys", { params: { id: 19 } }).then(res => {
    console.log(res);
});
axios.post("/category").then(res => {
    console.log(res);
}).catch(err => {
    console.log(err);
});
export default {}
</script>

请求配置#

这些是创建请求时可以用的配置选项。只有 url 是必需的。如果没有指定 method，请求将默认使用 GET 方法。

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

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

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

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

    return data;
  }],

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

    return data;
  }],

  // 自定义请求头
  headers: {'X-Requested-With': 'XMLHttpRequest'},

  // `params` 是与请求一起发送的 URL 参数
  // 必须是一个简单对象或 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', 'DELETE 和 'PATCH' 请求方法
  // 在没有设置 `transformRequest` 时，则必须是以下类型之一:
  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
  // - 浏览器专属: FormData, File, Blob
  // - Node 专属: Stream, Buffer
  data: {
    firstName: 'Fred'
  },
  
  // 发送请求体数据的可选语法
  // 请求方式 post
  // 只有 value 会被发送，key 则不会
  data: 'Country=Brasil&City=Belo Horizonte',

  // `timeout` 指定请求超时的毫秒数。
  // 如果请求时间超过 `timeout` 的值，则请求会被中断
  timeout: 1000, // 默认值是 `0` (永不超时)

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

  // `adapter` 允许自定义处理请求，这使测试更加容易。
  // 返回一个 promise 并提供一个有效的响应 （参见 lib/adapters/README.md）。
  adapter: function (config) {
    /* ... */
  },

  // `auth` HTTP Basic Auth
  auth: {
    username: 'janedoe',
    password: 's00pers3cret'
  },

  // `responseType` 表示浏览器将要响应的数据类型
  // 选项包括: 'arraybuffer', 'document', 'json', 'text', 'stream'
  // 浏览器专属：'blob'
  responseType: 'json', // 默认值

  // `responseEncoding` 表示用于解码响应的编码 (Node.js 专属)
  // 注意：忽略 `responseType` 的值为 'stream'，或者是客户端请求
  // Note: Ignored for `responseType` of 'stream' or client-side requests
  responseEncoding: 'utf8', // 默认值

  // `xsrfCookieName` 是 xsrf token 的值，被用作 cookie 的名称
  xsrfCookieName: 'XSRF-TOKEN', // 默认值

  // `xsrfHeaderName` 是带有 xsrf token 值的http 请求头名称
  xsrfHeaderName: 'X-XSRF-TOKEN', // 默认值

  // `onUploadProgress` 允许为上传处理进度事件
  // 浏览器专属
  onUploadProgress: function (progressEvent) {
    // 处理原生进度事件
  },

  // `onDownloadProgress` 允许为下载处理进度事件
  // 浏览器专属
  onDownloadProgress: function (progressEvent) {
    // 处理原生进度事件
  },

  // `maxContentLength` 定义了node.js中允许的HTTP响应内容的最大字节数
  maxContentLength: 2000,

  // `maxBodyLength`（仅Node）定义允许的http请求内容的最大字节数
  maxBodyLength: 2000,

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

  // `maxRedirects` 定义了在node.js中要遵循的最大重定向数。
  // 如果设置为0，则不会进行重定向
  maxRedirects: 5, // 默认值

  // `socketPath` 定义了在node.js中使用的UNIX套接字。
  // e.g. '/var/run/docker.sock' 发送请求到 docker 守护进程。
  // 只能指定 `socketPath` 或 `proxy` 。
  // 若都指定，这使用 `socketPath` 。
  socketPath: null, // default

  // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http
  // and https requests, respectively, in node.js. This allows options to be added like
  // `keepAlive` that are not enabled by default.
  httpAgent: new http.Agent({ keepAlive: true }),
  httpsAgent: new https.Agent({ keepAlive: true }),

  // `proxy` 定义了代理服务器的主机名，端口和协议。
  // 您可以使用常规的`http_proxy` 和 `https_proxy` 环境变量。
  // 使用 `false` 可以禁用代理功能，同时环境变量也会被忽略。
  // `auth`表示应使用HTTP Basic auth连接到代理，并且提供凭据。
  // 这将设置一个 `Proxy-Authorization` 请求头，它会覆盖 `headers` 中已存在的自定义 `Proxy-Authorization` 请求头。
  // 如果代理服务器使用 HTTPS，则必须设置 protocol 为`https`
  proxy: {
    protocol: 'https',
    host: '127.0.0.1',
    port: 9000,
    auth: {
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  },

  // see https://axios-http.com/zh/docs/cancellation
  cancelToken: new CancelToken(function (cancel) {
  }),

  // `decompress` indicates whether or not the response body should be decompressed 
  // automatically. If set to `true` will also remove the 'content-encoding' header 
  // from the responses objects of all decompressed responses
  // - Node only (XHR cannot turn off decompression)
  decompress: true // 默认值

}

axios 实例#

<template>
    <div>
        111
    </div>
</template>
<script>
import axios from 'axios'
let newVar1 = axios.create({
    baseURL: "http://127.0.0.1:5000/keynav",
    timeout: 5000
}); //创建一个axios实例
newVar1({
    url: "/on_categorys",
    params: {
        id: 19
    }
}).then((res) => {
    console.log(res);
}).catch((res) => {
    console.log(res);
});
let newVar2 = axios.create({
    baseURL: "http://127.0.0.1:5000/keynav",
    timeout: 5000
}); //创建一个axios实例
newVar2({
    url: "/category"
}).then((res) => {
    console.log(res);
}).catch((res) => {
    console.log(res);
});
export default {}
</script>

axios 拦截器#

axios 给我们提供了两大类拦截器一种是请求方向的拦截（成功请求，失败的）
另一种是响应方向的（成功的，失败的）

拦载器的作用，用于我们在网络请求的时候在发起请求或者响应时对操作进行可响应的外理
发起请求时可以添加网页加载的动画强制登录
可应的时候口以进行相应的数据外理

请求方向的

<template>
    <div>
        111
    </div>
</template>
<script>
import axios from 'axios'
axios.interceptors.request.use(config => {
    console.log("进入请求拦截器");
    console.log(config);
    return config;
}, err => {
    console.log("请求方向失败");
    console.log(err);
});

axios.get("http://127.0.0.1:5000/keynav/on_categorys?id=19").then(res => {
    console.log(res);
})
export default {}
</script>

响应方向的

<template>
    <div>
        111
    </div>
</template>
<script>
import axios from 'axios'
axios.interceptors.response.use(config => {
    console.log("进入响应拦截器");
    return config; //放行请求，若没有return这个语句，则不会执行语句外下面的axios.get()
    // return config.data;
}, err => {
    console.log("响应方向失败");
    console.log(err);
});

axios.get("http://127.0.0.1:5000/keynav/on_categorys?id=19").then(res => {
    console.log(res);
})
export default {}
</script>

axios 在 vue 中的模块封装#

方式一：封装者处理，调用者请求#

创建一个与网络请求相关的部分

创建一个文件夹 network，里面创建一个用来存放请求的文件夹 request，里面创建一个 axios 的请求函数文件 request.js，里面内容需要先导入 axios 模块，然后把函数暴露出去：

封装者位置：src/network/request/request.js

//封装者位置
import axios from 'axios'
export function request(config) {
    axios({
        url: config
    }).then(res => {
        console.log(res);
    })
}

然后在 main.js 中引入封装好的请求文件

调用者位置：src/main.js

import Vue from 'vue'
import ElementUI from 'element-ui';
import 'element-ui/lib/theme-chalk/index.css';
import App from './App.vue'
import axios from 'axios'

Vue.use(ElementUI);
Vue.prototype.axios = axios;
Vue.config.productionTip = false;

new Vue({
    render: h => h(App),
}).$mount('#app');

//引入封装好的请求文件
//调用者位置
import { request } from './network/request/request'
request("http://127.0.0.1:5000/keynav/on_categorys?id=19")

参数补全版

//封装者位置
import axios from 'axios'
export function request(config, success, fail) { //参数：请求结果、成功、失败
    axios({
        url: config
    }).then(res => {
        success(res);
    }).catch(err => {
        fail(err);
    })
}

import Vue from 'vue'
import ElementUI from 'element-ui';
import 'element-ui/lib/theme-chalk/index.css';
import App from './App.vue'
import axios from 'axios'

Vue.use(ElementUI);
Vue.prototype.axios = axios;
Vue.config.productionTip = false;

new Vue({
    render: h => h(App),
}).$mount('#app');

//引入封装好的请求文件
//调用者位置
import { request } from './network/request/request'
request("http://127.0.0.1:5000/keynav/on_categorys?id=19", res => {
    console.log(res);
}), err => {
    console.log(err);
}

方式二：封装者请求，调用者处理#

在模块里进行请求，把请求的信息交给调用者去处理

//封装者位置
import axios from 'axios'
export function request(config) { //参数：请求结果
    axios.defaults.baseURL = "http://127.0.0.1:5000/keynav";
    axios(config.url, { params: config.params }).then(res => {
        config.success(res);
    }).catch(err => {
        config.fail(err);
    })
}

import Vue from 'vue'
import ElementUI from 'element-ui';
import 'element-ui/lib/theme-chalk/index.css';
import App from './App.vue'
import axios from 'axios'

Vue.use(ElementUI);
Vue.prototype.axios = axios;
Vue.config.productionTip = false;

new Vue({
    render: h => h(App),
}).$mount('#app');

//引入封装好的请求文件
//调用者位置
import { request } from './network/request/request'
request({
    url: '/on_categorys',
    params: {
        id: 19
    },
    success: res => {
        console.log(res);
    },
    fail: err => {
        console.log(err);
    }
})

方式三：封装者返回对象，调用者处理(推荐使用)#

封装者返回 Promise 对象，调用者使用 then 和 catch 方法处理响应结果或错误信息。

//封装者位置
import axios from 'axios'
export function request(config) { //参数：请求结果
    return new Promise((resolve, reject) => {
        let newVar = axios.create({
            baseURL: "http://127.0.0.1:5000/keynav",
            timeout: 5000
        });
        newVar(config).then(res => {
            resolve(res);
        }).catch(err => {
            reject(err);
        })
    })
}

import Vue from 'vue'
import ElementUI from 'element-ui';
import 'element-ui/lib/theme-chalk/index.css';
import App from './App.vue'
import axios from 'axios'

Vue.use(ElementUI);
Vue.prototype.axios = axios;
Vue.config.productionTip = false;

new Vue({
    render: h => h(App),
}).$mount('#app');

//引入封装好的请求文件
//调用者位置
import { request } from './network/request/request'
request({
    url: '/on_categorys',
    params: {
        id: 19
    },
}).then(res => {
    console.log(res);
}).catch(err => {
    console.log(err);
});

方式四：封装者请求创建实例并返回 Promise 对象，调用者处理(推荐使用)#

通过封装者封装的 request 函数进行请求，使用 axios.create 方法创建实例，并返回 Promise 对象（封装者位置中的 return newVar(config); 是返回 Promise 对象的语句。）

调用者使用 Promise 的 then 和 catch 方法处理响应结果或错误信息。

//封装者位置
import axios from 'axios'
export function request(config) { //参数：请求结果
    let newVar = axios.create({
        baseURL: "http://127.0.0.1:5000/keynav",
        timeout: 5000
    });
    return newVar(config);
}

import Vue from 'vue'
import ElementUI from 'element-ui';
import 'element-ui/lib/theme-chalk/index.css';
import App from './App.vue'
import axios from 'axios'

Vue.use(ElementUI);
Vue.prototype.axios = axios;
Vue.config.productionTip = false;

new Vue({
    render: h => h(App),
}).$mount('#app');

//引入封装好的请求文件
//调用者位置
import { request } from './network/request/request'
request({
    url: '/on_categorys',
    params: {
        id: 19
    },
}).then(res => {
    console.log(res);
}).catch(err => {
    console.log(err);
});