feat: 新增第二种按钮权限指令(根据登录接口返回的permissions字段进行判断)

This commit is contained in:
xiaoxian521 2024-08-09 16:50:54 +08:00
parent 96152ed134
commit 12cbae29bb
14 changed files with 94 additions and 10 deletions

View File

@ -57,6 +57,7 @@
"v-copy", "v-copy",
"v-longpress", "v-longpress",
"v-optimize", "v-optimize",
"v-perms",
"v-ripple" "v-ripple"
], ],
"vscodeCustomCodeColor.highlightValueColor": "#b392f0", "vscodeCustomCodeColor.highlightValueColor": "#b392f0",

View File

@ -15,6 +15,12 @@ export default defineFakeRoute([
nickname: "小铭", nickname: "小铭",
// 一个用户可能有多个角色 // 一个用户可能有多个角色
roles: ["admin"], roles: ["admin"],
// 按钮级别权限
permissions: [
"permission:btn:add",
"permission:btn:edit",
"permission:btn:delete"
],
accessToken: "eyJhbGciOiJIUzUxMiJ9.admin", accessToken: "eyJhbGciOiJIUzUxMiJ9.admin",
refreshToken: "eyJhbGciOiJIUzUxMiJ9.adminRefresh", refreshToken: "eyJhbGciOiJIUzUxMiJ9.adminRefresh",
expires: "2030/10/30 00:00:00" expires: "2030/10/30 00:00:00"
@ -28,6 +34,7 @@ export default defineFakeRoute([
username: "common", username: "common",
nickname: "小林", nickname: "小林",
roles: ["common"], roles: ["common"],
permissions: [],
accessToken: "eyJhbGciOiJIUzUxMiJ9.common", accessToken: "eyJhbGciOiJIUzUxMiJ9.common",
refreshToken: "eyJhbGciOiJIUzUxMiJ9.commonRefresh", refreshToken: "eyJhbGciOiJIUzUxMiJ9.commonRefresh",
expires: "2030/10/30 00:00:00" expires: "2030/10/30 00:00:00"

View File

@ -11,6 +11,8 @@ export type UserResult = {
nickname: string; nickname: string;
/** 当前登录用户的角色 */ /** 当前登录用户的角色 */
roles: Array<string>; roles: Array<string>;
/** 按钮级别权限 */
permissions: Array<string>;
/** `token` */ /** `token` */
accessToken: string; accessToken: string;
/** 用于调用刷新`accessToken`的接口时所需的`token` */ /** 用于调用刷新`accessToken`的接口时所需的`token` */

View File

@ -0,0 +1,5 @@
import perms from "./src/perms";
const Perms = perms;
export { Perms };

View File

@ -0,0 +1,20 @@
import { defineComponent, Fragment } from "vue";
import { hasPerms } from "@/utils/auth";
export default defineComponent({
name: "Perms",
props: {
value: {
type: undefined,
default: []
}
},
setup(props, { slots }) {
return () => {
if (!slots) return null;
return hasPerms(props.value) ? (
<Fragment>{slots.default?.()}</Fragment>
) : null;
};
}
});

View File

@ -2,4 +2,5 @@ export * from "./auth";
export * from "./copy"; export * from "./copy";
export * from "./longpress"; export * from "./longpress";
export * from "./optimize"; export * from "./optimize";
export * from "./perms";
export * from "./ripple"; export * from "./ripple";

View File

@ -0,0 +1,15 @@
import { hasPerms } from "@/utils/auth";
import type { Directive, DirectiveBinding } from "vue";
export const perms: Directive = {
mounted(el: HTMLElement, binding: DirectiveBinding<string | Array<string>>) {
const { value } = binding;
if (value) {
!hasPerms(value) && el.parentNode?.removeChild(el);
} else {
throw new Error(
"[Directive: perms]: need perms! Like v-perms=\"['btn.add','btn.edit']\""
);
}
}
};

View File

@ -44,7 +44,9 @@ app.component("FontIcon", FontIcon);
// 全局注册按钮级别权限组件 // 全局注册按钮级别权限组件
import { Auth } from "@/components/ReAuth"; import { Auth } from "@/components/ReAuth";
import { Perms } from "@/components/RePerms";
app.component("Auth", Auth); app.component("Auth", Auth);
app.component("Perms", Perms);
// 全局注册vue-tippy // 全局注册vue-tippy
import "tippy.js/dist/tippy.css"; import "tippy.js/dist/tippy.css";

View File

@ -355,7 +355,7 @@ function getAuths(): Array<string> {
return router.currentRoute.value.meta.auths as Array<string>; return router.currentRoute.value.meta.auths as Array<string>;
} }
/** 是否有按钮级别的权限 */ /** 是否有按钮级别的权限(根据路由`meta`中的`auths`字段进行判断)*/
function hasAuth(value: string | Array<string>): boolean { function hasAuth(value: string | Array<string>): boolean {
if (!value) return false; if (!value) return false;
/** 从当前路由的`meta`字段里获取按钮级别的所有自定义`code`值 */ /** 从当前路由的`meta`字段里获取按钮级别的所有自定义`code`值 */

View File

@ -27,6 +27,9 @@ export const useUserStore = defineStore({
nickname: storageLocal().getItem<DataInfo<number>>(userKey)?.nickname ?? "", nickname: storageLocal().getItem<DataInfo<number>>(userKey)?.nickname ?? "",
// 页面级别权限 // 页面级别权限
roles: storageLocal().getItem<DataInfo<number>>(userKey)?.roles ?? [], roles: storageLocal().getItem<DataInfo<number>>(userKey)?.roles ?? [],
// 按钮级别权限
permissions:
storageLocal().getItem<DataInfo<number>>(userKey)?.permissions ?? [],
// 前端生成的验证码(按实际需求替换) // 前端生成的验证码(按实际需求替换)
verifyCode: "", verifyCode: "",
// 判断登录页面显示哪个组件0登录默认、1手机登录、2二维码登录、3注册、4忘记密码 // 判断登录页面显示哪个组件0登录默认、1手机登录、2二维码登录、3注册、4忘记密码
@ -53,6 +56,10 @@ export const useUserStore = defineStore({
SET_ROLES(roles: Array<string>) { SET_ROLES(roles: Array<string>) {
this.roles = roles; this.roles = roles;
}, },
/** 存储按钮级别权限 */
SET_PERMS(permissions: Array<string>) {
this.permissions = permissions;
},
/** 存储前端生成的验证码 */ /** 存储前端生成的验证码 */
SET_VERIFYCODE(verifyCode: string) { SET_VERIFYCODE(verifyCode: string) {
this.verifyCode = verifyCode; this.verifyCode = verifyCode;
@ -86,6 +93,7 @@ export const useUserStore = defineStore({
logOut() { logOut() {
this.username = ""; this.username = "";
this.roles = []; this.roles = [];
this.permissions = [];
removeToken(); removeToken();
useMultiTagsStoreHook().handleTags("equal", [...routerArrays]); useMultiTagsStoreHook().handleTags("equal", [...routerArrays]);
resetRouter(); resetRouter();

View File

@ -42,6 +42,7 @@ export type userType = {
username?: string; username?: string;
nickname?: string; nickname?: string;
roles?: Array<string>; roles?: Array<string>;
permissions?: Array<string>;
verifyCode?: string; verifyCode?: string;
currentPage?: number; currentPage?: number;
isRemembered?: boolean; isRemembered?: boolean;

View File

@ -1,6 +1,6 @@
import Cookies from "js-cookie"; import Cookies from "js-cookie";
import { storageLocal } from "@pureadmin/utils";
import { useUserStoreHook } from "@/store/modules/user"; import { useUserStoreHook } from "@/store/modules/user";
import { storageLocal, isString, isIncludeAllChildren } from "@pureadmin/utils";
export interface DataInfo<T> { export interface DataInfo<T> {
/** token */ /** token */
@ -17,6 +17,8 @@ export interface DataInfo<T> {
nickname?: string; nickname?: string;
/** 当前登录用户的角色 */ /** 当前登录用户的角色 */
roles?: Array<string>; roles?: Array<string>;
/** 当前登录用户的按钮级别权限 */
permissions?: Array<string>;
} }
export const userKey = "user-info"; export const userKey = "user-info";
@ -41,7 +43,7 @@ export function getToken(): DataInfo<number> {
* @description `token``token` * @description `token``token`
* `accessToken`访使`token``refreshToken``accessToken``token``refreshToken`30`accessToken`2`expires``accessToken` * `accessToken`访使`token``refreshToken``accessToken``token``refreshToken`30`accessToken`2`expires``accessToken`
* `accessToken``expires``refreshToken`key值为authorized-token的cookie里 * `accessToken``expires``refreshToken`key值为authorized-token的cookie里
* `avatar``username``nickname``roles``refreshToken``expires`key值为`user-info`localStorage里`multipleTabsKey` * `avatar``username``nickname``roles``permissions``refreshToken``expires`key值为`user-info`localStorage里`multipleTabsKey`
*/ */
export function setToken(data: DataInfo<Date>) { export function setToken(data: DataInfo<Date>) {
let expires = 0; let expires = 0;
@ -66,28 +68,31 @@ export function setToken(data: DataInfo<Date>) {
: {} : {}
); );
function setUserKey({ avatar, username, nickname, roles }) { function setUserKey({ avatar, username, nickname, roles, permissions }) {
useUserStoreHook().SET_AVATAR(avatar); useUserStoreHook().SET_AVATAR(avatar);
useUserStoreHook().SET_USERNAME(username); useUserStoreHook().SET_USERNAME(username);
useUserStoreHook().SET_NICKNAME(nickname); useUserStoreHook().SET_NICKNAME(nickname);
useUserStoreHook().SET_ROLES(roles); useUserStoreHook().SET_ROLES(roles);
useUserStoreHook().SET_PERMS(permissions);
storageLocal().setItem(userKey, { storageLocal().setItem(userKey, {
refreshToken, refreshToken,
expires, expires,
avatar, avatar,
username, username,
nickname, nickname,
roles roles,
permissions
}); });
} }
if (data.username && data.roles) { if (data.username && data.roles && data.permissions) {
const { username, roles } = data; const { username, roles, permissions } = data;
setUserKey({ setUserKey({
avatar: data?.avatar ?? "", avatar: data?.avatar ?? "",
username, username,
nickname: data?.nickname ?? "", nickname: data?.nickname ?? "",
roles roles,
permissions
}); });
} else { } else {
const avatar = const avatar =
@ -98,11 +103,14 @@ export function setToken(data: DataInfo<Date>) {
storageLocal().getItem<DataInfo<number>>(userKey)?.nickname ?? ""; storageLocal().getItem<DataInfo<number>>(userKey)?.nickname ?? "";
const roles = const roles =
storageLocal().getItem<DataInfo<number>>(userKey)?.roles ?? []; storageLocal().getItem<DataInfo<number>>(userKey)?.roles ?? [];
const permissions =
storageLocal().getItem<DataInfo<number>>(userKey)?.permissions ?? [];
setUserKey({ setUserKey({
avatar, avatar,
username, username,
nickname, nickname,
roles roles,
permissions
}); });
} }
} }
@ -118,3 +126,14 @@ export function removeToken() {
export const formatToken = (token: string): string => { export const formatToken = (token: string): string => {
return "Bearer " + token; return "Bearer " + token;
}; };
/** 是否有按钮级别的权限(根据登录接口返回的`permissions`字段进行判断)*/
export const hasPerms = (value: string | Array<string>): boolean => {
if (!value) return false;
const { permissions } = useUserStoreHook();
if (!permissions) return false;
const isAuths = isString(value)
? permissions.includes(value)
: isIncludeAllChildren(value, permissions);
return isAuths ? true : false;
};

View File

@ -5,7 +5,7 @@ declare module "vue" {
export interface ComponentCustomProperties { export interface ComponentCustomProperties {
/** `Loading` 动画加载指令具体看https://element-plus.org/zh-CN/component/loading.html#%E6%8C%87%E4%BB%A4 */ /** `Loading` 动画加载指令具体看https://element-plus.org/zh-CN/component/loading.html#%E6%8C%87%E4%BB%A4 */
vLoading: Directive<Element, boolean>; vLoading: Directive<Element, boolean>;
/** 按钮权限指令 */ /** 按钮权限指令(根据路由`meta`中的`auths`字段进行判断)*/
vAuth: Directive<HTMLElement, string | Array<string>>; vAuth: Directive<HTMLElement, string | Array<string>>;
/** 文本复制指令(默认双击复制) */ /** 文本复制指令(默认双击复制) */
vCopy: Directive<CopyEl, string>; vCopy: Directive<CopyEl, string>;
@ -13,6 +13,8 @@ declare module "vue" {
vLongpress: Directive<HTMLElement, Function>; vLongpress: Directive<HTMLElement, Function>;
/** 防抖、节流指令 */ /** 防抖、节流指令 */
vOptimize: Directive<HTMLElement, OptimizeOptions>; vOptimize: Directive<HTMLElement, OptimizeOptions>;
/** 按钮权限指令(根据登录接口返回的`permissions`字段进行判断)*/
vPerms: Directive<HTMLElement, string | Array<string>>;
/** /**
* `v-ripple` * `v-ripple`
* 1. `v-ripple``ripple` * 1. `v-ripple``ripple`

View File

@ -7,6 +7,7 @@ declare module "vue" {
IconifyIconOnline: (typeof import("../src/components/ReIcon"))["IconifyIconOnline"]; IconifyIconOnline: (typeof import("../src/components/ReIcon"))["IconifyIconOnline"];
FontIcon: (typeof import("../src/components/ReIcon"))["FontIcon"]; FontIcon: (typeof import("../src/components/ReIcon"))["FontIcon"];
Auth: (typeof import("../src/components/ReAuth"))["Auth"]; Auth: (typeof import("../src/components/ReAuth"))["Auth"];
Perms: (typeof import("../src/components/RePerms"))["Perms"];
} }
} }