diff --git a/README.md b/README.md index 3e5e92dbe0a49a1a343677dd8aab03be2b2a1a83..e9e8a1dde949d547fc77b84fe5cbf1399c3fa190 100644 --- a/README.md +++ b/README.md @@ -24,11 +24,30 @@ - [需求提交:我们深知一个优秀的项目需要海纳百川,点我在线提交需求](http://sa-app.dev33.cn/wall.html?name=sa-token) -- [开源不易,求鼓励,点个star吧](https://github.com/click33/sa-token) +- [开源不易,求鼓励,点个star吧](###) ## sa-token是什么? -sa-token是一个JavaWeb轻量级权限认证框架,其API调用非常简单,有多简单呢?以登录验证为例,你只需要: +sa-token是一个JavaWeb轻量级权限认证框架,主要解决项目中登录认证、权限认证、Session会话等一系列由此衍生的权限相关业务 + +在架构设计上`sa-token`拒绝引入复杂的概念,以实际业务需求为第一目标进行定向突破,例如踢人下线、自动续签、同端互斥登录等常见业务在框架内均可以一行代码调用实现,简单粗暴,拒绝复杂! + +对于传统Session会话模型的N多难题,例如难以分布式、水平扩展性差,难以兼容前后台分离环境,多会话管理混乱等, +`sa-token`独创了以账号为主的`Id-Session`模式,同时又兼容了传统以token为主的`Token-Session`模式,两者彼此独立,互不干扰, +让你在进行会话管理时可以如鱼得水,在`sa-toekn`的强力加持下,权限问题将不再成为业务逻辑的瓶颈! + +总的来说,与其它权限认证框架相比,`sa-token`具有以下优势: +1. 上手简单:可零配置启动框架,能自动化的均已自动化,不让你费脑子 +2. 功能强大:能集成的功能全部集成,不让你用个框架还要自己给框架打各种补丁 +3. API简单易用:同样的一个功能,可能在别的框架中需要上百行代码,但是在sa-token中统统一行代码调个方法即可解决 +4. 组件易于扩展:框架中几乎所有组件都提供了对应的扩展接口,90%以上的逻辑都是可以被按需重写的 + +有了sa-token,是时候和那些老旧权限框架说拜拜了! + + +## 代码示例 + +sa-token的API调用非常简单,有多简单呢?以登录验证为例,你只需要: ``` java // 在登录时写入当前会话的账号id @@ -38,16 +57,6 @@ StpUtil.setLoginId(10001); StpUtil.checkLogin(); ``` - -没有复杂的封装!不要任何的配置!只需这两行简单的调用,即可轻松完成系统登录鉴权! - - -## 框架设计思想 -与其它权限认证框架相比,`sa-token`尽力保证两点: -- 上手简单:能自动化的配置全部自动化,不让你费脑子 -- 功能强大:能涵盖的功能全部涵盖,不让你用个框架还要自己给框架打各种补丁 - - 如果上面的示例能够证明`sa-token`的简单,那么以下API则可以证明`sa-token`的强大 ``` java StpUtil.setLoginId(10001); // 标记当前会话登录的账号id @@ -66,8 +75,6 @@ StpUtil.logoutByLoginId(10001, "PC"); // 指定设备标识进行强制注销 sa-token的API众多,请恕此处无法为您逐一展示,更多示例请戳官方在线文档 - - ## 涵盖功能 - **登录验证** —— 轻松登录鉴权,并提供五种细分场景值 - **权限验证** —— 拦截违规调用,不同角色不同授权 @@ -85,21 +92,24 @@ sa-token的API众多,请恕此处无法为您逐一展示,更多示例请戳 - **更多功能正在集成中...** —— 如有您有好想法或者建议,欢迎加群交流 -## 贡献代码 -sa-token欢迎大家贡献代码,为框架添砖加瓦 -1. 在github上fork一份到自己的仓库 +## 参与贡献 +众人拾柴火焰高,sa-token秉承着开放的思想,欢迎大家贡献代码,为框架添砖加瓦 + +1. 在gitee或者github上fork一份代码到自己的仓库 2. clone自己的仓库到本地电脑 3. 在本地电脑修改、commit、push 4. 提交pr(点击:New Pull Request) 5. 等待合并 +作者寄语:参与贡献不光只有提交代码一个选择,点一个star、提一个issues都是对开源项目的促进, +如果框架帮助到了你,欢迎你把框架推荐给你的朋友、同事使用,为sa-token的推广做一份贡献 + ## 建议贡献的地方 -- 修复源码现有bug,或增加新的实用功能 -- 完善在线文档,或者修复现有错误之处 -- 更多demo示例:比如SSM版搭建步骤 +- 修复源码现有bug,或优化代码架构,或增加新的实用功能 +- 完善在线文档,或者修复现有描述错误之处 +- 更多的第三方框架集成方案,更多的demo示例:比如SSM版搭建步骤 - 您可以参考项目issues与需求墙进行贡献 -- 如果更新实用功能,可在文档友情链接处留下自己的推广链接 ## 友情链接 diff --git a/sa-token-doc/doc/README.md b/sa-token-doc/doc/README.md index 3e5e92dbe0a49a1a343677dd8aab03be2b2a1a83..e9e8a1dde949d547fc77b84fe5cbf1399c3fa190 100644 --- a/sa-token-doc/doc/README.md +++ b/sa-token-doc/doc/README.md @@ -24,11 +24,30 @@ - [需求提交:我们深知一个优秀的项目需要海纳百川,点我在线提交需求](http://sa-app.dev33.cn/wall.html?name=sa-token) -- [开源不易,求鼓励,点个star吧](https://github.com/click33/sa-token) +- [开源不易,求鼓励,点个star吧](###) ## sa-token是什么? -sa-token是一个JavaWeb轻量级权限认证框架,其API调用非常简单,有多简单呢?以登录验证为例,你只需要: +sa-token是一个JavaWeb轻量级权限认证框架,主要解决项目中登录认证、权限认证、Session会话等一系列由此衍生的权限相关业务 + +在架构设计上`sa-token`拒绝引入复杂的概念,以实际业务需求为第一目标进行定向突破,例如踢人下线、自动续签、同端互斥登录等常见业务在框架内均可以一行代码调用实现,简单粗暴,拒绝复杂! + +对于传统Session会话模型的N多难题,例如难以分布式、水平扩展性差,难以兼容前后台分离环境,多会话管理混乱等, +`sa-token`独创了以账号为主的`Id-Session`模式,同时又兼容了传统以token为主的`Token-Session`模式,两者彼此独立,互不干扰, +让你在进行会话管理时可以如鱼得水,在`sa-toekn`的强力加持下,权限问题将不再成为业务逻辑的瓶颈! + +总的来说,与其它权限认证框架相比,`sa-token`具有以下优势: +1. 上手简单:可零配置启动框架,能自动化的均已自动化,不让你费脑子 +2. 功能强大:能集成的功能全部集成,不让你用个框架还要自己给框架打各种补丁 +3. API简单易用:同样的一个功能,可能在别的框架中需要上百行代码,但是在sa-token中统统一行代码调个方法即可解决 +4. 组件易于扩展:框架中几乎所有组件都提供了对应的扩展接口,90%以上的逻辑都是可以被按需重写的 + +有了sa-token,是时候和那些老旧权限框架说拜拜了! + + +## 代码示例 + +sa-token的API调用非常简单,有多简单呢?以登录验证为例,你只需要: ``` java // 在登录时写入当前会话的账号id @@ -38,16 +57,6 @@ StpUtil.setLoginId(10001); StpUtil.checkLogin(); ``` - -没有复杂的封装!不要任何的配置!只需这两行简单的调用,即可轻松完成系统登录鉴权! - - -## 框架设计思想 -与其它权限认证框架相比,`sa-token`尽力保证两点: -- 上手简单:能自动化的配置全部自动化,不让你费脑子 -- 功能强大:能涵盖的功能全部涵盖,不让你用个框架还要自己给框架打各种补丁 - - 如果上面的示例能够证明`sa-token`的简单,那么以下API则可以证明`sa-token`的强大 ``` java StpUtil.setLoginId(10001); // 标记当前会话登录的账号id @@ -66,8 +75,6 @@ StpUtil.logoutByLoginId(10001, "PC"); // 指定设备标识进行强制注销 sa-token的API众多,请恕此处无法为您逐一展示,更多示例请戳官方在线文档 - - ## 涵盖功能 - **登录验证** —— 轻松登录鉴权,并提供五种细分场景值 - **权限验证** —— 拦截违规调用,不同角色不同授权 @@ -85,21 +92,24 @@ sa-token的API众多,请恕此处无法为您逐一展示,更多示例请戳 - **更多功能正在集成中...** —— 如有您有好想法或者建议,欢迎加群交流 -## 贡献代码 -sa-token欢迎大家贡献代码,为框架添砖加瓦 -1. 在github上fork一份到自己的仓库 +## 参与贡献 +众人拾柴火焰高,sa-token秉承着开放的思想,欢迎大家贡献代码,为框架添砖加瓦 + +1. 在gitee或者github上fork一份代码到自己的仓库 2. clone自己的仓库到本地电脑 3. 在本地电脑修改、commit、push 4. 提交pr(点击:New Pull Request) 5. 等待合并 +作者寄语:参与贡献不光只有提交代码一个选择,点一个star、提一个issues都是对开源项目的促进, +如果框架帮助到了你,欢迎你把框架推荐给你的朋友、同事使用,为sa-token的推广做一份贡献 + ## 建议贡献的地方 -- 修复源码现有bug,或增加新的实用功能 -- 完善在线文档,或者修复现有错误之处 -- 更多demo示例:比如SSM版搭建步骤 +- 修复源码现有bug,或优化代码架构,或增加新的实用功能 +- 完善在线文档,或者修复现有描述错误之处 +- 更多的第三方框架集成方案,更多的demo示例:比如SSM版搭建步骤 - 您可以参考项目issues与需求墙进行贡献 -- 如果更新实用功能,可在文档友情链接处留下自己的推广链接 ## 友情链接