50-认证鉴权 框架：Sa-Token

• 官网：https://sa-token.cc/doc.html#/ 文档很详细
• gitee：https://gitee.com/dromara/sa-token
• git：https://github.com/dromara/sa-token

Sa-Token 介绍

Sa-Token 是一个轻量级 Java 权限认证框架，主要解决：登录认证、权限认证、单点登录、OAuth2.0、分布式Session会话、微服务网关鉴权 等一系列权限相关问题。

Sa-Token 旨在以简单、优雅的方式完成系统的权限认证部分，以登录认证为例，你只需要：

// 会话登录，参数填登录人的账号id 
StpUtil.login(10001);

无需实现任何接口，无需创建任何配置文件，只需要这一句静态代码的调用，便可以完成会话登录认证。

如果一个接口需要登录后才能访问，我们只需调用以下代码：

// 校验当前客户端是否已经登录，如果未登录则抛出 `NotLoginException` 异常
StpUtil.checkLogin();

在 Sa-Token 中，大多数功能都可以一行代码解决：

踢人下线：

// 将账号id为 10077 的会话踢下线 
StpUtil.kickout(10077);

权限认证：

// 注解鉴权：只有具备 `user:add` 权限的会话才可以进入方法
@SaCheckPermission("user:add")
public String insert(SysUser user) {
    // ... 
    return "用户增加";
}

路由拦截鉴权：

// 根据路由划分模块，不同模块不同鉴权 
registry.addInterceptor(new SaInterceptor(handler -> {
    SaRouter.match("/user/**", r -> StpUtil.checkPermission("user"));
    SaRouter.match("/admin/**", r -> StpUtil.checkPermission("admin"));
    SaRouter.match("/goods/**", r -> StpUtil.checkPermission("goods"));
    SaRouter.match("/orders/**", r -> StpUtil.checkPermission("orders"));
    SaRouter.match("/notice/**", r -> StpUtil.checkPermission("notice"));
    // 更多模块... 
})).addPathPatterns("/**");

当你受够 Shiro、SpringSecurity 等框架的三拜九叩之后，你就会明白，相对于这些传统老牌框架，Sa-Token 的 API 设计是多么的简单、优雅！

Sa-Token 功能一览

Sa-Token 目前主要五大功能模块：登录认证、权限认证、单点登录、OAuth2.0、微服务鉴权。

• 登录认证 —— 单端登录、多端登录、同端互斥登录、七天内免登录
• 权限认证 —— 权限认证、角色认证、会话二级认证
• Session会话 —— 全端共享Session、单端独享Session、自定义Session
• 踢人下线 —— 根据账号id踢人下线、根据Token值踢人下线
• 账号封禁 —— 登录封禁、按照业务分类封禁、按照处罚阶梯封禁
• 持久层扩展 —— 可集成Redis、Memcached等专业缓存中间件，重启数据不丢失
• 分布式会话 —— 提供jwt集成、共享数据中心两种分布式会话方案
• 微服务网关鉴权 —— 适配Gateway、ShenYu、Zuul等常见网关的路由拦截认证
• 单点登录 —— 内置三种单点登录模式：无论是否跨域、是否共享Redis，都可以搞定
• OAuth2.0认证 —— 轻松搭建 OAuth2.0 服务，支持openid模式
• 二级认证 —— 在已登录的基础上再次认证，保证安全性
• Basic认证 —— 一行代码接入 Http Basic 认证
• 独立Redis —— 将权限缓存与业务缓存分离
• 临时Token认证 —— 解决短时间的Token授权问题
• 模拟他人账号 —— 实时操作任意用户状态数据
• 临时身份切换 —— 将会话身份临时切换为其它账号
• 前后端分离 —— APP、小程序等不支持Cookie的终端
• 同端互斥登录 —— 像QQ一样手机电脑同时在线，但是两个手机上互斥登录
• 多账号认证体系 —— 比如一个商城项目的user表和admin表分开鉴权
• Token风格定制 —— 内置六种Token风格，还可：自定义Token生成策略、自定义Token前缀
• 注解式鉴权 —— 优雅的将鉴权与业务代码分离
• 路由拦截式鉴权 —— 根据路由拦截鉴权，可适配restful模式
• 自动续签 —— 提供两种Token过期策略，灵活搭配使用，还可自动续签
• 会话治理 —— 提供方便灵活的会话查询接口
• 记住我模式 —— 适配[记住我]模式，重启浏览器免验证
• 密码加密 —— 提供密码加密模块，可快速MD5、SHA1、SHA256、AES、RSA加密
• 全局侦听器 —— 在用户登陆、注销、被踢下线等关键性操作时进行一些AOP操作
• 开箱即用 —— 提供SpringMVC、WebFlux等常见web框架starter集成包，真正的开箱即用
• 更多功能正在集成中… —— 如有您有好想法或者建议，欢迎加群交流

