【Sa-Token】二、Sa-Token基本配置类

￡神魔★判官ぃ 2022-08-29 09:57 805阅读 0赞

我们已经实现了 Sa-Token 的登录方法，并在登录成功后，返回给前端 token 信息，本篇文章介绍在 Sa-Token 中的一些个性化配置参数

配置参数我们可以写在 SpringBoot 的配置文件中，也可以通过配置类，来配置 Sa-Token 的参数信息，本片文章主要讲配置类的方式

## 1、配置文件 方式 ##

server:
        # 端口
        port: 8080
    
    # 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

## 2、配置类方式 ##

package com.asurplus.common.satoken;
    
    import cn.dev33.satoken.config.SaTokenConfig;
    import org.apache.commons.lang3.StringUtils;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.Primary;
    
    /**
     * Sa-Token代码方式进行配置
     */
    @Configuration
    public class SaTokenConfigure {
    
        /**
         * 配置参数
         *
         * @return
         */
        @Bean
        @Primary
        public SaTokenConfig getSaTokenConfigPrimary() {
            SaTokenConfig config = new SaTokenConfig();
            // token名称 (同时也是cookie名称)
            config.setTokenName("Authorization");
            // token风格
            config.setTokenStyle("tik");
            // token前缀
            config.setTokenPrefix("Bearer");
            // token有效期，单位s 默认30天，不支持自动续签
            config.setTimeout(30 * 24 * 60 * 60);
            // token临时有效期 (指定时间内无操作就视为token过期) 单位: 秒，支持自动续签
            config.setActivityTimeout((30 * 60);
            // 自动续签，指定时间内有操作，则会自动续签
            config.setAutoRenew(true);
            // 是否尝试从header里读取token
            config.setIsReadHead(true);
            // 是否尝试从cookie里读取token
            config.setIsReadCookie(false);
            // 是否尝试从请求体里读取token
            config.setIsReadBody(false);
            // 是否允许同一账号并发登录 (为true时允许一起登录, 为false时新登录挤掉旧登录)
            config.setIsConcurrent(false);
            // 在多人登录同一账号时，是否共用一个token (为true时所有登录共用一个token, 为false时每次登录新建一个token)
            config.setIsShare(false);
            // 是否在初始化配置时打印版本字符画
            config.setIsPrint(true);
            // 是否输出操作日志
            config.setIsLog(true);
            return config;
        }
    }

前后端直接传递用户身份信息有三种方式，

> 1、cookie 的方式  
> 2、head 的方式  
> 3、body 的方式

## 3、配置信息说明 ##

我们配置了以在 head 中传递 token 的方式实现前后端分离开发，token 的生成规则为 tik 方式，生成效果如下：

VW_aA7q8lPRkRn91S_2h06K63wHy6ekBYH__

我们还配置了 token 的前缀为 Bearer，在 head 中传递的 key 为 Authorization

配置了 token 的过期时间为 30 \* 24 \* 60 \* 60 秒，也就是 30 天，临时有效期为 30 \* 60 秒，也就是 30 分钟，怎么理解呢？

也就是说后端生成的 token，即使用户一直操作，在 30 天后一定会过期，要求用户重新登录

临时有效期 30 分钟，也就是如果用户超过 30 分钟不操作，此 token 就会过期，便会要求用户重新登录

有效期不支持自动续签

临时有效期支持自动续签

其他的配置信息，请参考开发文档或阅读源码