React中的權限組件設計問題小結
背景
權限管理是中後臺系統中常見的需求之一。之前做過基於 Vue 的後臺管理系統權限控制,基本思路就是在一些路由鉤子裡做權限比對和攔截處理。
最近維護的一個後臺系統需要加入權限管理控制,這次技術棧是React
,我剛開始是在網上搜索一些React路由權限控制
,但是沒找到比較好的方案或思路。
這時想到ant design pro
內部實現過權限管理,因此就專門花時間翻閱瞭一波源碼,並在此基礎上逐漸完成瞭這次的權限管理。
整個過程也是遇到瞭很多問題,本文主要來做一下此次改造工作的總結。
原代碼基於 react 16.x、dva 2.4.1 實現,所以本文是參考瞭ant-design-pro v1內部對權限管理的實現
所謂的權限控制是什麼?
一般後臺管理系統的權限涉及到兩種:
- 資源權限
- 數據權限
資源權限一般指菜單、頁面、按鈕等的可見權限。
數據權限一般指對於不同用戶,同一頁面上看到的數據不同。
本文主要是來探討一下資源權限,也就是前端權限控制。這又分為瞭兩部分:
- 側邊欄菜單
- 路由權限
在很多人的理解中,前端權限控制就是左側菜單的可見與否,其實這是不對的。舉一個例子,假設用戶guest
沒有路由/setting
的訪問權限,但是他知道/setting
的完整路徑,直接通過輸入路徑的方式訪問,此時仍然是可以訪問的。這顯然是不合理的。這部分其實就屬於路由層面的權限控制。
實現思路
關於前端權限控制一般有兩種方案:
- 前端固定路由表和權限配置,由後端提供用戶權限標識
- 後端提供權限和路由信息結構接口,動態生成權限和菜單
我們這裡采用的是第一種方案,服務隻下發當前用戶擁有的角色就可以瞭,路由表和權限的處理統一在前端處理。
整體實現思路也比較簡單:現有權限(currentAuthority
)和準入權限(authority
)做比較,如果匹配則渲染和準入權限匹配的組件,否則渲染無權限組件
(403 頁面)
路由權限
既然是路由相關的權限控制,我們免不瞭先看一下當前的路由表:
{ "name": "活動列表", "path": "/activity-mgmt/list", "key": "/activity-mgmt/list", "exact": true, "authority": [ "admin" ], "component": ƒ LoadableComponent(props), "inherited": false, "hideInBreadcrumb": false }, { "name": "優惠券管理", "path": "/coupon-mgmt/coupon-rule-bplist", "key": "/coupon-mgmt/coupon-rule-bplist", "exact": true, "authority": [ "admin", "coupon" ], "component": ƒ LoadableComponent(props), "inherited": true, "hideInBreadcrumb": false }, { "name": "營銷錄入系統", "path": "/marketRule-manage", "key": "/marketRule-manage", "exact": true, "component": ƒ LoadableComponent(props), "inherited": true, "hideInBreadcrumb": false }
這份路由表其實是我從控制臺 copy 過來的,內部做瞭很多的轉換處理,但最終生成的就是上面這個對象。
這裡每一級菜單都加瞭一個authority
字段來標識允許訪問的角色。component
代表路由對應的組件:
import React, { createElement } from "react" import Loadable from "react-loadable" "/activity-mgmt/list": { component: dynamicWrapper(app, ["activityMgmt"], () => import("../routes/activity-mgmt/list")) }, // 動態引用組件並註冊model const dynamicWrapper = (app, models, component) => { // register models models.forEach(model => { if (modelNotExisted(app, model)) { // eslint-disable-next-line app.model(require(`../models/${model}`).default) } }) // () => require('module') // transformed by babel-plugin-dynamic-import-node-sync // 需要將routerData塞到props中 if (component.toString().indexOf(".then(") < 0) { return props => { return createElement(component().default, { ...props, routerData: getRouterDataCache(app) }) } } // () => import('module') return Loadable({ loader: () => { return component().then(raw => { const Component = raw.default || raw return props => createElement(Component, { ...props, routerData: getRouterDataCache(app) }) }) }, // 全局loading loading: () => { return ( <div style={{ display: "flex", justifyContent: "center", alignItems: "center" }} > <Spin size="large" className="global-spin" /> </div> ) } }) } 復制代碼
有瞭路由表這份基礎數據,下面就讓我們來看下如何通過一步步的改造給原有系統註入權限。
先從src/router.js
這個入口開始著手:
// 原src/router.js import dynamic from "dva/dynamic" import { Redirect, Route, routerRedux, Switch } from "dva/router" import PropTypes from "prop-types" import React from "react" import NoMatch from "./components/no-match" import App from "./routes/app" const { ConnectedRouter } = routerRedux const RouterConfig = ({ history, app }) => { const routes = [ { path: "activity-management", models: () => [import("@/models/activityManagement")], component: () => import("./routes/activity-mgmt") }, { path: "coupon-management", models: () => [import("@/models/couponManagement")], component: () => import("./routes/coupon-mgmt") }, { path: "order-management", models: () => [import("@/models/orderManagement")], component: () => import("./routes/order-maint") }, { path: "merchant-management", models: () => [import("@/models/merchantManagement")], component: () => import("./routes/merchant-mgmt") } // ... ] return ( <ConnectedRouter history={history}> <App> <Switch> {routes.map(({ path, ...dynamics }, key) => ( <Route key={key} path={`/${path}`} component={dynamic({ app, ...dynamics })} /> ))} <Route component={NoMatch} /> </Switch> </App> </ConnectedRouter> ) } RouterConfig.propTypes = { history: PropTypes.object, app: PropTypes.object } export default RouterConfig
這是一個非常常規的路由配置,既然要加入權限,比較合適的方式就是包一個高階組件AuthorizedRoute
。然後router.js
就可以更替為:
function RouterConfig({ history, app }) { const routerData = getRouterData(app) const BasicLayout = routerData["/"].component return ( <ConnectedRouter history={history}> <Switch> <AuthorizedRoute path="/" render={props => <BasicLayout {...props} />} /> </Switch> </ConnectedRouter> ) }
來看下AuthorizedRoute
的大致實現:
const AuthorizedRoute = ({ component: Component, authority, redirectPath, {...rest} }) => { if (authority === currentAuthority) { return ( <Route {...rest} render={props => <Component {...props} />} /> ) } else { return ( <Route {...rest} render={() => <Redirect to={redirectPath} /> } /> ) } }
我們看一下這個組件有什麼問題:頁面可能允許多個角色訪問,用戶擁有的角色也可能是多個(可能是字符串,也可呢是數組)。
直接在組件中判斷顯然不太合適,我們把這部分邏輯抽離出來:
/** * 通用權限檢查方法 * Common check permissions method * @param { 菜單訪問需要的權限 } authority * @param { 當前角色擁有的權限 } currentAuthority * @param { 通過的組件 Passing components } target * @param { 未通過的組件 no pass components } Exception */ const checkPermissions = (authority, currentAuthority, target, Exception) => { console.log("checkPermissions -----> authority", authority) console.log("currentAuthority", currentAuthority) console.log("target", target) console.log("Exception", Exception) // 沒有判定權限.默認查看所有 // Retirement authority, return target; if (!authority) { return target } // 數組處理 if (Array.isArray(authority)) { // 該菜單可由多個角色訪問 if (authority.indexOf(currentAuthority) >= 0) { return target } // 當前用戶同時擁有多個角色 if (Array.isArray(currentAuthority)) { for (let i = 0; i < currentAuthority.length; i += 1) { const element = currentAuthority[i] // 菜單訪問需要的角色權限 < ------ > 當前用戶擁有的角色 if (authority.indexOf(element) >= 0) { return target } } } return Exception } // string 處理 if (typeof authority === "string") { if (authority === currentAuthority) { return target } if (Array.isArray(currentAuthority)) { for (let i = 0; i < currentAuthority.length; i += 1) { const element = currentAuthority[i] if (authority.indexOf(element) >= 0) { return target } } } return Exception } throw new Error("unsupported parameters") } const check = (authority, target, Exception) => { return checkPermissions(authority, CURRENT, target, Exception) }
首先如果路由表中沒有authority
字段默認都可以訪問。
接著分別對authority
為字符串和數組的情況做瞭處理,其實就是簡單的查找匹配,匹配到瞭就可以訪問,匹配不到就返回Exception
,也就是我們自定義的異常頁面。
有一個點一直沒有提:用戶當前角色權限
currentAuthority
如何獲取?這個是在頁面初始化時從接口讀取,然後存到store
中
有瞭這塊邏輯,我們對剛剛的AuthorizedRoute
做一下改造。首先抽象一個Authorized
組件,對權限校驗邏輯做一下封裝:
import React from "react" import CheckPermissions from "./CheckPermissions" class Authorized extends React.Component { render() { const { children, authority, noMatch = null } = this.props const childrenRender = typeof children === "undefined" ? null : children return CheckPermissions(authority, childrenRender, noMatch) } } export default Authorized
接著AuthorizedRoute
可直接使用Authorized
組件:
import React from "react" import { Redirect, Route } from "react-router-dom" import Authorized from "./Authorized" class AuthorizedRoute extends React.Component { render() { const { component: Component, render, authority, redirectPath, ...rest } = this.props return ( <Authorized authority={authority} noMatch={<Route {...rest} render={() => <Redirect to={{ pathname: redirectPath }} />} />} > <Route {...rest} render={props => (Component ? <Component {...props} /> : render(props))} /> </Authorized> ) } } export default AuthorizedRoute
這裡采用瞭render props
的方式:如果提供瞭component props
就用component
渲染,否則使用render
渲染。
菜單權限
菜單權限的處理相對就簡單很多瞭,統一集成到SiderMenu
組件處理:
export default class SiderMenu extends PureComponent { constructor(props) { super(props) } /** * get SubMenu or Item */ getSubMenuOrItem = item => { if (item.children && item.children.some(child => child.name)) { const childrenItems = this.getNavMenuItems(item.children) // 當無子菜單時就不展示菜單 if (childrenItems && childrenItems.length > 0) { return ( <SubMenu title={ item.icon ? ( <span> {getIcon(item.icon)} <span>{item.name}</span> </span> ) : ( item.name ) } key={item.path} > {childrenItems} </SubMenu> ) } return null } return <Menu.Item key={item.path}>{this.getMenuItemPath(item)}</Menu.Item> } /** * 獲得菜單子節點 * @memberof SiderMenu */ getNavMenuItems = menusData => { if (!menusData) { return [] } return menusData .filter(item => item.name && !item.hideInMenu) .map(item => { // make dom const ItemDom = this.getSubMenuOrItem(item) return this.checkPermissionItem(item.authority, ItemDom) }) .filter(item => item) } /** * * @description 菜單權限過濾 * @param {*} authority * @param {*} ItemDom * @memberof SiderMenu */ checkPermissionItem = (authority, ItemDom) => { const { Authorized } = this.props if (Authorized && Authorized.check) { const { check } = Authorized return check(authority, ItemDom) } return ItemDom } render() { // ... return <Sider trigger={null} collapsible collapsed={collapsed} breakpoint="lg" onCollapse={onCollapse} className={siderClass} > <div className="logo"> <Link to="/home" className="logo-link"> {!collapsed && <h1>馮言馮語</h1>} </Link> </div> <Menu key="Menu" theme={theme} mode={mode} {...menuProps} onOpenChange={this.handleOpenChange} selectedKeys={selectedKeys} > {this.getNavMenuItems(menuData)} </Menu> </Sider> } }
這裡我隻貼瞭一些核心代碼,其中的checkPermissionItem
就是實現菜單權限的關鍵。他同樣用到瞭上文中的check
方法來對當前菜單進行權限比對,如果沒有權限就直接不展示當前菜單。
到此這篇關於React中的權限組件設計的文章就介紹到這瞭,更多相關React權限組件內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!
推薦閱讀:
- React路由封裝的實現淺析
- React路由攔截模式及withRouter示例詳解
- React-Router6版本的更新引起的路由用法變化
- react實現移動端二級路由嵌套詳解
- react路由守衛的實現(路由攔截)