提交 064ef4f1 编写于 作者: shengzhang_'s avatar shengzhang_

优化readme

上级 a8688cc0
......@@ -16,7 +16,7 @@
---
## 😘 在线资料
## 在线资料
- [官网首页:http://sa-token.dev33.cn/](http://sa-token.dev33.cn/)
......@@ -27,8 +27,8 @@
- [开源不易,求鼓励,点个star吧](https://github.com/click33/sa-token)
## sa-token是什么?
**sa-token是一个JavaWeb轻量级权限认证框架,其API调用非常简单,有多简单呢?以登录验证为例,你只需要:**
## sa-token是什么?
sa-token是一个JavaWeb轻量级权限认证框架,其API调用非常简单,有多简单呢?以登录验证为例,你只需要:
``` java
// 在登录时写入当前会话的账号id
......@@ -39,16 +39,16 @@ StpUtil.checkLogin();
```
**没有复杂的封装!不要任何的配置!只需这两行简单的调用,即可轻松完成系统登录鉴权!**
没有复杂的封装!不要任何的配置!只需这两行简单的调用,即可轻松完成系统登录鉴权!
## 🔥 框架设计思想
## 框架设计思想
与其它权限认证框架相比,`sa-token`尽力保证两点:
- 上手简单:能自动化的配置全部自动化,不让你费脑子
- 功能强大:能涵盖的功能全部涵盖,不让你用个框架还要自己给框架打各种补丁
**如果上面的示例能够证明`sa-token`的简单,那么以下API则可以证明`sa-token`的强大**
如果上面的示例能够证明`sa-token`的简单,那么以下API则可以证明`sa-token`的强大
``` java
StpUtil.setLoginId(10001); // 标记当前会话登录的账号id
StpUtil.getLoginId(); // 获取当前会话登录的账号id
......@@ -61,12 +61,12 @@ StpUtil.getSession(); // 获取当前账号id的Session
StpUtil.getSessionByLoginId(10001); // 获取账号id为10001的Session
StpUtil.getTokenValueByLoginId(10001); // 获取账号id为10001的token令牌值
```
**sa-token的API众多,请恕此处无法为您逐一展示,更多示例请戳官方在线文档**
sa-token的API众多,请恕此处无法为您逐一展示,更多示例请戳官方在线文档
## 💦️️ 涵盖功能
## 涵盖功能
- **登录验证** —— 轻松登录鉴权,并提供五种细分场景值
- **权限验证** —— 拦截违规调用,不同角色不同授权
- **Session会话** —— 专业的数据缓存中心
......@@ -82,7 +82,7 @@ StpUtil.getTokenValueByLoginId(10001); // 获取账号id为10001的token令牌
- **更多功能正在集成中...** —— 如有您有好想法或者建议,欢迎加群交流
## 🔨 贡献代码
## 贡献代码
sa-token欢迎大家贡献代码,为框架添砖加瓦
1. 在github上fork一份到自己的仓库
2. clone自己的仓库到本地电脑
......@@ -91,7 +91,7 @@ sa-token欢迎大家贡献代码,为框架添砖加瓦
5. 等待合并
## 🌱 建议贡献的地方
## 建议贡献的地方
- 修复源码现有bug,或增加新的实用功能
- 完善在线文档,或者修复现有错误之处
- 更多demo示例:比如SSM版搭建步骤
......@@ -99,11 +99,11 @@ sa-token欢迎大家贡献代码,为框架添砖加瓦
- 如果更新实用功能,可在文档友情链接处留下自己的推广链接
## 🚀 友情链接
## 友情链接
[**[ okhttps ]** 一个轻量级http通信框架,支持 WebSocket 以及 Stomp 协议](https://gitee.com/ejlchina-zhxu/okhttps)
## 😎 交流群
## 交流群
QQ交流群:[1002350610 点击加入](https://jq.qq.com/?_wv=1027&k=45H977HM) ,欢迎你的加入
......
......@@ -16,7 +16,7 @@
---
## 😘 在线资料
## 在线资料
- [官网首页:http://sa-token.dev33.cn/](http://sa-token.dev33.cn/)
......@@ -27,8 +27,8 @@
- [开源不易,求鼓励,点个star吧](https://github.com/click33/sa-token)
## sa-token是什么?
**sa-token是一个JavaWeb轻量级权限认证框架,其API调用非常简单,有多简单呢?以登录验证为例,你只需要:**
## sa-token是什么?
sa-token是一个JavaWeb轻量级权限认证框架,其API调用非常简单,有多简单呢?以登录验证为例,你只需要:
``` java
// 在登录时写入当前会话的账号id
......@@ -39,16 +39,16 @@ StpUtil.checkLogin();
```
**没有复杂的封装!不要任何的配置!只需这两行简单的调用,即可轻松完成系统登录鉴权!**
没有复杂的封装!不要任何的配置!只需这两行简单的调用,即可轻松完成系统登录鉴权!
## 🔥 框架设计思想
## 框架设计思想
与其它权限认证框架相比,`sa-token`尽力保证两点:
- 上手简单:能自动化的配置全部自动化,不让你费脑子
- 功能强大:能涵盖的功能全部涵盖,不让你用个框架还要自己给框架打各种补丁
**如果上面的示例能够证明`sa-token`的简单,那么以下API则可以证明`sa-token`的强大**
如果上面的示例能够证明`sa-token`的简单,那么以下API则可以证明`sa-token`的强大
``` java
StpUtil.setLoginId(10001); // 标记当前会话登录的账号id
StpUtil.getLoginId(); // 获取当前会话登录的账号id
......@@ -61,12 +61,12 @@ StpUtil.getSession(); // 获取当前账号id的Session
StpUtil.getSessionByLoginId(10001); // 获取账号id为10001的Session
StpUtil.getTokenValueByLoginId(10001); // 获取账号id为10001的token令牌值
```
**sa-token的API众多,请恕此处无法为您逐一展示,更多示例请戳官方在线文档**
sa-token的API众多,请恕此处无法为您逐一展示,更多示例请戳官方在线文档
## 💦️️ 涵盖功能
## 涵盖功能
- **登录验证** —— 轻松登录鉴权,并提供五种细分场景值
- **权限验证** —— 拦截违规调用,不同角色不同授权
- **Session会话** —— 专业的数据缓存中心
......@@ -82,7 +82,7 @@ StpUtil.getTokenValueByLoginId(10001); // 获取账号id为10001的token令牌
- **更多功能正在集成中...** —— 如有您有好想法或者建议,欢迎加群交流
## 🔨 贡献代码
## 贡献代码
sa-token欢迎大家贡献代码,为框架添砖加瓦
1. 在github上fork一份到自己的仓库
2. clone自己的仓库到本地电脑
......@@ -91,7 +91,7 @@ sa-token欢迎大家贡献代码,为框架添砖加瓦
5. 等待合并
## 🌱 建议贡献的地方
## 建议贡献的地方
- 修复源码现有bug,或增加新的实用功能
- 完善在线文档,或者修复现有错误之处
- 更多demo示例:比如SSM版搭建步骤
......@@ -99,11 +99,11 @@ sa-token欢迎大家贡献代码,为框架添砖加瓦
- 如果更新实用功能,可在文档友情链接处留下自己的推广链接
## 🚀 友情链接
## 友情链接
[**[ okhttps ]** 一个轻量级http通信框架,支持 WebSocket 以及 Stomp 协议](https://gitee.com/ejlchina-zhxu/okhttps)
## 😎 交流群
## 交流群
QQ交流群:[1002350610 点击加入](https://jq.qq.com/?_wv=1027&k=45H977HM) ,欢迎你的加入
......
......@@ -52,7 +52,7 @@
<a href="https://github.com/click33/sa-token" target="_blank">GitHub</a>
<a href="https://gitee.com/sz6/sa-token" target="_blank">码云</a>
<a href="http://sa-app.dev33.cn/wall.html?name=sa-token" target="_blank">需求墙</a>
<a href="doc/" target="_self">开发文档</a>
<a href="doc/index.html" target="_self">开发文档</a>
</div>
</div>
</div>
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册