auth.ts 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. import Cookies from "js-cookie";
  2. import { storageSession } from "@pureadmin/utils";
  3. import { useUserStoreHook } from "@/store/modules/user";
  4. export interface DataInfo<T> {
  5. /** token */
  6. accessToken: string;
  7. /** `accessToken`的过期时间(时间戳) */
  8. expires: T;
  9. /** 用于调用刷新accessToken的接口时所需的token */
  10. refreshToken: string;
  11. /** 用户名 */
  12. username?: string;
  13. /** 当前登陆用户的角色 */
  14. roles?: Array<string>;
  15. }
  16. export const sessionKey = "user-info";
  17. export const TokenKey = "authorized-token";
  18. /** 获取`token` */
  19. export function getToken(): DataInfo<number> {
  20. // 此处与`TokenKey`相同,此写法解决初始化时`Cookies`中不存在`TokenKey`报错
  21. return Cookies.get(TokenKey)
  22. ? JSON.parse(Cookies.get(TokenKey))
  23. : storageSession.getItem(sessionKey);
  24. }
  25. /**
  26. * @description 设置`token`以及一些必要信息并采用无感刷新`token`方案
  27. * 无感刷新:后端返回`accessToken`(访问接口使用的`token`)、`refreshToken`(用于调用刷新`accessToken`的接口时所需的`token`,`refreshToken`的过期时间(比如30天)应大于`accessToken`的过期时间(比如2小时))、`expires`(`accessToken`的过期时间)
  28. * 将`accessToken`、`expires`这两条信息放在key值为authorized-token的cookie里(过期自动销毁)
  29. * 将`username`、`roles`、`refreshToken`、`expires`这四条信息放在key值为`user-info`的sessionStorage里(浏览器关闭自动销毁)
  30. */
  31. export function setToken(data: DataInfo<Date>) {
  32. let expires = 0;
  33. const { accessToken, refreshToken } = data;
  34. expires = new Date(data.expires).getTime(); // 如果后端直接设置时间戳,将此处代码改为expires = data.expires,然后把上面的DataInfo<Date>改成DataInfo<number>即可
  35. const cookieString = JSON.stringify({ accessToken, expires });
  36. expires > 0
  37. ? Cookies.set(TokenKey, cookieString, {
  38. expires: (expires - Date.now()) / 86400000
  39. })
  40. : Cookies.set(TokenKey, cookieString);
  41. function setSessionKey(username: string, roles: Array<string>) {
  42. useUserStoreHook().SET_USERNAME(username);
  43. useUserStoreHook().SET_ROLES(roles);
  44. storageSession.setItem(sessionKey, {
  45. refreshToken,
  46. expires,
  47. username,
  48. roles
  49. });
  50. }
  51. if (data.username && data.roles) {
  52. const { username, roles } = data;
  53. setSessionKey(username, roles);
  54. } else {
  55. const username =
  56. storageSession.getItem<DataInfo<number>>(sessionKey)?.username ?? "";
  57. const roles =
  58. storageSession.getItem<DataInfo<number>>(sessionKey)?.roles ?? [];
  59. setSessionKey(username, roles);
  60. }
  61. }
  62. /** 删除`token`以及key值为`user-info`的session信息 */
  63. export function removeToken() {
  64. Cookies.remove(TokenKey);
  65. sessionStorage.clear();
  66. }
  67. /** 格式化token(jwt格式) */
  68. export const formatToken = (token: string): string => {
  69. return "Bearer " + token;
  70. };