sa-token/sa-token-doc/doc/use/at-check.md

70 lines
2.1 KiB
Markdown
Raw Normal View History

2020-03-07 14:40:15 +08:00
# 注解式鉴权
---
- 尽管我们可以方便的一句代码完成权限验证,但是有时候我们仍希望可以将鉴权代码与我们的业务代码分离开来
- 怎么做?
2020-09-07 02:21:35 +08:00
- `sa-token`内置两个注解,帮助你使用注解完成鉴权操作
2020-03-07 14:40:15 +08:00
## 1、注册拦截器
- 为了不为项目带来不必要的性能负担,`sa-token`默认没有强制为项目注册全局拦截器
- 因此,为了使用注解式鉴权功能,你必须手动将`sa-token`的全局拦截器注册到你项目中
- 以`springboot2.0`为例, 新建配置类`MySaTokenConfig.java`
``` java
@Configuration
2020-06-15 22:06:16 +08:00
public class MySaTokenConfig implements WebMvcConfigurer {
2020-03-07 14:40:15 +08:00
// 注册sa-token的拦截器打开注解式鉴权功能
@Override
public void addInterceptors(InterceptorRegistry registry) {
2020-05-02 15:19:55 +08:00
registry.addInterceptor(new SaCheckInterceptor()).addPathPatterns("/**"); // 全局拦截器
2020-03-07 14:40:15 +08:00
}
}
```
2020-09-07 02:21:35 +08:00
- 保证此类被`springboot`启动类扫描到
2020-03-07 14:40:15 +08:00
## 2、使用注解
#### 登录验证
``` java
@SaCheckLogin // 注解式鉴权:当前会话必须登录才能通过
@RequestMapping("info")
public String info() {
return "查询用户信息";
}
```
#### 权限验证
``` java
@SaCheckPermission("user-add") // 注解式鉴权:当前会话必须具有指定权限才能通过
@RequestMapping("add")
public String add() {
return "用户增加";
}
```
#### 注意事项
2020-05-02 15:19:55 +08:00
以上两个注解都可以加在类上,代表为这个类所有方法进行鉴权
## 3、扩展
- 其实在注册拦截器时,我们也可以根据路由前缀设置不同 `StpLogic`, 从而达到不同模块不同鉴权方式的目的
- 以下为参考示例:
``` java
@Configuration
2020-06-15 22:08:43 +08:00
public class MySaTokenConfig implements WebMvcConfigurer {
2020-05-02 15:19:55 +08:00
// 注册sa-token的拦截器打开注解式鉴权功能
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new SaCheckInterceptor(StpUtil.stpLogic)).addPathPatterns("/admin/**");
registry.addInterceptor(new SaCheckInterceptor(StpUserUtil.stpLogic)).addPathPatterns("/user/**");
}
}
```