1、pom
<satoken.version>1.33.0</satoken.version>
<!-- Sa-Token 权限认证, 在线文档:http://sa-token.dev33.cn/ -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-spring-boot-starter</artifactId>
<version>${satoken.version}</version>
</dependency>
<!-- Sa-Token 整合 jwt -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-jwt</artifactId>
<version>${satoken.version}</version>
</dependency>
2、yml配置
# Sa-Token
sa-token:
# token名称 (同时也是cookie名称)
token-name: satoken
# token有效期,单位s 默认30天, -1代表永不过期
timeout: 604800
# token临时有效期 (指定时间内无操作就视为token过期) 单位: 秒
activity-timeout: -1
# 是否允许同一账号并发登录 (为true时允许一起登录, 为false时新登录挤掉旧登录)
is-concurrent: true
# 在多人登录同一账号时,是否共用一个token (为true时所有登录共用一个token, 为false时每次登录新建一个token)
is-share: false
# token风格
token-style: uuid
# jwt秘钥
jwt-secret-key: asdasdasifhueuiwyurfewbfjsdafjk
# 是否输出操作日志
is-log: false
3、注册拦截器
@Configuration
public class SaTokenConfig implements WebMvcConfigurer {
// 注册Sa-Token的注解拦截器,打开注解式鉴权功能
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 注册注解拦截器,并排除不需要注解鉴权的接口地址 (与登录拦截器无关)
registry.addInterceptor(new SaAnnotationInterceptor())
.addPathPatterns("/**")
.excludePathPatterns("/swagger/**",
"/swagger-ui.html",
"/swagger-resources/**",
"/doc.html",
"/webjars/**",
"/v2/**",
"/v2/api-docs/**",
"/v2/api-docs-ext/**",
"/favicon.ico",
"/error")
;
}
// Sa-Token 整合 jwt (Simple 简单模式)
@Bean
public StpLogic getStpLogicJwt() {
return new StpLogicJwtForSimple();
}
}
4、自定义权限验证接口扩展
/**
* 自定义权限验证接口
*/
@Component
public class StpInterfaceImpl implements StpInterface {
/**
* 返回一个账号所拥有的权限码集合
*/
@Override
public List<String> getPermissionList(Object loginId, String loginType) {
return Collections.singletonList("admin-add");
}
/**
* 返回一个账号所拥有的角色标识集合 (权限与角色可分开校验)
*/
@Override
public List<String> getRoleList(Object loginId, String loginType) {
List<String> list = new ArrayList<String>();
list.add("admin");
return list;
}
}
5、jwt token登录
@ApiOperation(value = "登录")
@PostMapping("/login")
public Result<Object> login(@Validated LoginVo loginVo){
AppUser user = userService.queryByUsernameAndPassword(loginVo.getUsername(), loginVo.getPassword());
// Token挂载的扩展参数 (此方法只有在集成jwt插件时才会生效)
SaLoginModel loginModel = new SaLoginModel();
loginModel.setExtra("username", user.getUsername());
StpUtil.login(user.getId(), loginModel);
SaTokenInfo saTokenInfo = StpUtil.getTokenInfo();
Map<String, Object> map = new HashMap<>();
map.put("saTokenInfo", saTokenInfo);
return Result.Success(map);
}
6、鉴权
(1)登录鉴权
@SaCheckLogin
@RequestMapping("list")
public String list() {
return "查询列表";
}
(2)角色鉴权
@SaCheckRole("admin")
@PostMapping("/page")
public Result<Object> page(@Validated AppPageVo pageVo){
PageInfo<App> list = appService.queryPage(pageVo);
return Result.Success(list);
}
(3)权限校验
@SaCheckPermission("admin-add")
@RequestMapping("add")
public Result<Object> add(@Validated App app){
appService.add(app);
return Result.Success();
}
(4)角色权限双重 “or校验”
// 角色权限双重 “or校验”:具备指定权限或者指定角色即可通过校验
@RequestMapping("add")
@SaCheckPermission(value = "admin-add", orRole = "admin")
public String add() {
return "新增";
}
(5)忽略认证:使用 @SaIgnore 可表示一个接口忽略认证
(6)设定校验模式
SaMode.AND,标注一组权限,会话必须全部具有才可通过校验。
SaMode.OR,标注一组权限,会话只要具有其一即可通过校验。
// 注解式鉴权:只要具有其中一个权限即可通过校验
@RequestMapping("add")
@SaCheckPermission(value = {"admin-add", "admin-all", "admin-update"}, mode = SaMode.OR)
public String add() {
return "新增";
}
(7)批量注解鉴权
@SaCheckBasic:Http Basic 校验:只有通过 Basic 认证后才能进入该方法
@SaCheckDisable:校验当前账号是否被封禁 comment 服务,如果已被封禁会抛出异常,无法进入方法
// 在 `@SaCheckOr` 中可以指定多个注解,只要当前会话满足其中一个注解即可通过验证,进入方法。
@SaCheckOr(
login = @SaCheckLogin,
role = @SaCheckRole("admin"),
permission = @SaCheckPermission("admin-add"),
safe = @SaCheckSafe("update-password"),
basic = @SaCheckBasic(account = "sa:123456"),
disable = @SaCheckDisable("submit-orders")
)
@RequestMapping("test")
public String test() {
return "test";
}