feat(router): 增加强制登录配置选项

添加 VITE_AUTH_ROUTE_FORCE_LOGIN 环境变量以控制是否强制用户登录
当设置为 Y 时,未登录用户访问非白名单路由将被重定向到登录页
同时更新开发环境配置并添加相应的 TypeScript 类型定义
This commit is contained in:
2026-01-27 10:01:55 +08:00
parent 5a48a65ef8
commit f6d2a643e8
4 changed files with 38 additions and 25 deletions

View File

@ -12,9 +12,9 @@ import { useRouteStore } from '@/store/modules/route'
import { localStg } from '@/utils/storage'
/**
* create route guard
* 创建路由守卫
*
* @param router router instance
* @param router 路由实例
*/
export function createRouteGuard(router: Router) {
router.beforeEach(async (to, from, next) => {
@ -38,39 +38,43 @@ export function createRouteGuard(router: Router) {
const hasRole = authStore.userInfo.roles.some(role => routeRoles.includes(role))
const hasAuth = authStore.isStaticSuper || !routeRoles.length || hasRole
// if it is login route when logged in, then switch to the root page
// 如果已登录且访问的是登录页,则跳转到根页面
if (to.name === loginRoute && isLogin) {
next({ name: rootRoute })
return
}
// if the route does not need login, then it is allowed to access directly
// 如果路由不需要登录,则直接允许访问
if (!needLogin) {
handleRouteSwitch(to, from, next)
return
}
// the route need login but the user is not logged in, then switch to the login page
if (!isLogin) {
// 如果路由需要登录但用户未登录,则跳转到登录页
const isAuthRouteForceLogin = import.meta.env.VITE_AUTH_ROUTE_FORCE_LOGIN === 'Y'
const whiteList: string[] = ['user']
const isInWhiteList = whiteList.includes(to.name as string)
if (isAuthRouteForceLogin && !isLogin && !isInWhiteList) {
next({ name: loginRoute, query: { redirect: to.fullPath } })
return
}
// if the user is logged in but does not have authorization, then switch to the 403 page
// 如果用户已登录但没有权限,则跳转到 403 页面
if (!hasAuth) {
next({ name: noAuthorizationRoute })
return
}
// switch route normally
// 正常跳转路由
handleRouteSwitch(to, from, next)
})
}
/**
* initialize route
* 初始化路由
*
* @param to to route
* @param to 目标路由
*/
async function initRoute(to: RouteLocationNormalized): Promise<RouteLocationRaw | null> {
const routeStore = useRouteStore()
@ -78,12 +82,12 @@ async function initRoute(to: RouteLocationNormalized): Promise<RouteLocationRaw
const notFoundRoute: RouteKey = 'not-found'
const isNotFoundRoute = to.name === notFoundRoute
// if the constant route is not initialized, then initialize the constant route
// 如果常量路由未初始化,则初始化常量路由
if (!routeStore.isInitConstantRoute) {
await routeStore.initConstantRoute()
// the route is captured by the "not-found" route because the constant route is not initialized
// after the constant route is initialized, redirect to the original route
// 由于常量路由未初始化,路由被“未找到”路由捕获
// 常量路由初始化后,重定向到原始路由
const path = to.fullPath
const location: RouteLocationRaw = {
path,
@ -97,15 +101,19 @@ async function initRoute(to: RouteLocationNormalized): Promise<RouteLocationRaw
const isLogin = Boolean(localStg.get('token'))
if (!isLogin) {
// if the user is not logged in and the route is a constant route but not the "not-found" route, then it is allowed to access.
const isAuthRouteForceLogin = import.meta.env.VITE_AUTH_ROUTE_FORCE_LOGIN === 'Y'
const whiteList: string[] = ['user']
const isInWhiteList = whiteList.includes(to.name as string)
if (isAuthRouteForceLogin && !isLogin && !isInWhiteList) {
// 如果用户未登录且路由是常量路由但不是“未找到”路由,则允许访问。
if (to.meta.constant && !isNotFoundRoute) {
routeStore.onRouteSwitchWhenNotLoggedIn()
return null
}
// if the user is not logged in, then switch to the login page
// 如果用户未登录,则跳转到登录页
const loginRoute: RouteKey = 'login'
const query = getRouteQueryOfLoginRoute(to, routeStore.routeHome)
@ -118,11 +126,11 @@ async function initRoute(to: RouteLocationNormalized): Promise<RouteLocationRaw
}
if (!routeStore.isInitAuthRoute) {
// initialize the auth route
// 初始化权限路由
await routeStore.initAuthRoute()
// the route is captured by the "not-found" route because the auth route is not initialized
// after the auth route is initialized, redirect to the original route
// 由于权限路由未初始化,路由被“未找到”路由捕获
// 权限路由初始化后,重定向到原始路由
if (isNotFoundRoute) {
const rootRoute: RouteKey = 'root'
const path = to.redirectedFrom?.name === rootRoute ? '/' : to.fullPath
@ -140,13 +148,13 @@ async function initRoute(to: RouteLocationNormalized): Promise<RouteLocationRaw
routeStore.onRouteSwitchWhenLoggedIn()
// the auth route is initialized
// it is not the "not-found" route, then it is allowed to access
// 权限路由已初始化
// 如果不是“未找到”路由,则允许访问
if (!isNotFoundRoute) {
return null
}
// it is captured by the "not-found" route, then check whether the route exists
// 如果被“未找到”路由捕获,则检查路由是否存在
const exist = await routeStore.getIsAuthRouteExist(to.path as RoutePath)
const noPermissionRoute: RouteKey = '403'
@ -162,7 +170,7 @@ async function initRoute(to: RouteLocationNormalized): Promise<RouteLocationRaw
}
function handleRouteSwitch(to: RouteLocationNormalized, from: RouteLocationNormalized, next: NavigationGuardNext) {
// route with href
// 外链路由
if (to.meta.href) {
window.open(to.meta.href, '_blank')

View File

@ -79,6 +79,8 @@ declare namespace Env {
* - Dynamic: the auth routes is generated in back-end
*/
readonly VITE_AUTH_ROUTE_MODE: 'static' | 'dynamic'
/** Whether to enforce login */
readonly VITE_AUTH_ROUTE_FORCE_LOGIN?: CommonType.YesOrNo
/**
* The home route key
*