auth.ts 4.9 KB

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