mall :sa-token项目源码解析

news2024/10/6 5:54:28

文章目录

    • 一、mall开源项目
      • 1.1 来源
      • 1.2 项目转移
      • 1.3 项目克隆
    • 二、Sa-Toekn框架
      • 2.1 Sa-Token 简介
      • 2.2 分布式后端项目的使用流程
      • 2.3 分布式后端项目的使用场景
    • 三、源码解析
      • 3.1 集成与配置
        • 3.1.1 导入依赖
        • 3.1.2 添加配置
        • 3.1.3 异常处理
        • 3.1.4 存储用户信息
      • 3.2 登录认证
        • 3.2.1 配置黑白名单
        • 3.2.2 登录业务代码解读
        • 3.2.3 测试登录
      • 3.3 角色认证
        • 3.3.1 权限验证接口扩展
        • 3.3.2 配置拦截器
        • 3.3.3 测试角色
      • 3.4 权限认证
        • 3.4.1 配置拦截器
        • 3.4.2 测试权限
    • 四、总结

一、mall开源项目

1.1 来源

mall学习教程,架构、业务、技术要点全方位解析。mall项目(50k+star)是一套电商系统,使用现阶段主流技术实现。涵盖了SpringBoot 2.3.0、MyBatis 3.4.6、Elasticsearch 7.6.2、RabbitMQ 3.7.15、Redis 5.0、MongoDB 4.2.5、Mysql5.7等技术,采用Docker容器化部署。

项目github地址: mall开源项目

1.2 项目转移

可以把github上的项目转移到gitee上,方便克隆到idea。

具体步骤如下:

在这里插入图片描述

1.3 项目克隆

由于github部署在国外,虽然idea也支持从github上拉取,但是克隆速度太慢,所以才推荐上述导入gitee后在克隆项目到idea。

具体的克隆步骤过于简单和常规化,读者可自行完成,或百度一下~

二、Sa-Toekn框架

2.1 Sa-Token 简介

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

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

功能概览图如下:

在这里插入图片描述

sa-token开发文档地址: sa-token.cc

2.2 分布式后端项目的使用流程

下图是结合项目经历,外加百度查找资料,自行总结的基本使用流程。

sa-token的使用流程图如下:

在这里插入图片描述

2.3 分布式后端项目的使用场景

下图是结合项目经历,外加百度查找资料,自行总结的基本使用场景。

sa-token的使用场景图如下:

在这里插入图片描述

三、源码解析

看源码自我总结出来的看新项目时的基本步骤,首先先看集成和配置,在从业务的角度来分析,结合集成的框架和组件,来依次剥削系统的架构。

解析内容:下方的解析内容大部分在图中解释,外面就不做过多的阐述。

3.1 集成与配置

直接拿源码分析,只分析与sa-token有关的部分,其它部分读者请,自行看源码分析。

项目启动:只需要启动mall-tiny-sa-token模块的部分即可。

启动所需:启动mysql5的服务,创建数据库,并导入表(sql文件位置在,项目同级目录的document文件夹里)。

ps:记得修改数据库连接的配置信息。

3.1.1 导入依赖

pom文件中导入sa-token的相关依赖。

在这里插入图片描述

3.1.2 添加配置

application.yml中添加sa-token的相关配置,项目支持前后端分离项目,关闭从 cookie 中读取 token,改为从 head 中读取 token的配置。

在这里插入图片描述

3.1.3 异常处理

对于处理未登录的、没有权限的、没有角色的异常,需要全局处理一下。

拿登录来做个小例子:由于未登录状态下访问接口,Sa-Token 会抛出NotLoginException异常,此时会根据自定义的返回信息,返回状态码401和响应信息未提供token(异常处理的结果信息)。

在这里插入图片描述

3.1.4 存储用户信息

有两个用户,admin用户具有ROLE_ADMIN角色,macro用户具有ROLE_USER角色。

**ps:**模拟数据库两张表的关联信息是根据id来关联的,也就是给用户分配角色。

在这里插入图片描述

3.2 登录认证

3.2.1 配置黑白名单

在管理系统中,除了登录接口,基本上都需要登录认证,在 sa-token中使用路由拦截鉴权是最方便的,也就是说给sa-token配置拦截器,实现WebMvcConfigurer接口,配置黑白名单。

在这里插入图片描述

ps:自定义的白名单是从application.yml文件中获取到的信息。

在这里插入图片描述

3.2.2 登录业务代码解读

1.首先是控制层, 在UmsAdminController中添加一个登录接口login

在这里插入图片描述

2.接着业务层, 在UmsAdminServiceImpl添加登录的具体逻辑,先验证密码,然后调用StpUtil.login(adminUser.getId())即可实现登录。

在这里插入图片描述

3.2.3 测试登录

方式一:使用Postman测试

在这里插入图片描述

方式二:使用swagger接口文档测试(建议使用,以及编写好,直接访问即可测试,访问地址为: Swagger UI ),由于已经拿到token,就不做重复测试了,直接测另一个接口,查询当前登录状态的接口。

