request.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
  1. // request.js
  2. import Request from "luch-request";
  3. import qs from "qs";
  4. import { ref } from "vue";
  5. import config from "@/utils/config";
  6. import errorCode from "@/utils/errorCode";
  7. import {
  8. getTenantId,
  9. getUserId,
  10. getAccessToken,
  11. getRefreshToken,
  12. setToken,
  13. } from "@/utils/auth.js";
  14. import { refreshToken } from "@/api/login";
  15. import $store from "@/store";
  16. import { localeFormatObj } from "@/utils/format";
  17. const options = {
  18. // 显示操作成功消息 默认不显示
  19. showSuccess: false,
  20. // 成功提醒 默认使用后端返回值
  21. successMsg: "",
  22. // 显示失败消息 默认显示
  23. showError: true,
  24. // 失败提醒 默认使用后端返回信息
  25. errorMsg: "",
  26. // 显示请求时loading模态框 默认显示
  27. showLoading: true,
  28. // loading提醒文字
  29. loadingMsg: "加载中",
  30. // 需要授权才能请求 默认放开
  31. auth: false,
  32. // ...
  33. };
  34. // 需要忽略的提示。忽略后,自动 Promise.reject('error')
  35. const ignoreMsgs = [
  36. "无效的刷新令牌", // 刷新令牌被删除时,不用提示
  37. "刷新令牌已过期", // 使用刷新令牌,刷新获取新的访问令牌时,结果因为过期失败,此时需要忽略。否则,会导致继续 401,无法跳转到登出界面
  38. ];
  39. // 是否显示重新登录
  40. export let isRelogin = {
  41. show: false,
  42. };
  43. // 定义请求配置
  44. const defaultOptions = {
  45. baseURL: config.default.apiUrl + config.default.apiUrlSuffix, // 基础URL
  46. method: "GET", // 默认请求方法
  47. timeout: 10000, // 请求超时时间
  48. header: {
  49. "Content-Type": "application/json",
  50. },
  51. withToken: true, // 是否携带token
  52. throttleDelay: 500, // 节流延时
  53. debounceDelay: 1000, // 防抖延时
  54. custom: options,
  55. };
  56. // Loading全局实例
  57. let LoadingInstance = {
  58. target: null,
  59. count: 0,
  60. };
  61. /**
  62. * 关闭loading
  63. */
  64. function closeLoading() {
  65. if (LoadingInstance.count > 0) LoadingInstance.count--;
  66. if (LoadingInstance.count === 0) uni.hideLoading();
  67. }
  68. /**
  69. * @description 请求基础配置 可直接使用访问自定义请求
  70. */
  71. const http = new Request(defaultOptions);
  72. // 请求拦截器
  73. http.interceptors.request.use(
  74. (config) => {
  75. // console.log('config ', config, config.withToken)
  76. // 在发送请求之前做些什么
  77. // 自定义处理【loading 加载中】:如果需要显示 loading,则显示 loading
  78. if (config.custom.showLoading) {
  79. LoadingInstance.count++;
  80. LoadingInstance.count === 1 &&
  81. uni.showLoading({
  82. title: config.custom.loadingMsg,
  83. mask: true,
  84. fail: () => {
  85. uni.hideLoading();
  86. },
  87. });
  88. }
  89. // 携带token
  90. config.header = {
  91. ...config.header,
  92. Authorization: getAccessToken() ? "Bearer " + getAccessToken() : "",
  93. "tenant-id": getTenantId() ? getTenantId() : "1",
  94. };
  95. // 只处理GET请求的数组参数
  96. if (config.method.toUpperCase() === "GET" && config.data) {
  97. config.url += "?" + qs.stringify(config.data, { arrayFormat: "indices" });
  98. config.data = {}; // 清空params,避免重复传递
  99. }
  100. // // get请求映射params参数
  101. // if (config.method === 'get' && config.params) {
  102. // let url = config.url + '?';
  103. // for (const propName of Object.keys(config.params)) {
  104. // const value = config.params[propName];
  105. // const part = encodeURIComponent(propName) + '='
  106. // if (value !== null && typeof(value) !== "undefined") {
  107. // if (typeof value === 'object') {
  108. // for (const key of Object.keys(value)) {
  109. // let params = propName + '[' + key + ']';
  110. // const subPart = encodeURIComponent(params) + '='
  111. // url += subPart + encodeURIComponent(value[key]) + "&";
  112. // }
  113. // } else {
  114. // url += part + encodeURIComponent(value) + "&";
  115. // }
  116. // }
  117. // }
  118. // url = url.slice(0, -1);
  119. // config.params = {};
  120. // config.url = url;
  121. // }
  122. // console.log('config--', config, )
  123. return config;
  124. },
  125. (error) => {
  126. // 对请求错误做些什么
  127. return Promise.reject(error);
  128. }
  129. );
  130. /**
  131. * @description 响应拦截器
  132. */
  133. http.interceptors.response.use(
  134. (response) => {
  135. // console.log('response-', response)
  136. // 约定:如果是 /auth/ 下的 URL 地址,并且返回了 accessToken 说明是登录相关的接口,则自动设置登陆令牌
  137. if (
  138. response.config.url.indexOf("/system/auth/") >= 0 &&
  139. response.data?.data?.accessToken
  140. ) {
  141. // console.log('response.data.data.accessToken', response.data.data.accessToken)
  142. // setToken(response.data.data.accessToken);
  143. setToken(response.data.data);
  144. }
  145. // 自定处理【loading 加载中】:如果需要显示 loading,则关闭 loading
  146. response.config.custom.showLoading && closeLoading();
  147. // 自定义处理【error 错误提示】:如果需要显示错误提示,则显示错误提示
  148. if (response.data.code !== 0) {
  149. // 特殊:如果 401 错误码,则跳转到登录页 or 刷新令牌
  150. if (response.data.code === 401) {
  151. console.log("401--------");
  152. return refreshTokenFun(response.config);
  153. }
  154. // 特殊:处理分销用户绑定失败的提示
  155. if ((response.data.code + "").includes("1011007")) {
  156. console.error(`分销用户绑定失败,原因:${response.data.msg}`);
  157. } else if (response.config.custom.showError) {
  158. // 错误提示
  159. uni.showToast({
  160. title: response.data.msg || "服务器开小差啦,请稍后再试~",
  161. icon: "none",
  162. mask: true,
  163. });
  164. }
  165. }
  166. // 自定义处理【showSuccess 成功提示】:如果需要显示成功提示,则显示成功提示
  167. if (
  168. response.config.custom.showSuccess &&
  169. response.config.custom.successMsg !== "" &&
  170. response.data.code === 0
  171. ) {
  172. uni.showToast({
  173. title: response.config.custom.successMsg,
  174. icon: "none",
  175. });
  176. }
  177. // 返回结果:包括 code + data + msg
  178. // console.log(response.data)
  179. localeFormatObj(response.data);
  180. return Promise.resolve(response.data);
  181. },
  182. (error) => {
  183. const userStore = $store("user");
  184. const isLogin = userStore.isLogin;
  185. let errorMessage = "网络请求出错";
  186. if (error !== undefined) {
  187. switch (error.statusCode) {
  188. case 400:
  189. errorMessage = "请求错误";
  190. break;
  191. case 401:
  192. errorMessage = isLogin ? "您的登陆已过期" : "请先登录";
  193. // 正常情况下,后端不会返回 401 错误,所以这里不处理 handleAuthorized
  194. break;
  195. case 403:
  196. errorMessage = "拒绝访问";
  197. break;
  198. case 404:
  199. errorMessage = "请求出错";
  200. break;
  201. case 408:
  202. errorMessage = "请求超时";
  203. break;
  204. case 429:
  205. errorMessage = "请求频繁, 请稍后再访问";
  206. break;
  207. case 500:
  208. errorMessage = "服务器开小差啦,请稍后再试~";
  209. break;
  210. case 501:
  211. errorMessage = "服务未实现";
  212. break;
  213. case 502:
  214. errorMessage = "网络错误";
  215. break;
  216. case 503:
  217. errorMessage = "服务不可用";
  218. break;
  219. case 504:
  220. errorMessage = "网络超时";
  221. break;
  222. case 505:
  223. errorMessage = "HTTP 版本不受支持";
  224. break;
  225. }
  226. if (error.errMsg) {
  227. if (error.errMsg.includes("timeout")) errorMessage = "请求超时";
  228. // #ifdef H5
  229. if (error.errMsg.includes("Network"))
  230. errorMessage = window.navigator.onLine
  231. ? "服务器异常"
  232. : "请检查您的网络连接";
  233. // #endif
  234. } else {
  235. console.log(error);
  236. }
  237. }
  238. if (error && error.config) {
  239. if (error.config.custom.showError) {
  240. uni.showToast({
  241. title: error.data?.msg || errorMessage,
  242. icon: "none",
  243. mask: true,
  244. });
  245. }
  246. error.config.custom.showLoading && closeLoading();
  247. }
  248. return false;
  249. }
  250. );
  251. // Axios 无感知刷新令牌,参考 https://www.dashingdog.cn/article/11 与 https://segmentfault.com/a/1190000020210980 实现
  252. let requestList = []; // 请求队列
  253. let isRefreshToken = false; // 是否正在刷新中
  254. const refreshTokenFun = async (config) => {
  255. // 如果当前已经是 refresh-token 的 URL 地址,并且还是 401 错误,说明是刷新令牌失败了,直接返回 Promise.reject(error)
  256. if (config.url.indexOf("/auth/refresh-token") >= 0) {
  257. return Promise.reject("error");
  258. }
  259. // 如果未认证,并且未进行刷新令牌,说明可能是访问令牌过期了
  260. if (!isRefreshToken) {
  261. isRefreshToken = true;
  262. // 1. 如果获取不到刷新令牌,则只能执行登出操作
  263. // const refreshToken = getRefreshToken();
  264. if (!getRefreshToken()) {
  265. return handleAuthorized();
  266. }
  267. // 2. 进行刷新访问令牌
  268. try {
  269. const refreshTokenResult = await refreshToken();
  270. console.log("refreshTokenResult", refreshTokenResult);
  271. if (refreshTokenResult.code !== 0) {
  272. // 如果刷新不成功,直接抛出 e 触发 2.2 的逻辑
  273. // noinspection ExceptionCaughtLocallyJS
  274. throw new Error("刷新令牌失败");
  275. }
  276. // 2.1 刷新成功,则回放队列的请求 + 当前请求
  277. config.header.Authorization = "Bearer " + getAccessToken();
  278. requestList.forEach((cb) => {
  279. cb();
  280. });
  281. requestList = [];
  282. return request(config);
  283. } catch (e) {
  284. // 为什么需要 catch 异常呢?刷新失败时,请求因为 Promise.reject 触发异常。
  285. // 2.2 刷新失败,只回放队列的请求
  286. requestList.forEach((cb) => {
  287. cb();
  288. });
  289. // 提示是否要登出。即不回放当前请求!不然会形成递归
  290. return handleAuthorized();
  291. } finally {
  292. requestList = [];
  293. isRefreshToken = false;
  294. }
  295. } else {
  296. // 添加到队列,等待刷新获取到新的令牌
  297. return new Promise((resolve) => {
  298. requestList.push(() => {
  299. config.header.Authorization = "Bearer " + getAccessToken(); // 让每个请求携带自定义token 请根据实际情况自行修改
  300. resolve(request(config));
  301. });
  302. });
  303. }
  304. };
  305. /**
  306. * 处理 401 未登录的错误
  307. */
  308. const handleAuthorized = () => {
  309. const userStore = $store("user");
  310. userStore.LogOut(true);
  311. uni.showModal({
  312. title: "提示",
  313. content: userStore.isLogin ? "您的登陆已过期" : "请先登录",
  314. showCancel: false,
  315. confirmText: "确定",
  316. success: (res) => {
  317. if (res.confirm) {
  318. uni.reLaunch({ url: '/pages/user/login' })
  319. }
  320. },
  321. });
  322. // 登录超时
  323. return Promise.reject({
  324. code: 401,
  325. msg: userStore.isLogin ? "您的登陆已过期" : "请先登录",
  326. });
  327. };
  328. export const request = (config) => {
  329. return http.middleware(config);
  330. };
  331. export const upload = (url, config) => http.upload(url, config);
  332. // export default request;