权限控制

---

本文采用 Sa-Token 框架实现权限控制。官方文档传送门

权限校验

权限校验指的是校验用户是否拥有访问某个 API 的能力。

通常情况下，一个 API 对应一个权限码，如果用户具备当前 API 的权限码，即代表有能力访问该 API。

1：权限标识

在本系统中，每一个菜单功能都有对应的权限标识，可以在菜单管理中进行设置。

注：
1. 前后端的权限标识要保持一致。
2. 权限标识可以使用通配符*。

2：校验方法

2.1：使用 @SaCheckPermission 注解进行校验

@SaCheckPermission 注解是由 Sa-Token 框架提供的角色校验注解，可以标注在方法上或类上。

• 单个权限校验：

@SaCheckPermission("system:user:list")

• 多个权限校验（或模式，满足任意一个权限即可）：

@SaCheckPermission(
    value = {
        "system:user:list", 
        "system:user:query"
    }, 
    mode = SaMode.OR
)

• 多个权限校验（与模式，必须满足所有权限）：

@SaCheckPermission(
    value = {
        "system:user:list", 
        "system:user:query"
    }, 
    mode = SaMode.AND
)

2.2：使用 StpUtil 工具类校验

StpUtil 工具类是由 Sa-Token 框架提供的权限工具类，提供了常用的校验方法。

• 判断当前用户是否拥有某个权限（返回 boolean）：

StpUtil.hasPermission("system:user:list");

• 单个权限校验：

StpUtil.checkPermission("system:user:list");

如果验证未通过，则抛出异常: NotPermissionException

• 多个权限校验（或模式，满足任意一个权限即可）：

StpUtil.checkPermissionOr("system:user:list", "system:user:query");

如果验证未通过，则抛出异常: NotPermissionException

• 多个权限校验（与模式，必须满足所有权限）：

StpUtil.checkPermissionAnd("system:user:list", "system:user:query");

如果验证未通过，则抛出异常: NotPermissionException

角色校验

角色校验指的是校验用户是否拥有某个指定角色。

1：权限标识

在本系统中，每个角色都拥有唯一的权限字符。

除了超级管理员角色外，其他角色的权限字符可以通过角色管理进行设置。

2：校验方法

2.1：使用 @SaCheckRole 注解校验

@SaCheckRole 注解是由 Sa-Token 框架提供的角色校验注解，可以标注在方法上或类上。

• 单个角色校验

@SaCheckRole("superadmin")

• 多个角色校验（或模式，满足任意一个角色即可）：

@SaCheckRole(
    value = {
        "superadmin", 
        "admin"
    }, 
    mode = SaMode.OR
)

• 多个角色校验（与模式，必须满足所有角色）：

@SaCheckRole(
    value = {
        "superadmin", 
        "admin"
    }, 
    mode = SaMode.AND
)

2.2：使用 StpUtil 工具类校验

StpUtil 工具类是由 Sa-Token 框架提供的权限工具类，提供了常用的校验方法。

• 判断当前用户是否拥有某个角色（返回 boolean）：

StpUtil.hasRole("superadmin")

• 单个权限校验：

StpUtil.checkRole("system:user:list");

如果验证未通过，则抛出异常: NotRoleException

• 多个权限校验（或模式，满足任意一个角色即可）：

StpUtil.checkRoleOr("system:user:list", "system:user:query");

如果验证未通过，则抛出异常: NotRoleException

• 多个权限校验（与模式，必须满足所有角色）：

StpUtil.checkRoleAnd("system:user:list", "system:user:query");

如果验证未通过，则抛出异常: NotRoleException

角色权限双重 OR 校验

除了分开校验以外，权限和角色也可以进行组合，表示备选校验。

简单举个例子：

假设某个 API 的权限码为 system:user:list，角色 admin 可以调用，则可以这样写：

@SaCheckPermission(value = "system:user:list", orRole = "admin")

以上权限只需要满足任意一项即可。更多写法可以参考 Sa-Token 官方文档。

当前用户的所有权限

本系统中实现了 StpInterface 接口，可以对用户的权限以及角色进行管理，并且可以根据不同的用户类型进行设置。

具体参考类：org.dromara.common.satoken.core.service.SaPermissionImpl

忽略权限校验

请参考文档：网关路由与放行