lsm/sa-token
1
0
Fork 0
mirror of https://gitee.com/dromara/sa-token.git synced 2025-04-05 17:37:53 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

二级认证的注解相关文档

Browse Source
This commit is contained in:
click33 2021-06-19 00:00:57 +08:00
parent a73adf6727
commit 23c00b5d8e
4 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sa-token-core/src/main/java/cn/dev33/satoken/annotation/SaCheckLogin.java
View File

@ -6,7 +6,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target; import java.lang.annotation.Target;
/** /**
* 登录校验：只有登录之后才能进入该方法 * 登录认证：只有登录之后才能进入该方法
* <p> 可标注在函数、类上（效果等同于标注在此类的所有方法上） * <p> 可标注在函数、类上（效果等同于标注在此类的所有方法上）
* @author kong * @author kong
* *

2
sa-token-core/src/main/java/cn/dev33/satoken/annotation/SaCheckPermission.java
View File

@ -6,7 +6,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target; import java.lang.annotation.Target;
/** /**
* 权限校验：必须具有指定权限才能进入该方法 * 权限认证：必须具有指定权限才能进入该方法
* <p> 可标注在函数、类上（效果等同于标注在此类的所有方法上） * <p> 可标注在函数、类上（效果等同于标注在此类的所有方法上）
* @author kong * @author kong
* *

2
sa-token-core/src/main/java/cn/dev33/satoken/annotation/SaCheckRole.java
View File

@ -6,7 +6,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target; import java.lang.annotation.Target;
/** /**
* 角色校验：必须具有指定角色标识才能进入该方法 * 角色认证：必须具有指定角色标识才能进入该方法
* <p> 可标注在函数、类上（效果等同于标注在此类的所有方法上） * <p> 可标注在函数、类上（效果等同于标注在此类的所有方法上）
* @author kong * @author kong
* *

20
sa-token-doc/doc/use/at-check.md
View File

@ -5,9 +5,10 @@
注解鉴权 —— 优雅的将鉴权与业务代码分离！ 注解鉴权 —— 优雅的将鉴权与业务代码分离！
- `@SaCheckLogin`: 标注在方法或类上，当前会话必须处于登录状态才可通过校验 - `@SaCheckLogin`: 登录认证 —— 只有登录之后才能进入该方法
- `@SaCheckRole("admin")`: 标注在方法或类上，当前会话必须具有指定角色标识才能通过校验 - `@SaCheckRole("admin")`: 权限认证 —— 必须具有指定权限才能进入该方法
- `@SaCheckPermission("user:add")`: 标注在方法或类上，当前会话必须具有指定权限才能通过校验 - `@SaCheckPermission("user:add")`: 角色认证 —— 必须具有指定角色标识才能进入该方法
- `@SaCheckSafe`: 二级认证校验 —— 必须二级认证之后才能进入该方法
Sa-Token使用全局拦截器完成注解鉴权功能，为了不为项目带来不必要的性能负担，拦截器默认处于关闭状态<br> Sa-Token使用全局拦截器完成注解鉴权功能，为了不为项目带来不必要的性能负担，拦截器默认处于关闭状态<br>
因此，为了使用注解鉴权，你必须手动将sa-token的全局拦截器注册到你项目中 因此，为了使用注解鉴权，你必须手动将sa-token的全局拦截器注册到你项目中
@ -37,26 +38,33 @@ public class SaTokenConfigure implements WebMvcConfigurer {
然后我们就可以愉快的使用注解鉴权： 然后我们就可以愉快的使用注解鉴权：
``` java ``` java
// 登录认证：当前会话必须登录才能通过 // 登录认证：只有登录之后才能进入该方法
@SaCheckLogin @SaCheckLogin
@RequestMapping("info") @RequestMapping("info")
public String info() { public String info() {
return "查询用户信息"; return "查询用户信息";
} }
// 角色认证：当前会话必须具有指定角色标识才能通过 // 角色认证：必须具有指定角色才能进入该方法
@SaCheckRole("super-admin") @SaCheckRole("super-admin")
@RequestMapping("add") @RequestMapping("add")
public String add() { public String add() {
return "用户增加"; return "用户增加";
} }
// 权限认证：当前会话必须具有指定权限才能通过 // 权限认证：必须具有指定权限才能进入该方法
@SaCheckPermission("user-add") @SaCheckPermission("user-add")
@RequestMapping("add") @RequestMapping("add")
public String add() { public String add() {
return "用户增加"; return "用户增加";
} }
// 二级认证：必须二级认证之后才能进入该方法
@SaCheckSafe()
@RequestMapping("add")
public String add() {
return "用户增加";
}
``` ```
注：以上注解都可以加在类上，代表为这个类所有方法进行鉴权 注：以上注解都可以加在类上，代表为这个类所有方法进行鉴权