request.js 12 KB

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