1
0
mirror of synced 2026-05-22 22:53:16 +00:00

优化Readme

This commit is contained in:
shengzhang
2021-06-03 23:31:11 +08:00
parent c57a5cfc9d
commit 3aed3f96ec
+11 -11
View File
@@ -38,7 +38,7 @@ Sa-Token是一个轻量级Java权限认证框架,主要解决:登录认证
3. **易用** :如丝般顺滑的API调用,大量高级特性统统只需一行代码即可实现
4. **高扩展** :几乎所有组件都提供了扩展接口,90%以上的逻辑都可以按需重写
有了sa-token,你所有的权限认证问题,都不再是问题!
有了Sa-Token,你所有的权限认证问题,都不再是问题!
## Sa-Token 能做什么?
@@ -72,7 +72,7 @@ Sa-Token是一个轻量级Java权限认证框架,主要解决:登录认证
## 代码示例
sa-token的API调用非常简单,有多简单呢?以登录验证为例,你只需要:
Sa-Token的API调用非常简单,有多简单呢?以登录验证为例,你只需要:
``` java
// 在登录时写入当前会话的账号id
@@ -82,13 +82,13 @@ StpUtil.setLoginId(10001);
// 如果当前会话未登录,这句代码会抛出 `NotLoginException`异常
StpUtil.checkLogin();
```
至此,我们已经借助sa-token框架完成登录授权!
至此,我们已经借助Sa-Token框架完成登录授权!
此时的你小脑袋可能飘满了问号,就这么简单?自定义Realm呢?全局过滤器呢?我不用写各种配置文件吗?
事实上在此我可以负责的告诉你,在sa-token中,登录授权就是如此的简单,不需要什么全局过滤器,不需要各种乱七八糟的配置!只需要这一行简单的API调用,即可完成会话的登录授权!
事实上在此我可以负责的告诉你,在Sa-Token中,登录授权就是如此的简单,不需要什么全局过滤器,不需要各种乱七八糟的配置!只需要这一行简单的API调用,即可完成会话的登录授权!
当你受够Shiro、Spring Security等框架的三拜九叩之后,你就会明白,相对于这些传统老牌框架,sa-token的API设计是多么的清爽!
当你受够Shiro、Spring Security等框架的三拜九叩之后,你就会明白,相对于这些传统老牌框架,Sa-Token的API设计是多么的清爽!
权限认证示例 (只有具有`user:add`权限的会话才可以进入请求)
``` java
@@ -106,7 +106,7 @@ public String insert(SysUser user) {
StpUtil.logoutByLoginId(10001);
```
除了以上的示例,sa-token还可以一行代码完成以下功能:
除了以上的示例,Sa-Token还可以一行代码完成以下功能:
``` java
StpUtil.setLoginId(10001); // 标记当前会话登录的账号id
StpUtil.getLoginId(); // 获取当前会话登录的账号id
@@ -122,7 +122,7 @@ StpUtil.setLoginId(10001, "PC"); // 指定设备标识登录
StpUtil.logoutByLoginId(10001, "PC"); // 指定设备标识进行强制注销 (不同端不受影响)
StpUtil.switchTo(10044); // 将当前会话身份临时切换为其它账号
```
sa-token API 众多,请恕此处无法为您逐一展示,更多示例请戳官方在线文档
Sa-Token API 众多,请恕此处无法为您逐一展示,更多示例请戳官方在线文档
## Star 趋势
@@ -133,7 +133,7 @@ sa-token API 众多,请恕此处无法为您逐一展示,更多示例请戳
## 参与贡献
众人拾柴火焰高,万丈高楼众人起!
sa-token秉承着开放的思想,欢迎大家为框架添砖加瓦:
Sa-Token秉承着开放的思想,欢迎大家为框架添砖加瓦:
1. 核心代码:该部分需要开发者了解整个框架的架构,遵循已有代码规范进行bug修复或提交新功能
2. 文档部分:需要以清晰明了的语句书写文档,力求简单易读,授人以鱼同时更授人以渔
@@ -142,17 +142,17 @@ sa-token秉承着开放的思想,欢迎大家为框架添砖加瓦:
5. 其它部分:您可以参考项目issues与需求墙进行贡献
作者寄语:参与贡献不光只有提交代码,点一个star、提一个issues都是对开源项目的促进,
如果sa-token帮助到了你,欢迎你把框架推荐给朋友、同事使用,为sa-token的推广做一份贡献
如果Sa-Token帮助到了你,欢迎你把框架推荐给朋友、同事使用,为Sa-Token的推广做一份贡献
## 使用sa-token的开源项目
## 使用Sa-Token的开源项目
[**[ sa-plus]** 一个基于springboot架构的快速开发框架,内置代码生成器](https://gitee.com/click33/sa-plus)
[**[ jthink]** 一个基于springboot+sa-token+thymeleaf的博客系统](https://gitee.com/wtsoftware/jthink)
[**[ dcy-fast]** 一个基于springboot+sa-token+mybatis-plus的后台管理系统,前端vue-element-admin,并且内置代码生成器](https://gitee.com/dcy421/dcy-fast)
如果您的项目使用了sa-token,欢迎提交pr
如果您的项目使用了Sa-Token,欢迎提交pr
## 友情链接