在这里插入图片描述

3.3 角色认证

紧接上文,我来实现一下吧!对于角色认证也就是定义好一套访问接口的规则,比如ROLE-ADMIN角色可以访问/brand下的所有资源,而ROLE_USER角色只能访问/brand/listAll下的资源。

配置全局异常:见副标题3.1.3有所描述,不做过多陈诉。

当用户不是被允许的角色访问时,Sa-Token会抛出NotRoleException异常。

3.3.1 权限验证接口扩展

扩展 sa-token的StpInterface接口,重写方法来返回用户的角色名称和角色权限列表。

由于StpInterfaceImpl实现了StpInterface接口,重写了里面的方法。所以在SaTokenConfig的配置文件中的StpUtil.checkRole("ROLE_ADMIN")才能匹配到模拟的数据库的角色信息。权限信息也是同理,不一一列举了。

在这里插入图片描述

3.3.2 配置拦截器

在拦截器中配置路由规则,ROLE_ADMIN角色可以访问所有路径,而ROLE_USER只能访问/brand/listAll路径。

在这里插入图片描述

3.3.3 测试角色

对于 admin用户具有ROLE_ADMIN角色,macro用户具有ROLE_USER角色 。

  • 使用admin账号访问/brand/{id}接口可以正常访问
  • 使用macro账号访问/brand/{id}接口无法正常访问,返回code403

这里就不对admin进行测试展示了,下方是对macro用户进行测试,查看没有权限的效果。

在这里插入图片描述

3.4 权限认证

当给角色分配好权限,然后给用户分配好角色后,用户就拥有了这些权限。

对于权限认证,也可以为每个接口分配不同的权限,拥有该权限的用户就可以访问该接口。

配置全局异常:见副标题3.1.3有所描述,不做过多陈诉。

用户无权限访问时,Sa-Token 会抛出NotPermissionException异常。

3.4.1 配置拦截器

给拦截器配置路由规则admin用户可以访问所有路径,而macro用户只有读取的权限,没有写、改、删的权限。

在这里插入图片描述

3.4.2 测试权限

对于 admin用户可以访问所有路径,而macro用户只有读取的权限,没有写、改、删的权限。

  • 使用admin账号访问/brand/delete接口可以正常访问
  • 使用macro账号访问/brand/delete无法正常访问,返回code403

这里就不对admin进行测试展示了,下方是对macro用户进行测试,查看没有权限的效果。

在这里插入图片描述

四、总结

本文是有我先从实际项目中获取需求,从而对SpringSecurityOath2的学习,结合源码来学习,到另一个项目由于鉴权已经部署在不同的ip,项目使用调用即可,项目中使用了 Sa-Token 是一个轻量级 Java 权限认证框架 ,看官网是看的明白,但是不懂如何入手,就有了此文,从mall开源项目中学习sa-token,感觉收获颇深,希望这篇文章对你们也会有所帮助。

后续我也会结合该框架学习一下其他的技术栈。

七夕~盈若安好,便是晴天

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/913459.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

智慧健康杂志智慧健康杂志社智慧健康编辑部2023年第15期目录

智慧医疗 医疗信息化 提高病案首页填写质量,体现病案信息利用价值 张明芳; 1-4 经支气管镜检查联合针吸活检术在肺癌诊断中的临床应用价值 邱洪亮; 5-8 高频超声对距腓前韧带损伤的诊断价值 梁劲松;叶绮婷;曹肖维; 9-12《智慧健康》投稿邮箱&#xff1a…

clickhouse(十四、分布式DDL阻塞及同步阻塞问题)

文章目录 一、分布式ddl 阻塞、超时现象验证方法解决方案 二、副本同步阻塞现象验证解决方案 一、分布式ddl 阻塞、超时 现象 在clickhouse 集群的操作中,如果同时执行一些重量级变更语句,往往会引起阻塞。 一般是由于节点堆积过多耗时的ddl。然后抛出…

第9章:聚类

聚类任务 性能度量 距离度量 非度量距离 原型聚类 有很好的统计学上的意义,但是只能找到椭球形的聚类。 密度聚类 层次聚类

vue插入重复的html内容

vue添加重复的html内容是通过绑定一个数组来v-for循环实现的。 效果展示: 首先创建数组,里面为重复内容的数量,里面默认存在一个初始值。 然后通过v-for来绑定这个数组,循环数据。 通过添加点击事件,来增加或删除数组…

非常好用的Python单行代码详解

概要 有用的 Python 单行代码片段,只需一行代码即可解决特定编码问题!在本文中,将分享20 个 Python 一行代码,你可以在 30 秒或更短的时间内轻松学习它们。这种单行代码将节省你的时间,并使你的代码看起来更干净且易于…

docker之Consul环境的部署

