秀杰智联

Appearance

权限控制 ​

一、菜单权限 ​

菜单权限可以控制web后台菜单功能，每个菜单可以绑定一个或多个API权限，API权限决定了用户是否可以调用服务端接口。

为角色添加菜单权限 ​

1、XiuAdmin后台 -> 系统管理 -> 菜单管理 -> 找到添加菜单，按照表单提示添加你的菜单信息。

2、添加菜单完成后，到 系统管理 -> 角色管理 -> 找到一位已有角色或者添加新角色 -> 在列表右侧操作栏找到菜单权限打开 -> 将第1步中添加的菜单分配给该角色即可。

细粒度权限 ​

一般用于web后台页面上的功能按钮，对不同的角色展示不同的按钮时会用到。

1、参考【为角色添加菜单权限】添加一个按钮类型的菜单。并为菜单分配API权限，假设你分配权限是：system:post:export

2、在web页面中创建一个按钮，如下：

vue
<template>
  <div>
    <!-- 权限校验方式1 begin -->
    <Button  v-access:code="'cpm:system:post:export'">拥有菜单的[system:post:export]权限可见</Button>
    <Button  v-access:code="'cpr:roletest'">拥有角色的[roletest]权限可见</Button>
    <!-- 权限校验方式1 end -->

    <!-- 权限校验方式2 begin -->
     <AccessControl :codes="['cpm:system:post:export']" type="code">
        <Button>拥有菜单的[system:post:export]权限可见</Button>
     </AccessControl>
    <!-- 权限校验方式2 end -->

    <!-- 权限校验方式3 begin -->
        <Button v-if="hasAccessByCodes(['cpm:system:post:export'])">拥有菜单的[system:post:export]权限可见</Button>
    <!-- 权限校验方式3 end -->  
  </div>
</template>

<script lang="ts" setup>
import { AccessControl, useAccess } from '@vben/access';
const { hasAccessByCodes } = useAccess();

</script>
// 权限码前缀说明
"cpr:"             // 角色权限码前缀+角色权限
"cpm:"             // 菜单权限码前缀+菜单权限
"cpd:"             // 部门权限码前缀+部门编码
"cpp:"             // 岗位权限码前缀+岗位编码
"cpu:"             // 用户权限码前缀+用户名
"cpc:current:user" // 当前登录用户默认权限

菜单表主要字段解释 ​

  • 代码片段：../../server/internal/model/entity/sys_menu.go
go
type SysMenu struct {
	MenuId      int64       `description:"菜单ID"`
	MenuName    string      `description:"菜单名称"`
	ParentId    int64       `description:"父菜单ID"`
	Level       int         `description:"关系树等级"`
	Tree        string      `description:"关系树"`
	OrderNum    int         `description:"显示顺序"`
	Path        string      `description:"路由地址"`
	Component   string      `description:"组件路径"`
	QueryParam  string      `description:"路由参数"`
	IsFrame     int         `description:"是否为外链（0是 1否）"`
	IsCache     int         `description:"是否缓存（0缓存 1不缓存）"`
	MenuType    string      `description:"菜单类型（M目录 C菜单 F按钮）"`
	Visible     string      `description:"显示状态（0显示 1隐藏）"`
	Status      string      `description:"菜单状态（0正常 1停用）"`
	Perms       string      `description:"权限标识"`
	Icon        string      `description:"菜单图标"`
	CreatedDept int64       `description:"创建部门"`
	CreatedBy   int64       `description:"创建者"`
	CreatedAt   *gtime.Time `description:"创建时间"`
	UpdatedBy   int64       `description:"更新者"`
	UpdatedAt   *gtime.Time `description:"更新时间"`
	Remark      string      `description:"备注"`
}

特殊逻辑 ​

隐藏菜单，激活上级菜单展示

配置菜单的 是否显示 visible字段为1，即可隐藏菜单
前端界面激活显示上级菜单需要配置路由地址
路由地址设置为 上级菜单路由地址-当前菜单路由地址

示例：
字典数据的上级菜单字典管理,在菜单不显示，激活上级菜单展示
字典管理配置路由地址 dict
字典数据配置路由地址应配置为 dict-data

后端接口权限配置 ​

接口文件 server/api/system/v1/post.go, 在接口的中g.Meta添加 x-check-permission tag，值为权限码，即可实现接口权限校验. 校验菜单的[system:post:list]权限,示例：

go
type PostListReq struct {
	g.Meta `path:"/post/list" method:"get" tags:"系统-岗位管理" summary:"获取岗位列表" x-check-permission:"cpm:system:post:list"`
	*model.SysPostListParam
}

API权限验证流程 ​

mermaid

graph TD
   A(用户请求API) --> B(验证中间件<br> server/internal/logic/middleware/middleware.go)
   B -->|没有登录,但API需要登录| H(提示登录)
   B -->|没有登录,但API不需要登录| G(验证通过,进入业务)
   B -->|已登录| C(检查用户角色是否拥有接口配置权限) -->|有权限| G(验证通过,进入业务)
   C -->|API无需验证权限| G(验证通过,进入业务流程)
   C -->|无权限| D(提示无权限)

菜单权限添加或修改后多久生效？ ​

  • API权限实时生效，web后台菜单刷新页面后生效，无需重启服务

二、数据权限 ​

数据权限是某人只能看到某些数据，可以为某人设置一定的数据范围，让其只能看到允许他看到的数据。

目前已经支持的数据权限如下 ​

1全部数据权限 2自定数据权限 3本部门数据权限 4本部门及以下数据权限 5仅本人数据权限 6本部门及以下或本人数据权限

数据范围描述
全部权限不做过滤，可以查看所有数据
自定义部门可以看到设置的指定部门，支持多个
本部门数据权限仅可以看到所属部门下的数据
本部门及以下数据权限仅可以看到所属以及下级部门的数据
仅本人数据权限仅可以看到自己的数据
本部门及以下或本人数据权限仅可以看到自己和全部下级的数据

如何区分部门和下级用户？ ​

  • 在实际使用时，部门更多的是在公司或机构中使用，可以通过在 组织管理 -> 后台用户 ->为用户绑定部门

如何判断数据是谁的？ ​

  • 在数据库建表时，只要表中包含字段：user_id或created_by即可过滤 [仅自己、本部门及以下或本人数据权限] 类型的数据权限
  • 在数据库建表时，只要表中包含字段：dept_id或created_dept即可过滤 [自定义部门、本部门、本部门及以下、本部门及以下或本人数据权限] 类型的数据权限

如何在具体业务中使用数据权限过滤？ ​

go
package main

import (
	"context"
	"xiuadmin/internal/dao"
	"xiuadmin/internal/library/xgorm/handler"
)

func test(ctx context.Context)  {
    dao.SysPost.Ctx(ctx).Where("id", 1).Handler(handler.FilterAuth).Scan(&res)
}