SpringBoot整合Sa-Token

前言

官网文档：http://sa-token.dev33.cn/

一、Sa-Token是什么？

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

二、使用步骤

1.引入库

代码如下（示例）：

        <!-- Sa-Token 权限认证, 在线文档：http://sa-token.dev33.cn/ -->
        <dependency>
            <groupId>cn.dev33</groupId>
            <artifactId>sa-token-spring-boot-starter</artifactId>
            <version>1.29.0</version>
        </dependency>

        <!-- Sa-Token 整合 jwt -->
        <dependency>
            <groupId>cn.dev33</groupId>
            <artifactId>sa-token-jwt</artifactId>
            <version>1.29.0</version>
        </dependency>
    </dependencies>

2.Sa-Token配置

代码如下（yml配置）：

sa-token:
  # token名称 (同时也是cookie名称)
  token-name: satoken
  # token有效期，单位s 默认30天, -1代表永不过期
  timeout: 2592000
  # token临时有效期 (指定时间内无操作就视为token过期) 单位: 秒
  activity-timeout: 7200
  # 是否允许同一账号并发登录 (为true时允许一起登录, 为false时新登录挤掉旧登录)
  is-concurrent: false
  # 在多人登录同一账号时，是否共用一个token (为true时所有登录共用一个token, 为false时每次登录新建一个token)
  is-share: false
  # token风格
  token-style: uuid
  # 是否输出操作日志
  is-log: false
  # jwt秘钥
  jwt-secret-key: asdasdasifhueuiwyurfewbfjsdafjk

3.常用API

StpUtil.login(10001);    // 标记当前会话登录的账号id
StpUtil.getLoginId();    // 获取当前会话登录的账号id
StpUtil.isLogin();    // 获取当前会话是否已经登录, 返回true或false
StpUtil.logout();    // 当前会话注销登录
StpUtil.kickout(10001);    // 将账号为10001的会话踢下线
StpUtil.hasRole("super-admin");    // 查询当前账号是否含有指定角色标识, 返回true或false
StpUtil.hasPermission("user:add");    // 查询当前账号是否含有指定权限, 返回true或false
StpUtil.getSession();    // 获取当前账号id的Session
StpUtil.getSessionByLoginId(10001);    // 获取账号id为10001的Session
StpUtil.getTokenValueByLoginId(10001);    // 获取账号id为10001的token令牌值
StpUtil.login(10001, "PC");    // 指定设备标识登录，常用于“同端互斥登录”
StpUtil.kickout(10001, "PC");    // 指定账号指定设备标识踢下线 (不同端不受影响)
StpUtil.openSafe(120);    // 在当前会话开启二级认证，有效期为120秒 
StpUtil.checkSafe();    // 校验当前会话是否处于二级认证有效期内，校验失败会抛出异常 
StpUtil.switchTo(10044);    // 将当前会话身份临时切换为其它账号 

4.配置过滤器\全局异常处理

@ControllerAdvice
public class GlobalExceptionHandlerSa {
    /**
     * 处理未登入异常
     */
    @ResponseBody
    @ExceptionHandler(value = NotLoginException.class)
    public ResponseData handleNotLoginException(NotLoginException e) {
        return ResponseData.errorLogin();
    }
}
    

@Configuration
public class SaTokenConfigure implements WebMvcConfigurer {

    /**
     * 注册拦截器
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册Sa-Token的路由拦截器
        registry.addInterceptor(new SaRouteInterceptor())
                .addPathPatterns("/**")
                .excludePathPatterns("/v3/api-docs/**")
                .excludePathPatterns("/account/login")
                .excludePathPatterns("/swagger-resources/**")
                .excludePathPatterns("/**/*.html")
                .excludePathPatterns("/*.html")
                .excludePathPatterns("/swagger-ui/")
                .excludePathPatterns("/favicon.ico")
                .excludePathPatterns("/**/*.css")
                .excludePathPatterns("/**/*.js")
                .excludePathPatterns("/account/**");
    }

    /**
     * Sa-Token 整合 jwt (Style模式)
     */
    @Bean
    public StpLogic getStpLogicJwt() {
        return new StpLogicJwtForStyle();
    }
}

5.使用

    @Override
    public ResponseData Login(LoginBo bo) {
        try {
        	//部分业务逻辑省略
            //登录
            StpUtil.login(membership.getPermitNo());
            //将用户名存入session
            StpUtil.getSession().set("userName", user.getFullName());
            Map<String, Object> map = new HashMap<>(16);
            map.put("token", StpUtil.getTokenValue());
            map.put("code", vipCode);
            log.info("用户：" + user.getPhone() + "登入成功");
            return ResponseData.success(map);
        } catch (Exception e) {
            log.error("h5Login is error!", e);
            return ResponseData.error("System exception, please try again later");
        }
        
 
    @Override
    public ResponseData logout(String token) {
        try {
            //省略业务代码
            StpUtil.logout();
            return ResponseData.success();
        } catch (Exception e) {
            log.error("logout is error!", e);
            return ResponseData.error("System exception, please try again later");
        }
    }

总结

解决不同端的控制登入认证和权限认证