前端-Axios基础与Vue封装模块

<!–采用 npm–> npm install axios <!–采用 yarn–> yarn add axios <!–采用 CDN–> <script src=“https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js”></script>

<script> // axios推送get、post的三种方式 有参和无参 // 第1种axios的 预设允诺(get) axios({ url: http://localstore:999/setting/page, }).then(res => { console.log(res); }) // 第2种axios的 get允诺无参数 axios({ url: http://localstore:999/setting/page, method: get, }).then(res => { console.log(res); }) // 第3种axios的 get允诺有参数 axios({ url: http://localstore:999/setting/page, method: get, params:{ id: 1, name: xxx, } }).then(res => { console.log(res); }) // 第4种axios的 post允诺无参数 axios({ url: http://localstore:999/setting/page, method: post, }).then(res => { console.log(res); }) // 第5种axios的 post允诺有参数 axios({ url: http://localstore:999/setting/page, method: post, params: { //application/json name: 1, }, }).then(res => { console.log(res); }) axios({ url: http://localstore:999/setting/page, method: post, data: { name: 1, }, }).then(res => { console.log(res); }) </script>

<script> // 第1种axios的 get允诺无参数 axios.get(http://localstore:999/setting/page).then(res => { console.log(res); }).catch(err => { console.log(err) }); // 第2种axios的 get允诺有参数 axios.get(http://localstore:999/setting/page,{params: {id: 1,name: xxx,}}).then(res => { console.log(res); }) // 第3种axios的 post允诺无参数 axios.post(http://localstore:999/setting/page).then(res => { console.log(res); }) // 第4种axios的 post允诺有参数 axios.post(http://localstore:999/setting/page,“title=dnmd&size=10”).then(res => { console.log(res); }) // 第4种axios的 post允诺有参数 data格式 axios.post(http://localstore:999/setting/page,{title:“dnmd”,size:10}).then(res => { console.log(res); }) </script>

<!– axios并发允诺 –> <script> //axios并发允诺 axios.all([ axios.get(http://localstore:999/setting/page), axios.get(http://localstore:999/setting/page) ]).then(res => { console.log(res[0]); console.log(res[1]); }).catch(err => { console.log(err) }); //axios采用spread方法处理积极响应数组结果 axios.all([ axios.get(http://localstore:999/setting/page), axios.get(http://localstore:999/setting/page) ]).then( axios.spread((res1,res2)=>{ console.log(res1) console.log(res2) }) ).catch(err => { console.log(err) }); //采用 Promise.all 推送(非官方) function getUserAccount() { return axios.get(/user/12345); } function getUserPermissions() { return axios.get(/user/12345/permissions); } Promise.all([getUserAccount(), getUserPermissions()]) .then(function (results) { const acct = results[0]; const perm = results[1]; }).catch(err => { console.log(err); }) </script>

// 全局 axios 预设值axios.defaults.baseURL = http://localstore:9999/;//预设路径 axios.defaults.timeout = 5000; //允诺时长,超时失败 axios.defaults.headers.common[Authorization] = AUTH_TOKEN;//全局token axios.defaults.headers.post[Content-Type] = application/x-www-form-urlencoded; //post的类型 // get允诺无参数的范例 axios.get(setting/page).then(res => { console.log(res); }).catch(err => { console.log(err) }); // 配置的优先级 // 采用库提供的预设配置建立实例 // 此时超时配置的预设值是 `0` const instance = axios.create(); // 重写库的超时预设值 现在，所有采用此实例的允诺都将等待2.5秒，然后才会超时 instance.defaults.timeout = 2500; // 重写此允诺的超时时间，因为该允诺需要很长时间 以这里为准instance.get(/longRequest, { timeout: 5000 });

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

