auth.ts 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  1. import Cookies from "js-cookie";
  2. import { useUserStoreHook } from "@/store/modules/user";
  3. import { storageLocal, isString, isIncludeAllChildren } from "@pureadmin/utils";
  4. export interface DataInfo<T> {
  5. /** token */
  6. accessToken: string;
  7. /** `accessToken`的过期时间(时间戳) */
  8. expires: T;
  9. /** 用于调用刷新accessToken的接口时所需的token */
  10. refreshToken: string;
  11. /** 头像 */
  12. avatar?: string;
  13. /** 用户名 */
  14. username?: string;
  15. /** 昵称 */
  16. nickname?: string;
  17. /** 当前登录用户的角色 */
  18. roles?: Array<string>;
  19. /** 当前登录用户的按钮级别权限 */
  20. permissions?: Array<string>;
  21. admUserId: number;
  22. admUserName: string;
  23. id: number;
  24. loginName: string;
  25. operationRole: number;
  26. roleId: number;
  27. roleName: string;
  28. token: string;
  29. userMenuTree: object;
  30. userModule: string;
  31. _businessDockingId: number;
  32. access_token: string;
  33. expires_in: number;
  34. }
  35. export const userKey = "user-info";
  36. export const TokenKey = "Admin-Token";
  37. /**
  38. * 通过`multiple-tabs`是否在`cookie`中,判断用户是否已经登录系统,
  39. * 从而支持多标签页打开已经登录的系统后无需再登录。
  40. * 浏览器完全关闭后`multiple-tabs`将自动从`cookie`中销毁,
  41. * 再次打开浏览器需要重新登录系统
  42. * */
  43. export const multipleTabsKey = "multiple-tabs";
  44. /** 获取`token` */
  45. export function getToken(): DataInfo<number> {
  46. // 此处与`TokenKey`相同,此写法解决初始化时`Cookies`中不存在`TokenKey`报错
  47. return Cookies.get(TokenKey)
  48. ? JSON.parse(Cookies.get(TokenKey))
  49. : storageLocal().getItem(userKey);
  50. }
  51. /**
  52. * @description 设置`token`以及一些必要信息并采用无感刷新`token`方案
  53. * 无感刷新:后端返回`accessToken`(访问接口使用的`token`)、`refreshToken`(用于调用刷新`accessToken`的接口时所需的`token`,`refreshToken`的过期时间(比如30天)应大于`accessToken`的过期时间(比如2小时))、`expires`(`accessToken`的过期时间)
  54. * 将`accessToken`、`expires`、`refreshToken`这三条信息放在key值为authorized-token的cookie里(过期自动销毁)
  55. * 将`avatar`、`username`、`nickname`、`roles`、`permissions`、`refreshToken`、`expires`这七条信息放在key值为`user-info`的localStorage里(利用`multipleTabsKey`当浏览器完全关闭后自动销毁)
  56. */
  57. export function setToken(data: DataInfo<number>) {
  58. const expires = 0;
  59. // const { accessToken, refreshToken } = data;
  60. const { access_token, expires_in } = data;
  61. const { isRemembered, loginDay } = useUserStoreHook();
  62. // expires = new Date(data.expires).getTime(); // 如果后端直接设置时间戳,将此处代码改为expires = data.expires,然后把上面的DataInfo<Date>改成DataInfo<number>即可
  63. // const cookieString = JSON.stringify({ token, expires, refreshToken });
  64. const cookieString = JSON.stringify({ access_token, expires_in });
  65. expires_in > 0
  66. ? Cookies.set(TokenKey, cookieString, {
  67. expires: expires_in
  68. })
  69. : Cookies.set(TokenKey, cookieString);
  70. Cookies.set(
  71. multipleTabsKey,
  72. "true",
  73. isRemembered
  74. ? {
  75. expires: loginDay
  76. }
  77. : {}
  78. );
  79. function setUserKey({ avatar, username, nickname, roles, permissions }) {
  80. useUserStoreHook().SET_AVATAR(avatar);
  81. useUserStoreHook().SET_USERNAME(username);
  82. useUserStoreHook().SET_NICKNAME(nickname);
  83. useUserStoreHook().SET_ROLES(roles);
  84. useUserStoreHook().SET_PERMS(permissions);
  85. storageLocal().setItem(userKey, {
  86. // refreshToken,
  87. expires,
  88. avatar,
  89. username,
  90. nickname,
  91. roles,
  92. permissions
  93. });
  94. }
  95. if (data.username && data.roles) {
  96. const { username, roles } = data;
  97. setUserKey({
  98. avatar: data?.avatar ?? "",
  99. username,
  100. nickname: data?.nickname ?? "",
  101. roles,
  102. permissions: data?.permissions ?? []
  103. });
  104. } else {
  105. const avatar =
  106. storageLocal().getItem<DataInfo<number>>(userKey)?.avatar ?? "";
  107. const username =
  108. storageLocal().getItem<DataInfo<number>>(userKey)?.username ?? "";
  109. const nickname =
  110. storageLocal().getItem<DataInfo<number>>(userKey)?.nickname ?? "";
  111. const roles =
  112. storageLocal().getItem<DataInfo<number>>(userKey)?.roles ?? [];
  113. const permissions =
  114. storageLocal().getItem<DataInfo<number>>(userKey)?.permissions ?? [];
  115. setUserKey({
  116. avatar,
  117. username,
  118. nickname,
  119. roles,
  120. permissions
  121. });
  122. }
  123. }
  124. /** 删除`token`以及key值为`user-info`的localStorage信息 */
  125. export function removeToken() {
  126. Cookies.remove(TokenKey);
  127. Cookies.remove(multipleTabsKey);
  128. storageLocal().removeItem(userKey);
  129. }
  130. /** 格式化token(jwt格式) */
  131. export const formatToken = (token: string): string => {
  132. return "Bearer " + token;
  133. };
  134. /** 是否有按钮级别的权限(根据登录接口返回的`permissions`字段进行判断)*/
  135. export const hasPerms = (value: string | Array<string>): boolean => {
  136. if (!value) return false;
  137. const allPerms = "*:*:*";
  138. const { permissions } = useUserStoreHook();
  139. if (!permissions) return false;
  140. if (permissions.length === 1 && permissions[0] === allPerms) return true;
  141. const isAuths = isString(value)
  142. ? permissions.includes(value)
  143. : isIncludeAllChildren(value, permissions);
  144. return isAuths ? true : false;
  145. };