使用

官网 https://sa-token.cc/doc.html#/ 写的很详细，最好直接看官网，源码开源，作者不易，如果你喜欢这个框架麻烦你随手点一颗小星星哦！如果不想 star，查看源码有惊喜。

简单列子

注解式鉴权

• @SaCheckLogin： 标注在方法或类上，当前会话必须处于登录状态才可通过校验
• @SaCheckRole("admin")：标注在方法或类上，当前会话必须具有指定角色标识才能通过校验
• @SaCheckPermission("user:add")：标注在方法或类上，当前会话必须具有指定权限才能通过校验

sa-token内置两种模式完成注解鉴权，分别是AOP模式和拦截器模式, 为了避免不必要的性能浪费，这两种模式默认都处于关闭状态，因此如若使用注解鉴权，你必须选择其一进行注册。

1、使用AOP模式

首先在pom.xml里添加依赖：

<!-- sa-token整合SpringAOP实现注解鉴权 -->
<dependency>
    <groupId>cn.dev33</groupId>
    <artifactId>sa-token-spring-aop</artifactId>
    <version>1.12.1</version>
</dependency>

然后我们就可以愉快的使用注解鉴权：

登录验证

// 注解式鉴权：当前会话必须登录才能通过 
@SaCheckLogin                        
@RequestMapping("info")
public String info() {
    return "查询用户信息";
}

角色验证

// 注解式鉴权：当前会话必须具有指定角色标识才能通过 
@SaCheckRole("super-admin")        
@RequestMapping("add")
public String add() {
    return "用户增加";
}

权限验证

// 注解式鉴权：当前会话必须具有指定权限才能通过 
@SaCheckPermission("user-add")        
@RequestMapping("add")
public String add() {
    return "用户增加";
}

注：以上两个注解都可以加在类上，代表为这个类所有方法进行鉴权

设定校验模式

@SaCheckRole与 @SaCheckPermission 注解可设置校验模式，例如：

// 注解式鉴权：只要具有其中一个权限即可通过校验 
@RequestMapping("atJurOr")
@SaCheckPermission(value = {"user-add", "user-all", "user-delete"}, mode = SaMode.OR)        
public AjaxJson atJurOr() {
    return AjaxJson.getSuccessData("用户信息");
}

mode有两种取值：

• SaMode.AND ，标注一组权限，会话必须全部具有才可通过校验
• SaMode.OR ， 标注一组权限，会话只要具有其一即可通过校验

2、使用拦截器模式

使用AOP方式需要引入新的pom依赖，与此相比，拦截器模式显的更加轻量级

你只需要将sa-token的注解校验拦截器注册到你的项目中即可打开注解鉴权功能

以SpringBoot2.0为例，新建配置类MySaTokenConfig.java

@Configuration
public class MySaTokenConfig implements WebMvcConfigurer {
    // 注册sa-token的注解拦截器，打开注解式鉴权功能 
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new SaAnnotationInterceptor()).addPathPatterns("/**");    
    }
}

保证此类被springboot启动类扫描到即可

注意事项：

• 使用AOP模式，可以将注解写在任意层级，使用拦截器模式，只能把注解写在Controller层上
• 拦截器模式和AOP模式不可同时集成，否则会在Controller层发生一个注解校验两次的bug