2020-02-06 00:52:49 +08:00
|
|
|
|
# 示例
|
|
|
|
|
|
2021-01-31 23:28:42 +08:00
|
|
|
|
本篇将带你从零开始集成sa-token,从而让你快速熟悉sa-token的使用姿势 <br>
|
2021-02-06 13:42:42 +08:00
|
|
|
|
以Maven + SpringBoot为例
|
2021-01-31 23:28:42 +08:00
|
|
|
|
|
2020-02-06 00:52:49 +08:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
2021-02-06 13:42:42 +08:00
|
|
|
|
## SpringBoot环境
|
2020-02-06 00:52:49 +08:00
|
|
|
|
|
|
|
|
|
#### 1、创建项目
|
|
|
|
|
在IDE中新建一个Springboot项目,例如:`sa-token-demo-springboot`(不会的同学请自行百度或者参考github示例)
|
|
|
|
|
|
|
|
|
|
#### 2、设置jar包依赖
|
2021-01-31 23:28:42 +08:00
|
|
|
|
在 `pom.xml` 中添加依赖:
|
2020-02-06 00:52:49 +08:00
|
|
|
|
|
|
|
|
|
``` xml
|
2020-02-08 00:54:38 +08:00
|
|
|
|
<!-- sa-token 权限认证, 在线文档:http://sa-token.dev33.cn/ -->
|
|
|
|
|
<dependency>
|
|
|
|
|
<groupId>cn.dev33</groupId>
|
2020-12-24 22:51:57 +08:00
|
|
|
|
<artifactId>sa-token-spring-boot-starter</artifactId>
|
2021-03-26 01:17:15 +08:00
|
|
|
|
<version>1.15.2</version>
|
2020-02-08 00:54:38 +08:00
|
|
|
|
</dependency>
|
2020-02-06 00:52:49 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### 3、配置文件
|
2021-01-31 23:28:42 +08:00
|
|
|
|
你可以**零配置启动项目** <br>
|
|
|
|
|
但同时你也可以在`application.yml`中增加如下配置,定制性使用框架:
|
2020-02-06 00:52:49 +08:00
|
|
|
|
|
|
|
|
|
``` java
|
|
|
|
|
spring:
|
|
|
|
|
# sa-token配置
|
|
|
|
|
sa-token:
|
2020-09-29 23:45:37 +08:00
|
|
|
|
# token名称 (同时也是cookie名称)
|
2020-02-06 00:52:49 +08:00
|
|
|
|
token-name: satoken
|
2020-12-25 00:16:12 +08:00
|
|
|
|
# token有效期,单位s 默认30天, -1代表永不过期
|
2020-02-06 00:52:49 +08:00
|
|
|
|
timeout: 2592000
|
2021-01-02 04:00:49 +08:00
|
|
|
|
# token临时有效期 (指定时间内无操作就视为token过期) 单位: 秒
|
2020-12-25 00:16:12 +08:00
|
|
|
|
activity-timeout: -1
|
2021-01-02 04:00:49 +08:00
|
|
|
|
# 是否允许同一账号并发登录 (为true时允许一起登录, 为false时新登录挤掉旧登录)
|
|
|
|
|
allow-concurrent-login: false
|
|
|
|
|
# 在多人登录同一账号时,是否共用一个token (为true时所有登录共用一个token, 为false时每次登录新建一个token)
|
|
|
|
|
is-share: false
|
2020-12-25 00:16:12 +08:00
|
|
|
|
# token风格
|
|
|
|
|
token-style: uuid
|
2020-02-06 00:52:49 +08:00
|
|
|
|
```
|
|
|
|
|
|
2021-01-31 23:28:42 +08:00
|
|
|
|
如果你习惯于 `application.properties` 类型的配置文件,那也很好办: <br>
|
|
|
|
|
百度: [springboot properties与yml 配置文件的区别](https://www.baidu.com/s?ie=UTF-8&wd=springboot%20properties%E4%B8%8Eyml%20%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%E7%9A%84%E5%8C%BA%E5%88%AB)
|
2020-02-06 00:52:49 +08:00
|
|
|
|
|
2021-02-06 13:42:42 +08:00
|
|
|
|
|
|
|
|
|
#### 4、创建启动类
|
2020-02-06 00:52:49 +08:00
|
|
|
|
在项目中新建包 `com.pj` ,在此包内新建主类 `SaTokenDemoApplication.java`,输入以下代码:
|
|
|
|
|
|
|
|
|
|
``` java
|
|
|
|
|
@SpringBootApplication
|
|
|
|
|
public class SaTokenDemoApplication {
|
|
|
|
|
public static void main(String[] args) throws JsonProcessingException {
|
2021-01-02 04:00:49 +08:00
|
|
|
|
SpringApplication.run(SaTokenDemoApplication.class, args);
|
2020-02-06 00:52:49 +08:00
|
|
|
|
System.out.println("启动成功:sa-token配置如下:" + SaTokenManager.getConfig());
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### 5、运行
|
|
|
|
|
运行代码,当你从控制台看到类似下面的内容时,就代表框架已经成功集成了
|
|
|
|
|
|
|
|
|
|
![运行结果](https://color-test.oss-cn-qingdao.aliyuncs.com/sa-token/app-run.jpg)
|
|
|
|
|
|
|
|
|
|
|
2021-02-06 13:42:42 +08:00
|
|
|
|
## 普通Spring环境
|
2021-01-31 23:28:42 +08:00
|
|
|
|
普通spring环境与springboot环境大体无异,只不过需要在项目根目录手动创建配置文件`sa-token.properties`来完成配置
|
2020-02-06 00:52:49 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## 详细了解
|
|
|
|
|
通过这个示例,你已经对sa-token有了初步的了解,那么现在开始详细了解一下它都有哪些[能力](/use/login-auth)吧
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|