目录 一、Docker consul的介绍 1.1 template模板(更新) 1.2 registrator(自动发现) 1.3 agent(代理) 二.consul的工作原理 三.Consul的特性 四.Consul的使用场景 五.搭建Consul的集群 5.1 需求 5.2 部署consul 5.3 主服务器部署[192.168.19.10…

神仙般的css动画参考网址,使用animate.css

Animate.css | A cross-browser library of CSS animations.Animate.css is a library of ready-to-use, cross-browser animations for you to use in your projects. Great for emphasis, home pages, sliders, and attention-guiding hints.https://animate.style/这里面有很…

4、Spring_IOC注解开发

IOC 注解开发 版本了解 2.0版本时开始支持注解开发(2.0之前就是昨天学习的纯 xml 操作)2.5版本才完善3.0版本支持纯注解开发 1.注解&xml配置Bean 1.1配置用户mapper 配置 mapper public interface UserMapper {void save(); }配置 mapper 实现类…

第 6 章 递归(2)(迷宫问题)

6.6.1 迷宫问题 6.6.2 代码实现 package pers.th.d6_recursion;/*** 递归-迷宫问题*/ public class MiGong {public static void main(String[] args) {//先创建一个二维数组,模拟迷宫//地图int[][] map new int[8][7];//使用1 表示墙//上下全部置为1for (int i …

MySQL数据库:内置函数

日期函数 规定:日期:年月日 时间:时分秒 函数名称作用描述current_date()当前日期current_time()当前时间current_timestamp()当前时间戳date(datetime)返回datetime参数的日期部分date_add(date,interval d_value_type)在date中添加…

畜牧兽医虚拟仿真|病禽解剖VR模拟操作演练系统

在生物学课程中,动物解剖是一个重要的组成部分,它能够帮助学生了解动物的生理结构、功能和生活习性,从而更好地认识和保护自然界的生物多样性。然而,传统的动物解剖教学方法往往局限于课堂教学和实验室实践,学生很难真…

基于MATLAB开发AUTOSAR软件应用层Code mapping专题-part 4 Data store标签页介绍

这篇文章我们继续讲解code-mapping的Data stores页,这个页的内容对应的SIMULINK中的模块是Data store memory。 我们首先在模型中创建一个Data store memory模块,如图: Data store memory模块的作用相当于一个全局变量,我们可以在模型的功能逻辑里将一个信号存进去,在另…

【计算机网络篇】TCP协议

✅作者简介:大家好,我是小杨 📃个人主页:「小杨」的csdn博客 🐳希望大家多多支持🥰一起进步呀! TCP协议 1,TCP 简介 TCP(Transmission Control Protocol)是…

Linux系统使用service设置程序自启动

Linux系统使用service设置程序自启动 整体描述前期准备1. 生成pid文件 具体方法1. 脚本编写1.1 start.sh脚本1.2 shutdown.sh脚本1.3 restart.sh脚本 2. 设置service2.1 service文件2.2 设置自启动2.3 查看设置结果 整体描述 在linux系统里,设置程序自启动是基本操…

基于Vue3.0的优秀低代码项目

在众多开发技术中,Vue组件化开发技术以其卓越的灵活性和高效性备受瞩目。借助Vue3.0的强大功能和简洁易用的语法,你将能够轻松打造出最令人瞩目的低代码项目。 低代码开发正成为当前企业提升运营效率、降低开发成本的首选方案。相较于传统开发模式&#…

基于Singularity 安装 AmpliconSuite-pipeline

基于Singularity 安装 AmpliconSuite-pipeline 按照AmpliconSuite-pipeline官网的Singularity安装方法遇到不少问题,好在都一一解决了,写个文档记录一下我基于Singularity 安装 AmpliconSuite-pipeline的过程。 step1 获取 Singularity镜像 镜像地址&…

如何截掉图片中的一部分?

如何截掉图片中的一部分?在社交媒体的热潮下,我们常常需要将自己生活中的照片或者美景图片分享到互联网或者自己的朋友圈中。然而,有时候我们会发现照片中存在一些不需要的元素,这可能会降低照片的美观程度。针对这种情况&#xf…

分布式核心知识以及常见微服务框架

分布式中的远程调用 在微服务架构中,通常存在多个服务之间的远程调用的需求。远程调用通常包含两个部分:序列化和通信协议。常见的序列化协议包括json、xml、 hession、 protobuf、thrift、text、 bytes等,目前主流的远程调用技术有基于HTTP…

C语言刷题训练DAY.10

1.空心正方形图案 解题思路&#xff1a; 这里我们只把四条边的内容打印成*&#xff0c;其他内容打印成空格即可。 解题代码&#xff1a; #include <stdio.h> int main() {int n 0;while (scanf("%d", &n) ! EOF){int i 0;for (i 0; i < n; i) //外…

Stream流报错Duplicate key

目录 1、场景2、问题3、解决办法4、完整代码 1、场景 有一个客户列表&#xff0c;每个item里有客户id、name、客户开的公司。 现在根据客户id分组&#xff0c;以客户id为key&#xff0c;把id相同的放到value里&#xff0c;构建一个Map。 这样可以快速根据id&#xff0c;获取相…