文章目录

  • 前言
  • 参考目录
  • 代码分析
  • 1、框架集成
  • 2、登录流程源码分析
  • 2.1、`StpLogic#login()`
  • 2.1.1、前置检查:如果此账号已被封禁
  • 2.1.2、初始化 loginModel
  • 2.1.3、生成一个token
  • 2.1.4、获取 User-Session , 续期
  • 2.1.5、持久化其它数据
  • 2.1.6、通知监听器,账号xxx登录成功
  • 2.2、`StpLogic#getTokenValue`
  • 2.2.1、获取
  • 2.2.2、如果打开了前缀模式,则裁剪掉
  • 2.2.3、返回

前言

之前在交流群里面进行了一次投票,关于框架分支的使用情况,结果显示 Sa-Token 分支的使用比例也很高,因此狮子大佬决定在下个版本就会把 Sa-Token 接入主分支中。这篇文章主要是基于框架现有 Sa-Token 分支进行分析。

现版本 V3.5.0 主分支使用的还是 Spring Security 作为权限认证框架,作为 Spring 全家桶的一员功能强大,但是对于一般人而言上手也不容易,如果想了解更多的关于框架中 Spring Security 的内容可以查看我之前整理的一篇文章【若依】开源框架学习笔记 07 - 登录认证流程(Spring Security 源码)。

最开始接触若依框架的时候框架中使用的是 Shiro 作为权限框架,相对 Spring Security 而言上手简单一些,如果想要了解的话也可以参考我整理的另外一篇文章【若依】开源框架学习笔记 02 - Shiro 权限框架 。

因为是之前整理的文章,可能版本更新迭代之后可能会有不一样的地方,请见谅。

参考目录

代码分析

1、框架集成


说明

SaTokenConfig

Sa-Token 配置

SaInterfaceImpl

Sa-Token 权限认证接口实现类

PlusSaTokenDao

Sa-Token 持久层接口 (使用框架自带RedisUtils实现 协议统一)

UserActionListener

用户行为 侦听器的实现

依赖添加 pom.xml

若依微服务 图片上传功能 若依saas_若依微服务 图片上传功能


若依微服务 图片上传功能 若依saas_java_02


配置文件 application.yml

若依微服务 图片上传功能 若依saas_Sa-Token_03

2、登录流程源码分析

登录验证方法:SysLoginService#login()

若依微服务 图片上传功能 若依saas_RuoYi-Vue-Plus_04


在该方法中前面验证通过后,会调用 Sa-Token 的方法生成 token,然后返回。这里主要分析生成 token 的过程。LoginUtils#loginByDevice()

若依微服务 图片上传功能 若依saas_java_05


用户类型枚举:

若依微服务 图片上传功能 若依saas_Sa-Token_06


设备类型枚举:

若依微服务 图片上传功能 若依saas_后端_07

2.1、StpLogic#login()

若依微服务 图片上传功能 若依saas_RuoYi-Vue-Plus_08


源码的注释挺清楚的,login() 方法的主要逻辑如下:

2.1.1、前置检查:如果此账号已被封禁

StpLogic#isDisable

若依微服务 图片上传功能 若依saas_java_09


StpLogic#splicingKeyDisable

若依微服务 图片上传功能 若依saas_RuoYi-Vue-Plus_10


PlusSaTokenDao#get

若依微服务 图片上传功能 若依saas_后端_11


结果为 null,继续接下来的流程。

2.1.2、初始化 loginModel

若依微服务 图片上传功能 若依saas_java_12

2.1.3、生成一个token

先判断是否允许并发登录,配置文件里面为 true;再判断是否共享 token,配置为 false;直接生成一个 token。

若依微服务 图片上传功能 若依saas_Sa-Token_13


若依微服务 图片上传功能 若依saas_RuoYi-Vue-Plus_14


StpLogicJwtForStyle#createTokenValue()

若依微服务 图片上传功能 若依saas_java_15


根据配置文件中的 secretKey 生成一个 token。

若依微服务 图片上传功能 若依saas_后端_16

2.1.4、获取 User-Session , 续期

若依微服务 图片上传功能 若依saas_若依微服务 图片上传功能_17


StpLogic#getSessionByLoginId

若依微服务 图片上传功能 若依saas_若依微服务 图片上传功能_18


StpLogic#splicingKeySession

若依微服务 图片上传功能 若依saas_Sa-Token_19


StpLogic#getSessionBySessionId

若依微服务 图片上传功能 若依saas_后端_20


返回 session,在 User-Session 上记录 token 签名。

若依微服务 图片上传功能 若依saas_后端_21

2.1.5、持久化其它数据

若依微服务 图片上传功能 若依saas_Sa-Token_22


StpLogic#saveTokenToIdMapping

若依微服务 图片上传功能 若依saas_java_23


StpLogic#setTokenValue

若依微服务 图片上传功能 若依saas_后端_24


StpLogic#setLastActivityToNow

若依微服务 图片上传功能 若依saas_java_25

2.1.6、通知监听器,账号xxx登录成功

若依微服务 图片上传功能 若依saas_若依微服务 图片上传功能_26


UserActionListener#doLogin

若依微服务 图片上传功能 若依saas_后端_27

2.2、StpLogic#getTokenValue

若依微服务 图片上传功能 若依saas_RuoYi-Vue-Plus_28

2.2.1、获取

若依微服务 图片上传功能 若依saas_若依微服务 图片上传功能_29

2.2.2、如果打开了前缀模式,则裁剪掉

若依微服务 图片上传功能 若依saas_若依微服务 图片上传功能_30

2.2.3、返回

若依微服务 图片上传功能 若依saas_Sa-Token_31