Sa-Token 轻松入门

Sa-Token是什么?

一个轻量级 Java 权限认证框架，让鉴权变得简单、优雅！

Sa-Token 介绍

github仓库地址:https://github.com/dromara/sa-token

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

这里插上一句,相信大家之前肯定都使用过,Spring Security或者Shiro,相比于这两个权限框架,Sa-Token的使用极其简单,简化了很多步骤.

Sa-Token功能一览

• 登录认证 —— 单端登录、多端登录、同端互斥登录、七天内免登录
• 权限认证 —— 权限认证、角色认证、会话二级认证
• Session会话 —— 全端共享Session、单端独享Session、自定义Session
• 踢人下线 —— 根据账号id踢人下线、根据Token值踢人下线
• 账号封禁 —— 指定天数封禁、永久封禁、设定解封时间
• 持久层扩展 —— 可集成Redis、Memcached等专业缓存中间件，重启数据不丢失
• 分布式会话 —— 提供jwt集成、共享数据中心两种分布式会话方案
• 微服务网关鉴权 —— 适配Gateway、ShenYu、Zuul等常见网关的路由拦截认证
• 单点登录 —— 内置三种单点登录模式：无论是否跨域、是否共享Redis，都可以搞定
• OAuth2.0认证 —— 基于RFC-6749标准编写，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集成包，真正的开箱即用

Sa-Token入门小示例

引入Sa-Token的依赖,这里使用的是Spring Boot 所以这里引入的jar包将是Spring Mvc环境,Sa-Token提供了多种环境下使用的jar包

如果你使用的框架基于 ServletAPI 构建（ SpringMVC、SpringBoot等 ），请引入此包

<dependency>
    <groupId>cn.dev33</groupId>
    <artifactId>sa-token-spring-boot-starter</artifactId>
    <version>1.30.0</version>
</dependency>

要是使用Gradle就引入以下依赖

implementation 'cn.dev33:sa-token-spring-boot-starter:1.30.0'

注：JDK版本：v1.8+

设置配置文件

你可以零配置启动项目 ，但同时你也可以在 application.yml 中增加如下配置，定制性使用框架：

server:
    # 端口
    port: 8081

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

要是你喜欢使用properties的话呢,自己鼓捣一下就好啦

springboot properties与yml 配置文件的区别

创建启动类

在项目中建一个启动类

@SpringBootApplication
public class SaTokenDemoApplication {
   

    public static void main(String[] args) {
   
        SpringApplication.run(SaTokenDemoApplication.class, args);
        // 打印Sa-Token配置
        System.out.println(SaManager.getConfig());
    }
}

搞定!

创建一个测试类

package cn.lsqo.controller;

import cn.dev33.satoken.stp.StpUtil;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/test")
public class UserController {
   

    @RequestMapping("/login")