feat: Improve the front-end and back-end permission mode and useAccess

This commit is contained in:
vben
2024-07-06 13:28:08 +08:00
parent 4dbd13d48d
commit 37a4f971c8
27 changed files with 522 additions and 79 deletions

View File

@@ -36,7 +36,7 @@
"@nestjs/cli": "^10.4.2",
"@nestjs/schematics": "^10.1.2",
"@types/express": "^4.17.21",
"@types/node": "^20.14.9",
"@types/node": "^20.14.10",
"nodemon": "^3.1.4",
"ts-node": "^10.9.2",
"typescript": "^5.5.3"

View File

@@ -19,6 +19,16 @@ import { AuthService } from './auth.service';
export class AuthController {
constructor(private authService: AuthService) {}
/**
* 获取用户权限码
* @param req
*/
@Get('getAccessCodes')
@HttpCode(HttpStatus.OK)
async getAccessCodes(@Request() req: Request) {
return await this.authService.getAccessCodes(req.user.username);
}
/**
* 获取用户信息
* @param req

View File

@@ -19,6 +19,30 @@ export class AuthService {
* get user info
* @param username
*/
async getAccessCodes(username: string): Promise<string[]> {
const user = await this.usersService.findOne(username);
const mockCodes = [
// super
{
codes: ['AC_100100', 'AC_100110', 'AC_100120', 'AC_100010'],
userId: 0,
},
{
// admin
codes: ['AC_100010', 'AC_100020', 'AC_100030'],
userId: 1,
},
{
// user
codes: ['AC_1000001', 'AC_1000002'],
userId: 2,
},
];
return mockCodes.find((item) => item.userId === user.id)?.codes ?? [];
}
async getUserInfo(username: string): Promise<Omit<UserEntity, 'password'>> {
const user = await this.usersService.findOne(username);
const { password: _pass, ...userInfo } = user;

View File

@@ -10,7 +10,7 @@ export class MenuController {
@HttpCode(HttpStatus.OK)
async getAll(@Request() req: Request) {
// 模拟请求延迟
await sleep(1000);
await sleep(500);
// 请求用户的id
const userId = req.user.id;
@@ -46,15 +46,110 @@ export class MenuController {
],
},
];
const createDemosMenus = (role: 'admin' | 'super' | 'user') => {
const roleWithMenus = {
admin: {
component: '/demos/access/backend/access-test-2',
meta: {
icon: 'mdi:button-cursor',
title: 'page.demos.access.access-test-2',
},
name: 'AccessBackendTest2',
path: 'access-test-2',
},
super: {
component: '/demos/access/backend/access-test-1',
meta: {
icon: 'mdi:button-cursor',
title: 'page.demos.access.access-test-1',
},
name: 'AccessBackendTest1',
path: 'access-test-1',
},
user: {
component: '/demos/access/backend/access-test-3',
meta: {
icon: 'mdi:button-cursor',
title: 'page.demos.access.access-test-3',
},
name: 'AccessBackendTest3',
path: 'access-test-3',
},
};
return [
{
component: 'BasicLayout',
meta: {
icon: 'ic:baseline-view-in-ar',
keepAlive: true,
order: 1000,
title: 'page.demos.title',
},
name: 'Demos',
path: '/demos',
redirect: '/demos/access',
children: [
{
meta: {
icon: 'mdi:shield-key-outline',
title: 'page.demos.access.title',
},
name: 'Access',
path: 'access',
redirect: '/demos/access/backend',
children: [
{
name: 'AccessBackend',
path: 'backend',
meta: {
icon: 'mdi:cloud-key-outline',
title: 'page.demos.access.backend-control',
},
redirect: '/demos/access/backend/page-control',
children: [
{
name: 'AccessBackendPageControl',
path: 'page-control',
component: '/demos/access/backend/index',
meta: {
icon: 'mdi:page-previous-outline',
title: 'page.demos.access.page',
},
},
{
name: 'AccessBackendButtonControl',
path: 'button-control',
component: '/demos/access/backend/button-control',
meta: {
icon: 'mdi:button-cursor',
title: 'page.demos.access.button',
},
},
roleWithMenus[role],
],
},
],
},
],
},
];
};
const MOCK_MENUS = [
{
menus: [...dashboardMenus],
menus: [...dashboardMenus, ...createDemosMenus('super')],
userId: 0,
},
{
menus: [...dashboardMenus],
menus: [...dashboardMenus, ...createDemosMenus('admin')],
userId: 1,
},
{
menus: [...dashboardMenus, ...createDemosMenus('user')],
userId: 2,
},
];
return MOCK_MENUS.find((item) => item.userId === userId)?.menus ?? [];

View File

@@ -18,4 +18,11 @@ async function getUserInfo() {
return requestClient.get<UserInfo>('/auth/getUserInfo');
}
export { getUserInfo, userLogin };
/**
* 获取用户权限码
*/
async function getAccessCodes() {
return requestClient.get<string[]>('/auth/getAccessCodes');
}
export { getAccessCodes, getUserInfo, userLogin };

View File

@@ -61,7 +61,7 @@ const routes: RouteRecordRaw[] = [
component: () =>
import('#/views/demos/access/frontend/access-test-1.vue'),
meta: {
authority: ['admin'],
authority: ['super'],
icon: 'mdi:button-cursor',
title: $t('page.demos.access.access-test-1'),
},
@@ -72,7 +72,7 @@ const routes: RouteRecordRaw[] = [
component: () =>
import('#/views/demos/access/frontend/access-test-2.vue'),
meta: {
authority: ['user'],
authority: ['admin'],
icon: 'mdi:button-cursor',
title: $t('page.demos.access.access-test-2'),
},
@@ -83,7 +83,7 @@ const routes: RouteRecordRaw[] = [
component: () =>
import('#/views/demos/access/frontend/access-test-3.vue'),
meta: {
authority: ['super'],
authority: ['user'],
icon: 'mdi:button-cursor',
title: $t('page.demos.access.access-test-3'),
},
@@ -109,16 +109,6 @@ const routes: RouteRecordRaw[] = [
title: $t('page.demos.access.page'),
},
},
{
name: 'AccessBackendButtonControl',
path: 'button-control',
component: () =>
import('#/views/demos/access/frontend/button-control.vue'),
meta: {
icon: 'mdi:button-cursor',
title: $t('page.demos.access.button'),
},
},
],
},
],

View File

@@ -10,7 +10,7 @@ import { useCoreAccessStore } from '@vben-core/stores';
import { defineStore } from 'pinia';
import { getUserInfo, userLogin } from '#/apis';
import { getAccessCodes, getUserInfo, userLogin } from '#/apis';
export const useAccessStore = defineStore('access', () => {
const coreStoreAccess = useCoreAccessStore();
@@ -55,9 +55,15 @@ export const useAccessStore = defineStore('access', () => {
// 获取用户信息并存储到 accessStore 中
// Get user information and store it in accessStore
userInfo = await fetchUserInfo();
const [fetchUserInfoResult, accessCodes] = await Promise.all([
fetchUserInfo(),
getAccessCodes(),
]);
userInfo = fetchUserInfoResult;
coreStoreAccess.setUserInfo(userInfo);
coreStoreAccess.setAccessCodes(accessCodes);
onSuccess
? await onSuccess?.()

View File

@@ -0,0 +1,13 @@
<script lang="ts" setup>
import { Fallback } from '@vben/universal-ui';
defineOptions({ name: 'AccessFrontendAccessTest1' });
</script>
<template>
<Fallback
description="当前页面仅 Super 账号可见"
status="comming-soon"
title="页面访问测试"
/>
</template>

View File

@@ -0,0 +1,13 @@
<script lang="ts" setup>
import { Fallback } from '@vben/universal-ui';
defineOptions({ name: 'AccessFrontendAccessTest2' });
</script>
<template>
<Fallback
description="当前页面仅 Admin 账号可见"
status="comming-soon"
title="页面访问测试"
/>
</template>

View File

@@ -0,0 +1,13 @@
<script lang="ts" setup>
import { Fallback } from '@vben/universal-ui';
defineOptions({ name: 'AccessFrontendAccessTest1' });
</script>
<template>
<Fallback
description="当前页面仅 User 可见"
status="comming-soon"
title="页面访问测试"
/>
</template>

View File

@@ -1,9 +1,118 @@
<script lang="ts" setup>
import { Fallback } from '@vben/universal-ui';
import type { LoginAndRegisterParams } from '@vben/universal-ui';
defineOptions({ name: 'AccessBackendButtonControl' });
import { useRouter } from 'vue-router';
import { CodeAuthority, useAccess } from '@vben/access';
import { Button } from 'ant-design-vue';
import { useAccessStore, useAppStore } from '#/store';
defineOptions({ name: 'AccessBackend' });
const accounts: Record<string, LoginAndRegisterParams> = {
admin: {
password: '123456',
username: 'admin',
},
super: {
password: '123456',
username: 'vben',
},
user: {
password: '123456',
username: 'jack',
},
};
const { accessMode, hasAuthByCodes } = useAccess();
const accessStore = useAccessStore();
const appStore = useAppStore();
const router = useRouter();
function roleButtonType(role: string) {
return accessStore.userRoles.includes(role) ? 'primary' : 'default';
}
async function changeAccount(role: string) {
if (accessStore.userRoles.includes(role)) {
return;
}
const account = accounts[role];
await appStore.resetAppState();
await accessStore.authLogin(account, async () => {
router.go(0);
});
}
</script>
<template>
<Fallback status="comming-soon" />
<div class="p-5">
<div class="card-box p-5">
<h1 class="text-xl font-semibold">后端页面访问权限演示</h1>
<div class="text-foreground/80 mt-2">切换不同的账号观察按钮变化</div>
</div>
<template v-if="accessMode === 'backend'">
<div class="card-box mt-5 p-5 font-semibold">
<div class="mb-3">
<span class="text-lg">当前账号:</span>
<span class="text-primary mx-4">
{{ accessStore.userRoles }}
</span>
</div>
<Button :type="roleButtonType('super')" @click="changeAccount('super')">
切换为 Super 账号
</Button>
<Button
:type="roleButtonType('admin')"
class="mx-4"
@click="changeAccount('admin')"
>
切换为 Admin 账号
</Button>
<Button :type="roleButtonType('user')" @click="changeAccount('user')">
切换为 User 账号
</Button>
</div>
<div class="card-box mt-5 p-5 font-semibold">
<div class="mb-3 text-lg">组件形式控制</div>
<CodeAuthority :value="['AC_100100']">
<Button class="mr-4"> Super 账号可见 ["AC_1000001"] </Button>
</CodeAuthority>
<CodeAuthority :value="['AC_100030']">
<Button class="mr-4"> Admin 账号可见 ["AC_100010"] </Button>
</CodeAuthority>
<CodeAuthority :value="['AC_1000001']">
<Button class="mr-4"> User 账号可见 ["AC_1000001"] </Button>
</CodeAuthority>
<CodeAuthority :value="['AC_100100', 'AC_100010']">
<Button class="mr-4">
Super & Admin 账号可见 ["AC_100100","AC_1000001"]
</Button>
</CodeAuthority>
</div>
<div class="card-box mt-5 p-5 font-semibold">
<div class="mb-3 text-lg">函数形式控制</div>
<Button v-if="hasAuthByCodes(['AC_100100'])" class="mr-4">
Super 账号可见 ["AC_1000001"]
</Button>
<Button v-if="hasAuthByCodes(['AC_100030'])" class="mr-4">
Admin 账号可见 ["AC_100010"]
</Button>
<Button v-if="hasAuthByCodes(['AC_1000001'])" class="mr-4">
User 账号可见 ["AC_1000001"]
</Button>
<Button v-if="hasAuthByCodes(['AC_100100', 'AC_1000001'])" class="mr-4">
Super & Admin 账号可见 ["AC_100100","AC_1000001"]
</Button>
</div>
</template>
</div>
</template>

View File

@@ -1,9 +1,101 @@
<script lang="ts" setup>
import { Fallback } from '@vben/universal-ui';
import type { LoginAndRegisterParams } from '@vben/universal-ui';
defineOptions({ name: 'AccessFrontend' });
import { useRouter } from 'vue-router';
import { useAccess } from '@vben/access';
import { Button } from 'ant-design-vue';
import { useAccessStore, useAppStore } from '#/store';
defineOptions({ name: 'AccessBackend' });
const accounts: Record<string, LoginAndRegisterParams> = {
admin: {
password: '123456',
username: 'admin',
},
super: {
password: '123456',
username: 'vben',
},
user: {
password: '123456',
username: 'jack',
},
};
const { accessMode, toggleAccessMode } = useAccess();
const accessStore = useAccessStore();
const appStore = useAppStore();
const router = useRouter();
function roleButtonType(role: string) {
return accessStore.userRoles.includes(role) ? 'primary' : 'default';
}
async function changeAccount(role: string) {
if (accessStore.userRoles.includes(role)) {
return;
}
const account = accounts[role];
await appStore.resetAppState();
await accessStore.authLogin(account, async () => {
router.go(0);
});
}
async function handleToggleAccessMode() {
await toggleAccessMode();
await appStore.resetAppState();
await accessStore.authLogin(accounts.super, async () => {
router.go(0);
});
}
</script>
<template>
<Fallback status="comming-soon" />
<div class="p-5">
<div class="card-box p-5">
<h1 class="text-xl font-semibold">后端页面访问权限演示</h1>
<div class="text-foreground/80 mt-2">
切换不同的账号观察左侧菜单变化
</div>
</div>
<div class="card-box mt-5 p-5 font-semibold">
<span class="text-lg">当前权限模式:</span>
<span class="text-primary mx-4">{{ accessMode }}</span>
<Button type="primary" @click="handleToggleAccessMode">
切换为{{ accessMode === 'frontend' ? '后端' : '前端' }}权限模式
</Button>
</div>
<template v-if="accessMode === 'backend'">
<div class="card-box mt-5 p-5 font-semibold">
<div class="mb-3">
<span class="text-lg">当前账号:</span>
<span class="text-primary mx-4">
{{ accessStore.userRoles }}
</span>
</div>
<Button :type="roleButtonType('super')" @click="changeAccount('super')">
切换为 Super 账号
</Button>
<Button
:type="roleButtonType('admin')"
class="mx-4"
@click="changeAccount('admin')"
>
切换为 Admin 账号
</Button>
<Button :type="roleButtonType('user')" @click="changeAccount('user')">
切换为 User 账号
</Button>
</div>
</template>
</div>
</template>

View File

@@ -6,7 +6,7 @@ defineOptions({ name: 'AccessFrontendAccessTest1' });
<template>
<Fallback
description="当前页面仅 Admin 角色可见"
description="当前页面仅 Super 角色可见"
status="comming-soon"
title="页面访问测试"
/>

View File

@@ -6,7 +6,7 @@ defineOptions({ name: 'AccessFrontendAccessTest2' });
<template>
<Fallback
description="当前页面仅 User 角色可见"
description="当前页面仅 Admin 角色可见"
status="comming-soon"
title="页面访问测试"
/>

View File

@@ -6,7 +6,7 @@ defineOptions({ name: 'AccessFrontendAccessTest1' });
<template>
<Fallback
description="当前页面仅 Super 角色可见"
description="当前页面仅 User 角色可见"
status="comming-soon"
title="页面访问测试"
/>

View File

@@ -3,7 +3,7 @@ import type { LoginAndRegisterParams } from '@vben/universal-ui';
import { useRouter } from 'vue-router';
import { RoleAuthority, useAccess } from '@vben/access';
import { CodeAuthority, RoleAuthority, useAccess } from '@vben/access';
import { Button } from 'ant-design-vue';
@@ -11,7 +11,7 @@ import { useAccessStore, useAppStore } from '#/store';
defineOptions({ name: 'AccessFrontendButtonControl' });
const { accessMode, hasAuthByRole } = useAccess();
const { accessMode, hasAuthByCodes, hasAuthByRoles } = useAccess();
const accessStore = useAccessStore();
const appStore = useAppStore();
const router = useRouter();
@@ -80,34 +80,68 @@ async function changeAccount(role: string) {
</Button>
</div>
<div class="card-box mt-5 p-5 font-semibold">
<div class="mb-3 text-lg">组件形式控制</div>
<RoleAuthority :roles="['super']">
<div class="mb-3 text-lg">角色 - 组件形式控制</div>
<RoleAuthority :value="['super']">
<Button class="mr-4"> Super 角色可见 </Button>
</RoleAuthority>
<RoleAuthority :roles="['admin']">
<RoleAuthority :value="['admin']">
<Button class="mr-4"> Admin 角色可见 </Button>
</RoleAuthority>
<RoleAuthority :roles="['user']">
<RoleAuthority :value="['user']">
<Button class="mr-4"> User 角色可见 </Button>
</RoleAuthority>
<RoleAuthority :roles="['super', 'admin']">
<Button class="mr-4"> Super Admin 角色都可见 </Button>
<RoleAuthority :value="['super', 'admin']">
<Button class="mr-4"> Super & Admin 角色都可见 </Button>
</RoleAuthority>
</div>
<div class="card-box mt-5 p-5 font-semibold">
<div class="mb-3 text-lg">函数形式控制</div>
<Button v-if="hasAuthByRole(['super'])" class="mr-4">
<div class="mb-3 text-lg">角色 - 函数形式控制</div>
<Button v-if="hasAuthByRoles(['super'])" class="mr-4">
Super 角色可见
</Button>
<Button v-if="hasAuthByRole(['admin'])" class="mr-4">
<Button v-if="hasAuthByRoles(['admin'])" class="mr-4">
Admin 角色可见
</Button>
<Button v-if="hasAuthByRole(['user'])" class="mr-4">
<Button v-if="hasAuthByRoles(['user'])" class="mr-4">
User 角色可见
</Button>
<Button v-if="hasAuthByRole(['super', 'admin'])" class="mr-4">
Super Admin 角色都可见
<Button v-if="hasAuthByRoles(['super', 'admin'])" class="mr-4">
Super & Admin 角色都可见
</Button>
</div>
<div class="card-box mt-5 p-5 font-semibold">
<div class="mb-3 text-lg">权限码 - 组件形式控制</div>
<CodeAuthority :value="['AC_100100']">
<Button class="mr-4"> Super 账号可见 ["AC_1000001"] </Button>
</CodeAuthority>
<CodeAuthority :value="['AC_100030']">
<Button class="mr-4"> Admin 账号可见 ["AC_100010"] </Button>
</CodeAuthority>
<CodeAuthority :value="['AC_1000001']">
<Button class="mr-4"> User 账号可见 ["AC_1000001"] </Button>
</CodeAuthority>
<CodeAuthority :value="['AC_100100', 'AC_100010']">
<Button class="mr-4">
Super & Admin 账号可见 ["AC_100100","AC_1000001"]
</Button>
</CodeAuthority>
</div>
<div class="card-box mt-5 p-5 font-semibold">
<div class="mb-3 text-lg">权限码 - 函数形式控制</div>
<Button v-if="hasAuthByCodes(['AC_100100'])" class="mr-4">
Super 账号可见 ["AC_1000001"]
</Button>
<Button v-if="hasAuthByCodes(['AC_100030'])" class="mr-4">
Admin 账号可见 ["AC_100010"]
</Button>
<Button v-if="hasAuthByCodes(['AC_1000001'])" class="mr-4">
User 账号可见 ["AC_1000001"]
</Button>
<Button v-if="hasAuthByCodes(['AC_100100', 'AC_1000001'])" class="mr-4">
Super & Admin 账号可见 ["AC_100100","AC_1000001"]
</Button>
</div>
</template>

View File

@@ -56,12 +56,6 @@ async function changeAccount(role: string) {
</div>
<template v-if="accessMode === 'frontend'">
<div class="card-box mt-5 p-5 font-semibold">
<span class="text-lg">当前权限模式:</span>
<span class="text-primary mx-4">{{ accessMode }}</span>
<Button type="primary">切换权限模式</Button>
</div>
<div class="card-box mt-5 p-5 font-semibold">
<div class="mb-3">
<span class="text-lg">当前账号:</span>