基于权限认证sa-token的简单案列

阳光穿透心脏的1/2处 2023-09-23 22:26 74阅读 0赞

目前所作的项目都需要加上权限认证，但是像市面上的spring系列的权限认证框架不够简洁，可读性，移植型都比较差。因此一个轻量型的权限认证框架sa-token可以提高大家对权限认证很复杂的传统认知！

接下来我们使用sa-token做一个简单的demo，来让大家对sa-token有一个初步的理解：

首先，我们创建一个springboot项目，然后加上web 和sa-token的依赖：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.7.5</version>
            <relativePath/> 
        </parent>
        <groupId>com.example</groupId>
        <artifactId>demo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>demo</name>
        <description>Demo project for Spring Boot</description>
        <properties>
            <java.version>17</java.version>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>cn.dev33</groupId>
                <artifactId>sa-token-spring-boot-starter</artifactId>
                <version>1.34.0</version>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

我们在我们的resources下的配置文件中将我们的satoken和端口号配置以下：

server:
      # 端口
      port: 8081
    
    ############## Sa-Token 配置 (文档: https://sa-token.cc) ##############
    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: true
      # token风格
      token-style: uuid
      # 是否输出操作日志
      is-log: false

然后创建controller,设计思路我们对用户的username,和passwod 进行验证，如果username 跟password都正确则显示登录成功，如果不一样则显示登录失败：当我们登录成功之后我们会给我们的用户附加上权限，使其能够访问我们页面的指定路径；如果没有登录或者用户登录之后没有相关路径的权限，则后台会抱一个我们自编的异常NotLoginException。

sa-token的权限认证思路，是在我们登录成功之后，我们的用户会以键值对的像是带上一个token,这个token具有唯一性，不同性，用户再登录之后访问其他路径的时候，会带这这个token进行访问，而这个token它又带着属于自己的权限，所以用户就会被附加上不同的权限：

controller代码如下：

package com.example.demo.controller;
    
    import cn.dev33.satoken.stp.StpUtil;
    import cn.dev33.satoken.util.SaResult;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RequestMapping("/user/")
    public class SaTakenController {
    //用户登录方法
    @RequestMapping("doLogin")
        public  String doLoginIn (String username,String password){
            if ("lisi".equals(username)&&"123456".equals(password)){
                StpUtil.login(1001);
                return "当前是否登录"+SaResult.ok();
            }
            return "当前是否登录"+SaResult.error();
        }
    @RequestMapping("isLogin")
    //查看当前用户是否已经登陆
        public  String isLogin(){
        return "当前登录状态"+ StpUtil.isLogin();
        }
    //查看当前登录用户的详情
        @RequestMapping("takernInfo")
        public  SaResult takenInfo(){
            return SaResult.data(StpUtil.getTokenInfo());
        }
    //强制将我们的用户注销（退出登录状态）
        @RequestMapping("logout")
        public SaResult logout() {
            StpUtil.logout();
            return SaResult.ok();
        }
    }

接下来我们访问[http://localhost:8081/user/doLogin?username=lisi&password=123456][http_localhost_8081_user_doLogin_username_lisi_password_123456]

![7674bce8e3823db020ce328f1e2a9adb.png][]

这里我们使用SaResult.ok();satoken已将我们的返回结果进行封装过；

查看当前的登录状态[http://localhost:8081/user/isLogin][http_localhost_8081_user_isLogin]

![61f1566807f691fb02826833b147fbe3.png][]

查看当前的token详情：[http://localhost:8081/user/takernInfo][http_localhost_8081_user_takernInfo]

![bf1b2ac3760a32a1ba612556016005ca.png][]

将我们登录的账号退出登录：[http://localhost:8081/user/logout][http_localhost_8081_user_logout]

![e16323e1aef79f8e33dc2df274284248.png][]

我们再去访问查看当前的登录状态[http://localhost:8081/user/isLogin][http_localhost_8081_user_isLogin]

![e96b372326a38ffed1f92339bac47a7a.png][]

发现账号的登录状态已经为false,已经推出了登录；

本前文章先对sa-token的登录认证做一个讲解，后续会对用户的权限认证做一个讲解

[http_localhost_8081_user_doLogin_username_lisi_password_123456]: http://localhost:8081/user/doLogin?username=lisi&password=123456
[7674bce8e3823db020ce328f1e2a9adb.png]: https://img-blog.csdnimg.cn/img_convert/7674bce8e3823db020ce328f1e2a9adb.png
[http_localhost_8081_user_isLogin]: http://localhost:8081/user/isLogin
[61f1566807f691fb02826833b147fbe3.png]: https://img-blog.csdnimg.cn/img_convert/61f1566807f691fb02826833b147fbe3.png
[http_localhost_8081_user_takernInfo]: http://localhost:8081/user/takernInfo
[bf1b2ac3760a32a1ba612556016005ca.png]: https://img-blog.csdnimg.cn/img_convert/bf1b2ac3760a32a1ba612556016005ca.png
[http_localhost_8081_user_logout]: http://localhost:8081/user/logout
[e16323e1aef79f8e33dc2df274284248.png]: https://img-blog.csdnimg.cn/img_convert/e16323e1aef79f8e33dc2df274284248.png
[e96b372326a38ffed1f92339bac47a7a.png]: https://img-blog.csdnimg.cn/img_convert/e96b372326a38ffed1f92339bac47a7a.png