sa-token-quick-login 模块完毕

This commit is contained in:
shengzhang
2021-05-09 19:08:44 +08:00
parent ca2599c528
commit 0a7a8138b3
42 changed files with 1039 additions and 63 deletions
+30 -50
View File
@@ -1,58 +1,56 @@
# 注解式鉴权
---
有同学表示:尽管使用代码鉴权非常方便,但是我仍希望可以把鉴权逻辑和业务逻辑分离开来,我可以使用注解鉴权吗?<br>
当然可以!身为自诩java最强权限认证框架,怎么能少的了注解鉴权这一标配功能呢?
有同学表示:尽管使用代码鉴权非常方便,但是我仍希望把鉴权逻辑和业务逻辑分离开来,我可以使用注解鉴权吗?当然可以!<br>
注解鉴权 —— 优雅的将鉴权与业务代码分离!
- `@SaCheckLogin`: 标注在方法或类上,当前会话必须处于登录状态才可通过校验
- `@SaCheckRole("admin")`: 标注在方法或类上,当前会话必须具有指定角色标识才能通过校验
- `@SaCheckPermission("user:add")`: 标注在方法或类上,当前会话必须具有指定权限才能通过校验
sa-token内置两种模式完成注解鉴权,分别是`AOP模式`和`拦截器模式`, 为了避免不必要的性能浪费,这两种模式默认都处于关闭状态 <br>
因此如若使用注解鉴权,你必须选择其一进行注册
Sa-Token使用全局拦截器完成注解鉴权功能,为了不为项目带来不必要的性能负担,拦截器默认处于关闭状态<br>
因此,为了使用注解鉴权,你必须手动将sa-token的全局拦截器注册到你项目中
<!-- Sa-Token内置两种模式完成注解鉴权,分别是`拦截器模式`和`AOP模式`, 为了避免不必要的性能浪费,这两种模式默认都处于关闭状态 <br>
因此如若使用注解鉴权,你必须选择其一进行注册 -->
## 1、使用AOP模式
### 1、注册拦截器
以`SpringBoot2.0`为例, 新建配置类`SaTokenConfigure.java`
首先在`pom.xml`里添加依赖:
``` xml
<!-- sa-token整合SpringAOP实现注解鉴权 -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-spring-aop</artifactId>
<version>1.18.0</version>
</dependency>
``` java
@Configuration
public class SaTokenConfigure implements WebMvcConfigurer {
// 注册sa-token的注解拦截器,打开注解式鉴权功能
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new SaAnnotationInterceptor()).addPathPatterns("/**");
}
}
```
保证此类被`springboot`启动类扫描到即可
### 2、使用注解鉴权
然后我们就可以愉快的使用注解鉴权:
**登录验证**
``` java
// 注解式鉴权:当前会话必须登录才能通过
// 登录认证:当前会话必须登录才能通过
@SaCheckLogin
@RequestMapping("info")
public String info() {
return "查询用户信息";
}
```
**角色验证**
``` java
// 注解式鉴权:当前会话必须具有指定角色标识才能通过
// 角色认证:当前会话必须具有指定角色标识才能通过
@SaCheckRole("super-admin")
@RequestMapping("add")
public String add() {
return "用户增加";
}
```
**权限验证**
``` java
// 注解式鉴权:当前会话必须具有指定权限才能通过
// 权限认证:当前会话必须具有指定权限才能通过
@SaCheckPermission("user-add")
@RequestMapping("add")
public String add() {
@@ -60,10 +58,10 @@ public String add() {
}
```
注:以上两个注解都可以加在类上,代表为这个类所有方法进行鉴权
注:以上注解都可以加在类上,代表为这个类所有方法进行鉴权
#### 设定校验模式
### 3、设定校验模式
`@SaCheckRole`与`@SaCheckPermission`注解可设置校验模式,例如:
``` java
// 注解式鉴权:只要具有其中一个权限即可通过校验
@@ -81,28 +79,10 @@ mode有两种取值:
## 2、使用拦截器模式
使用AOP方式需要引入新的pom依赖,与此相比,拦截器模式显的更加轻量级 <br>
你只需要将sa-token的注解校验拦截器注册到你的项目中即可打开注解鉴权功能 <br>
以`SpringBoot2.0`为例, 新建配置类`SaTokenConfigure.java`
``` java
@Configuration
public class SaTokenConfigure implements WebMvcConfigurer {
// 注册sa-token的注解拦截器,打开注解式鉴权功能
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new SaAnnotationInterceptor()).addPathPatterns("/**");
}
}
```
保证此类被`springboot`启动类扫描到即可
#### 注意事项:
- 使用AOP模式,可以将注解写在任意层级,使用拦截器模式,只能把注解写在`Controller层`上 <br>
- 拦截器模式和AOP模式不可同时集成,否则会在`Controller层`发生一个注解校验两次的bug
### 4、在业务逻辑层使用注解鉴权
疑问:我能否将注解写在其它架构层呢,比如业务逻辑层?
使用拦截器模式,只能在`Controller层`进行注解鉴权,如需在任意层级使用注解鉴权,请参考:[AOP注解鉴权](/plugin/aop-at)
+1 -1
View File
@@ -32,7 +32,7 @@ public class SaTokenConfigure {
* 注册 [sa-token全局过滤器]
*/
@Bean
public SaServletFilter getSaReactorFilter() {
public SaServletFilter getSaServletFilter() {
return new SaServletFilter()
// 指定 拦截路由 与 放行路由
+2 -2
View File
@@ -65,7 +65,7 @@ public class StpInterfaceImpl implements StpInterface {
}
```
可参考代码:[码云:StpInterfaceImpl.java](https://gitee.com/dromara/sa-token/blob/master/sa-token-demo-springboot/src/main/java/com/pj/satoken/StpInterfaceImpl.java)
可参考代码:[码云:StpInterfaceImpl.java](https://gitee.com/dromara/sa-token/blob/master/sa-token-demo/sa-token-demo-springboot/src/main/java/com/pj/satoken/StpInterfaceImpl.java)
<!-- todo: 缓存逻辑 -->
@@ -114,7 +114,7 @@ StpUtil.checkRoleOr("super-admin", "shop-admin");
### 拦截全局异常
有同学要问,鉴权失败,抛出异常,然后呢?要把异常显示给用户看吗?**当然不可以!** <br>
你可以创建一个全局异常拦截器,统一返回给前端的格式,参考:[码云:GlobalException.java](https://gitee.com/dromara/sa-token/blob/master/sa-token-demo-springboot/src/main/java/com/pj/test/GlobalException.java)
你可以创建一个全局异常拦截器,统一返回给前端的格式,参考:[码云:GlobalException.java](https://gitee.com/dromara/sa-token/blob/master/sa-token-demo/sa-token-demo-springboot/src/main/java/com/pj/test/GlobalException.java)
### 权限通配符