{ // `data` 由服务器提供的积极响应 data: {}, // `status` 来自服务器积极响应的 HTTP 状态码 status: 200, // `statusText` 来自服务器积极响应的 HTTP 状态信息 statusText: OK, // `headers` 是服务器积极响应头 // 所有的 header 名称都是小写，而且可以采用方括号语法访问 // 例如: `response.headers[content-type]` headers: {}, // `config` 是 `axios` 允诺的配置信息 config: {}, // `request` 是生成此积极响应的允诺 // 在node.js中它是最后两个ClientRequest实例 (in redirects)， // 在应用程序中则是 XMLHttpRequest 实例 request: {} }

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); }).catch(err=>{ console.log(err) }

// 添加允诺截击器 axios.interceptors.request.use(function (config) { // 在推送允诺之前做些甚么 return config; }, function (error) { // 对允诺错误做些甚么 return Promise.reject(error); }); // 添加积极响应截击器 axios.interceptors.response.use(function (response) { // 2xx 范围内的状态码都会触发该函数。 // 对积极响应统计数据做点甚么 return response; }, function (error) { // 超出 2xx 范围的状态码都会触发该函数。 // 对积极响应错误做点甚么 return Promise.reject(error); });

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

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

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 if (error.request) { // 允诺已经成功发起，但没有收到积极响应 // `error.request` 在应用程序中是 XMLHttpRequest 的实例， // 而在node.js中是 http.ClientRequest 的实例 console.log(error.request); } else { // 推送允诺时出了点问题 console.log(Error, error.message); } console.log(error.config); });

axios.get(/user/12345, { validateStatus: function (status) { return status < 500; // 处理状态码小于500的情况 } })

axios.get(/user/12345) .catch(function (error) { console.log(error.toJSON()); });

{ // `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 // 预设值 }

import axios from axios import { baseUrl } from @/config/env axios.defaults.baseURL = baseUrl; axios.defaults.timeout = 100000 // 返回其他状态吗 axios.defaults.validateStatus = function(status) { return status >= 200 && status <= 500 // 预设的 } // 跨域允诺，允许保存cookie axios.defaults.withCredentials = true // HTTPrequest截击 axios.interceptors.request.use(config => { const isToken = (config.headers || {}).isToken === false let token = store.getters.access_token if (token && !isToken) { config.headers[Authorization] = Bearer + token // token } return config }, error => { return Promise.reject(error) }) const excludeResInterception=[ loginQrCodeThird, workwechat/butler/contact/detail, workwechat/butler/speechcraft/preview-private-qrcode, auth/oauth/token ]//不需要错误提示的允诺接口数组 // HTTPresponse截击 axios.interceptors.response.use(res => { NProgress.done() const status = Number(res.status) || 200 const message = res.data.msg || errorCode[status] || errorCode[default] if (status === 401) { store.dispatch(FedLogOut).then(() => { router.push({ path: /login }) }) return } const isExclude = excludeResInterception.some(item=>res.config.url.indexOf(item)!==-1) if (status !== 200 || res.data.code === 1) { if(!isExclude){ Message({ message: message, type: error }) } return Promise.reject(new Error(message)) } return res }, error => { NProgress.done() return Promise.reject(new Error(error)) }) export default axios

import {request} from ./axios.js // 删除-参数模板列表 export function deleteTemplateList(query) { return request({ url: /param-template/delete/+query.id, method: post, data: query }) } export function getTemplateList(query) { return request({ url: /param-template/page, method: get, params: query }) }

import {getTemplateList} form “./request.js” getTemplateList() { let params = { current: 1, size: 100, }; getTemplateList(params).then((res) => { let options = res.data.data.records || []; // do something }).catch(err=>{ console.error(err) }) },

<!– PCB位置 –> <script> import axios from “axios”; export function request(config = {}, success, fail){ axios(config).then(res => { success(res) }).catch(err => { fail(err) }) } </script> <!– 调用位置 –> <script> import { request } from “./axios.js”; request(config = { url: “http://localstore:999/setting/page” }, res => { console.log(res); }, err => { console.error(err); }) </script>

<!– PCB位置 –> <script> import axios from “axios”; export function request(config){ axios(config.url).then(res => { config.success(res) }).catch(err => { config.fail(err) }) } </script> <!– 调用位置 –> <script> import { request } from “./axios.js”; request({ url: “http://localstore:999/setting/page”, success: res => { console.log(res); }, fail: err => { console.error(err); } }) </script>

<!– 第三种PCB –> <!– PCB位置 –> <script> import axios from “axios”; export function request(config){ return new Promise((resolve, reject) => { let newRequest = axios.create({ baseURL: “http://localhost”, timeout: 5000, }) newRequest(config).then((res) => { resolve(res) }).catch(err => { reject(err); }) }) } </script> <!– 调用位置 –> <script> import { request } from “./axios.js”; request({ url: “http://localstore:999/setting/page” }).then(res => { console.log(res); }).catch(err => { console.log(err) }) </script>

<!– 第四种PCB –> <!– PCB位置 –> <script> import axios from “axios”; export function request(config){ let newRequest = axios.create({ baseURL: “http://localhost”, timeout: 5000, }) return newRequest(config) } </script> <!– 调用位置 –> <script> import { request } from “./axios.js”; request({ url: “http://localstore:999/setting/page” }).then(res => { console.log(res); }).catch(err => { console.log(err) }) </script>