乐趣区

关于java:手把手教你使用satoken解决网站权限验证

sa-token 是什么?

sa-token 是一个 JavaWeb 轻量级权限认证框架,其 API 调用非常简单,有多简略呢?以登录验证为例,你只须要:

// 在登录时写入以后会话的账号 id 
StpUtil.setLoginId(10001);    

// 而后在任意须要校验登录处调用以下 API  
// --- 如果以后会话未登录,这句代码会抛出 `NotLoginException` 异样
StpUtil.checkLogin(); 

没有简单的封装!不要任何的配置!只需这两行简略的调用,即可轻松实现零碎登录鉴权!

与其它权限认证框架相比,sa-token尽力保障两点:

  • 上手简略:能自动化的配置全副自动化,不让你费脑子
  • 功能强大:能涵盖的性能全副涵盖,不让你用个框架还要本人给框架打各种补丁

如果下面的示例可能证实 sa-token 的简略,那么以下 API 则能够证实 sa-token 的弱小

StpUtil.setLoginId(10001);          // 标记以后会话登录的账号 id
StpUtil.getLoginId();               // 获取以后会话登录的账号 id
StpUtil.isLogin();                  // 获取以后会话是否曾经登录, 返回 true 或 false
StpUtil.logout();                   // 以后会话登记登录
StpUtil.logoutByLoginId(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 令牌值 

涵盖性能

  • 登录验证 —— 轻松登录鉴权,并提供五种细分场景值
  • 权限验证 —— 拦挡违规调用,不同角色不同受权
  • Session 会话 —— 业余的数据缓存核心
  • 踢人下线 —— 将违规用户立即清退下线
  • 模仿别人账号 —— 实时操作任意用户状态数据
  • 长久层扩大 —— 可集成 redis、MongoDB 等业余缓存中间件
  • 多账号认证体系 —— 比方一个商城我的项目的 user 表和 admin 表离开鉴权
  • 无 Cookie 模式 —— APP、小程序等前后台拆散场景
  • 注解式鉴权 —— 优雅的将鉴权与业务代码拆散
  • 花式 token 生成 —— 内置六种 token 格调,还可自定义 token 生成策略
  • 主动续签 —— 提供两种 token 过期策略,灵便搭配应用,还可主动续签
  • 组件主动注入 —— 零配置与 Spring 等框架集成
  • 更多功能正在集成中 … —— 如有您有好想法或者倡议,欢送加群交换

SpringBoot 集成示例

1、创立我的项目

在 IDE 中新建一个 Springboot 我的项目,例如:sa-token-demo-springboot(不会的同学请自行百度或者参考 github 示例)

2、设置 jar 包依赖

  • pom.xml 中增加依赖:
<!-- sa-token 权限认证, 在线文档:http://sa-token.dev33.cn/ -->
<dependency>
    <groupId>cn.dev33</groupId>
    <artifactId>sa-token-spring-boot-starter</artifactId>
    <version>1.8.0</version>
</dependency>

3、配置文件

  • 你能够零配置启动我的项目
  • 但同时你也能够在 application.yml 中减少如下配置,定制性应用框架:
spring: 
    # sa-token 配置
    sa-token: 
        # token 名称 (同时也是 cookie 名称)
        token-name: satoken
        # token 有效期,单位 s 默认 30 天, - 1 代表永不过期 
        timeout: 2592000
        # token 长期有效期 (指定工夫内无操作就视为 token 过期) 单位: 秒
        activity-timeout: -1
        # 是否容许同一账号并发登录 (为 true 时容许一起登录, 为 false 时新登录挤掉旧登录) 
        allow-concurrent-login: false
        # 在多人登录同一账号时,是否共用一个 token (为 true 时所有登录共用一个 token, 为 false 时每次登录新建一个 token) 
        is-share: false
        # token 格调
        token-style: uuid
  • 如果你习惯于 application.properties 类型的配置文件,那也很好办:
  • 百度:springboot properties 与 yml 配置文件的区别

4、创立主类

在我的项目中新建包 com.pj,在此包内新建主类 SaTokenDemoApplication.java,输出以下代码:

@SpringBootApplication
public class SaTokenDemoApplication {public static void main(String[] args) throws JsonProcessingException {SpringApplication.run(SaTokenDemoApplication.class, args); // run-->         
        System.out.println("启动胜利:sa-token 配置如下:" + SaTokenManager.getConfig());
    }
}

5、运行

运行代码,当你从控制台看到相似上面的内容时,就代表框架曾经胜利集成了

仓库地址

  • github:https://github.com/click33/sa-token
  • gitee: https://gitee.com/sz6/sa-token
  • 官网文档:http://sa-token.dev33.cn/
退出移动版