sa-token/sa-token-doc/doc/start/example.md
2021-03-26 01:17:15 +08:00

2.7 KiB
Raw Blame History

示例

本篇将带你从零开始集成sa-token从而让你快速熟悉sa-token的使用姿势
以Maven + SpringBoot为例


SpringBoot环境

1、创建项目

在IDE中新建一个Springboot项目例如sa-token-demo-springboot不会的同学请自行百度或者参考github示例

2、设置jar包依赖

pom.xml 中添加依赖:

<!-- sa-token 权限认证, 在线文档http://sa-token.dev33.cn/ -->
<dependency>
	<groupId>cn.dev33</groupId>
	<artifactId>sa-token-spring-boot-starter</artifactId>
	<version>1.15.2</version>
</dependency>

3、配置文件

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

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

如果你习惯于 application.properties 类型的配置文件,那也很好办:
百度: springboot properties与yml 配置文件的区别

4、创建启动类

在项目中新建包 com.pj ,在此包内新建主类 SaTokenDemoApplication.java,输入以下代码:

@SpringBootApplication
public class SaTokenDemoApplication {
	public static void main(String[] args) throws JsonProcessingException {
		SpringApplication.run(SaTokenDemoApplication.class, args);
		System.out.println("启动成功sa-token配置如下" + SaTokenManager.getConfig());
	}
}

5、运行

运行代码,当你从控制台看到类似下面的内容时,就代表框架已经成功集成了

运行结果

普通Spring环境

普通spring环境与springboot环境大体无异只不过需要在项目根目录手动创建配置文件sa-token.properties来完成配置

详细了解

通过这个示例你已经对sa-token有了初步的了解那么现在开始详细了解一下它都有哪些能力