From c57a5cfc9d292214815750ed58eadbcb78587f8f Mon Sep 17 00:00:00 2001 From: shengzhang <2393584716@qq.com> Date: Thu, 3 Jun 2021 23:30:16 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9E=20SaRouter.stop()=20?= =?UTF-8?q?=E5=87=BD=E6=95=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 10 +-- mvn clean.bat | 4 + .../satoken/exception/StopMatchException.java | 22 ++++++ .../{SaRouterUtil.java => SaRouter.java} | 12 ++- .../java/com/pj/satoken/SaTokenConfigure.java | 2 +- .../java/com/pj/satoken/SaTokenConfigure.java | 9 ++- .../java/com/pj/satoken/SaTokenConfigure.java | 2 +- sa-token-doc/doc/README.md | 32 ++++---- sa-token-doc/doc/more/common-questions.md | 6 +- sa-token-doc/doc/start/webflux-example.md | 2 +- sa-token-doc/doc/use/global-filter.md | 2 +- sa-token-doc/doc/use/route-check.md | 75 ++++++++++++------- .../reactor/filter/SaReactorFilter.java | 7 +- .../{SolonPluginImpl.java => XPluginImp.java} | 2 +- .../solon/integration/SaTokenPathFilter.java | 9 ++- .../solon/cn.dev33.satoken.solon.properties | 2 +- .../dev33/satoken/filter/SaServletFilter.java | 7 +- .../interceptor/SaRouteInterceptor.java | 8 +- 18 files changed, 142 insertions(+), 71 deletions(-) create mode 100644 sa-token-core/src/main/java/cn/dev33/satoken/exception/StopMatchException.java rename sa-token-core/src/main/java/cn/dev33/satoken/router/{SaRouterUtil.java => SaRouter.java} (92%) rename sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/{SolonPluginImpl.java => XPluginImp.java} (97%) diff --git a/README.md b/README.md index 68d48c1f..bcabfbe8 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,9 @@ ## Sa-Token是什么？ Sa-Token是一个轻量级Java权限认证框架，主要解决：登录认证、权限认证、Session会话、单点登录、OAuth2.0 等一系列权限相关问题 -框架针对踢人下线、自动续签、前后台分离、分布式会话……等常见业务进行N多适配，通过sa-token，你可以以一种极简的方式实现系统的权限认证部分 +框架针对踢人下线、自动续签、前后台分离、分布式会话……等常见业务进行N多适配，通过Sa-Token，你可以以一种极简的方式实现系统的权限认证部分 -与其它权限认证框架相比，`sa-token` 具有以下优势： +与其它权限认证框架相比，`Sa-Token` 具有以下优势： 1. **简单** ：可零配置启动框架，真正的开箱即用，低成本上手 2. **强大** ：目前已集成几十项权限相关特性，涵盖了大部分业务场景的解决方案 3. **易用** ：如丝般顺滑的API调用，大量高级特性统统只需一行代码即可实现 @@ -42,8 +42,6 @@ Sa-Token是一个轻量级Java权限认证框架，主要解决：登录认证 ## Sa-Token 能做什么？ -![sa-token-js](https://oss.dev33.cn/sa-token/doc/sa-token-js.png 's-w') - - **登录验证** —— 轻松登录鉴权，并提供五种细分场景值 - **权限验证** —— 适配RBAC权限模型，不同角色不同授权 - **Session会话** —— 专业的数据缓存中心 @@ -69,6 +67,8 @@ Sa-Token是一个轻量级Java权限认证框架，主要解决：登录认证 - **开箱即用** —— 提供SpringMVC、WebFlux等常见web框架starter集成包，真正的开箱即用 - **更多功能正在集成中...** —— 如有您有好想法或者建议，欢迎加群交流 +![sa-token-js](https://color-test.oss-cn-qingdao.aliyuncs.com/sa-token/sa-token-js.png 's-w') + ## 代码示例 @@ -88,7 +88,7 @@ StpUtil.checkLogin(); 事实上在此我可以负责的告诉你，在sa-token中，登录授权就是如此的简单，不需要什么全局过滤器，不需要各种乱七八糟的配置！只需要这一行简单的API调用，即可完成会话的登录授权！ -当你受够Shiro、Security等框架的三拜九叩之后，你就会明白，相对于这些传统老牌框架，sa-token的API设计是多么的清爽！ +当你受够Shiro、Spring Security等框架的三拜九叩之后，你就会明白，相对于这些传统老牌框架，sa-token的API设计是多么的清爽！ 权限认证示例 (只有具有`user:add`权限的会话才可以进入请求) ``` java diff --git a/mvn clean.bat b/mvn clean.bat index 74f08ac4..b875dfd2 100644 --- a/mvn clean.bat +++ b/mvn clean.bat @@ -17,6 +17,10 @@ cd sa-token-demo-webflux call mvn clean cd .. +cd sa-token-demo-solon +call mvn clean +cd .. + cd sa-token-demo-oauth2-client call mvn clean cd .. diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/exception/StopMatchException.java b/sa-token-core/src/main/java/cn/dev33/satoken/exception/StopMatchException.java new file mode 100644 index 00000000..8f279331 --- /dev/null +++ b/sa-token-core/src/main/java/cn/dev33/satoken/exception/StopMatchException.java @@ -0,0 +1,22 @@ +package cn.dev33.satoken.exception; + +/** + * 一个异常：代表停止路由匹配 + * + * @author kong + */ +public class StopMatchException extends SaTokenException { + + /** + * 序列化版本号 + */ + private static final long serialVersionUID = 6806129545290130143L; + + /** + * 构造 + */ + public StopMatchException() { + super("stop match"); + } + +} diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/router/SaRouterUtil.java b/sa-token-core/src/main/java/cn/dev33/satoken/router/SaRouter.java similarity index 92% rename from sa-token-core/src/main/java/cn/dev33/satoken/router/SaRouterUtil.java rename to sa-token-core/src/main/java/cn/dev33/satoken/router/SaRouter.java index e8139bd4..26d06ae8 100644 --- a/sa-token-core/src/main/java/cn/dev33/satoken/router/SaRouterUtil.java +++ b/sa-token-core/src/main/java/cn/dev33/satoken/router/SaRouter.java @@ -5,6 +5,7 @@ import java.util.List; import cn.dev33.satoken.SaManager; import cn.dev33.satoken.context.SaHolder; +import cn.dev33.satoken.exception.StopMatchException; import cn.dev33.satoken.fun.IsRunFunction; import cn.dev33.satoken.fun.SaFunction; @@ -13,7 +14,7 @@ import cn.dev33.satoken.fun.SaFunction; * @author kong * */ -public class SaRouterUtil { +public class SaRouter { // -------------------- 路由匹配相关 -------------------- @@ -123,7 +124,16 @@ public class SaRouterUtil { boolean matchResult = isMatch(Arrays.asList(patterns), SaHolder.getRequest().getRequestPath()); return new IsRunFunction(matchResult); } + + // -------------------- 其它操作 -------------------- + + /** + * 停止匹配，跳出函数 (在多个匹配链中一次性跳出Auth函数) + */ + public static void stop() { + throw new StopMatchException(); + } diff --git a/sa-token-demo/sa-token-demo-solon/src/main/java/com/pj/satoken/SaTokenConfigure.java b/sa-token-demo/sa-token-demo-solon/src/main/java/com/pj/satoken/SaTokenConfigure.java index 70372415..f167dcc4 100644 --- a/sa-token-demo/sa-token-demo-solon/src/main/java/com/pj/satoken/SaTokenConfigure.java +++ b/sa-token-demo/sa-token-demo-solon/src/main/java/com/pj/satoken/SaTokenConfigure.java @@ -31,7 +31,7 @@ public class SaTokenConfigure { .setAuth(r -> { // System.out.println("---------- sa全局认证"); - // SaRouterUtil.match("/test/test", () -> new Object()); + // SaRouter.match("/test/test", () -> new Object()); }) // 异常处理函数：每次认证函数发生异常时执行此函数 diff --git a/sa-token-demo/sa-token-demo-springboot/src/main/java/com/pj/satoken/SaTokenConfigure.java b/sa-token-demo/sa-token-demo-springboot/src/main/java/com/pj/satoken/SaTokenConfigure.java index 5bc029dd..43d3ab0c 100644 --- a/sa-token-demo/sa-token-demo-springboot/src/main/java/com/pj/satoken/SaTokenConfigure.java +++ b/sa-token-demo/sa-token-demo-springboot/src/main/java/com/pj/satoken/SaTokenConfigure.java @@ -37,13 +37,14 @@ public class SaTokenConfigure implements WebMvcConfigurer { return new SaServletFilter() // 指定 [拦截路由] 与 [放行路由] - .addInclude("/**").addExclude("/favicon.ico") + .addInclude("/**")// .addExclude("/favicon.ico") // 认证函数: 每次请求执行 .setAuth(r -> { - // System.out.println("---------- sa全局认证"); - - // SaRouterUtil.match("/test/test", () -> new Object()); + System.out.println("---------- sa全局认证"); + System.out.println(SaHolder.getRequest().getRequestPath()); + + // SaRouter.match("/test/test", () -> new Object()); }) // 异常处理函数：每次认证函数发生异常时执行此函数 diff --git a/sa-token-demo/sa-token-demo-webflux/src/main/java/com/pj/satoken/SaTokenConfigure.java b/sa-token-demo/sa-token-demo-webflux/src/main/java/com/pj/satoken/SaTokenConfigure.java index ba8da8ca..0a8089f6 100644 --- a/sa-token-demo/sa-token-demo-webflux/src/main/java/com/pj/satoken/SaTokenConfigure.java +++ b/sa-token-demo/sa-token-demo-webflux/src/main/java/com/pj/satoken/SaTokenConfigure.java @@ -28,7 +28,7 @@ public class SaTokenConfigure { // 指定[认证函数]: 每次请求执行 .setAuth(r -> { System.out.println("---------- sa全局认证"); - // SaRouterUtil.match("/test/test", () -> StpUtil.checkLogin()); + // SaRouter.match("/test/test", () -> StpUtil.checkLogin()); }) // 指定[异常处理函数]：每次[认证函数]发生异常时执行此函数 .setError(e -> { diff --git a/sa-token-doc/doc/README.md b/sa-token-doc/doc/README.md index 2125cb8b..957f0d2f 100644 --- a/sa-token-doc/doc/README.md +++ b/sa-token-doc/doc/README.md @@ -26,23 +26,22 @@ - [开源不易，求鼓励，点个star吧 ！](###) + ## Sa-Token是什么？ Sa-Token是一个轻量级Java权限认证框架，主要解决：登录认证、权限认证、Session会话、单点登录、OAuth2.0 等一系列权限相关问题 -框架针对踢人下线、自动续签、前后台分离、分布式会话……等常见业务进行N多适配，通过sa-token，你可以以一种极简的方式实现系统的权限认证部分 +框架针对踢人下线、自动续签、前后台分离、分布式会话……等常见业务进行N多适配，通过Sa-Token，你可以以一种极简的方式实现系统的权限认证部分 -与其它权限认证框架相比，`sa-token` 具有以下优势： +与其它权限认证框架相比，`Sa-Token` 具有以下优势： 1. **简单** ：可零配置启动框架，真正的开箱即用，低成本上手 2. **强大** ：目前已集成几十项权限相关特性，涵盖了大部分业务场景的解决方案 3. **易用** ：如丝般顺滑的API调用，大量高级特性统统只需一行代码即可实现 4. **高扩展** ：几乎所有组件都提供了扩展接口，90%以上的逻辑都可以按需重写 -有了sa-token，你所有的权限认证问题，都不再是问题！ +有了Sa-Token，你所有的权限认证问题，都不再是问题！ ## Sa-Token 能做什么？ -![sa-token-js](https://oss.dev33.cn/sa-token/doc/sa-token-js.png 's-w') - - **登录验证** —— 轻松登录鉴权，并提供五种细分场景值 - **权限验证** —— 适配RBAC权限模型，不同角色不同授权 - **Session会话** —— 专业的数据缓存中心 @@ -68,10 +67,12 @@ Sa-Token是一个轻量级Java权限认证框架，主要解决：登录认证 - **开箱即用** —— 提供SpringMVC、WebFlux等常见web框架starter集成包，真正的开箱即用 - **更多功能正在集成中...** —— 如有您有好想法或者建议，欢迎加群交流 +![sa-token-js](https://color-test.oss-cn-qingdao.aliyuncs.com/sa-token/sa-token-js.png 's-w') + ## 代码示例 -sa-token的API调用非常简单，有多简单呢？以登录验证为例，你只需要： +Sa-Token的API调用非常简单，有多简单呢？以登录验证为例，你只需要： ``` java // 在登录时写入当前会话的账号id @@ -81,16 +82,15 @@ StpUtil.setLoginId(10001); // 如果当前会话未登录，这句代码会抛出 `NotLoginException`异常 StpUtil.checkLogin(); ``` -至此，我们已经借助sa-token框架完成登录授权！ +至此，我们已经借助Sa-Token框架完成登录授权！ 此时的你小脑袋可能飘满了问号，就这么简单？自定义Realm呢？全局过滤器呢？我不用写各种配置文件吗？ -事实上在此我可以负责的告诉你，在sa-token中，登录授权就是如此的简单，不需要什么全局过滤器，不需要各种乱七八糟的配置！只需要这一行简单的API调用，即可完成会话的登录授权！ +事实上在此我可以负责的告诉你，在Sa-Token中，登录授权就是如此的简单，不需要什么全局过滤器，不需要各种乱七八糟的配置！只需要这一行简单的API调用，即可完成会话的登录授权！ -当你受够Shiro、Security等框架的三拜九叩之后，你就会明白，相对于这些传统老牌框架，sa-token的API设计是多么的清爽！ +当你受够Shiro、Spring Security等框架的三拜九叩之后，你就会明白，相对于这些传统老牌框架，Sa-Token的API设计是多么的清爽！ 权限认证示例 (只有具有`user:add`权限的会话才可以进入请求) - ``` java @SaCheckPermission("user:add") @RequestMapping("/user/insert") @@ -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 ## 友情链接 diff --git a/sa-token-doc/doc/more/common-questions.md b/sa-token-doc/doc/more/common-questions.md index c1d49c14..91a9933e 100644 --- a/sa-token-doc/doc/more/common-questions.md +++ b/sa-token-doc/doc/more/common-questions.md @@ -28,9 +28,9 @@ 无论什么模型，只要能把一个用户具有的所有权限塞到一个List里返回给框架，就能集成 -### SaRouterUtil.match 有多个路径需要排除怎么办？ -可以点进去源码看一下，`SaRouterUtil.match`方法有多个重载，可以放一个集合, 例如：
-`SaRouterUtil.match(Arrays.asList("/**"), Arrays.asList("/login", "/reg"), () -> StpUtil.checkLogin());` +### SaRouter.match 有多个路径需要排除怎么办？ +可以点进去源码看一下，`SaRouter.match`方法有多个重载，可以放一个集合, 例如：
+`SaRouter.match(Arrays.asList("/**"), Arrays.asList("/login", "/reg"), () -> StpUtil.checkLogin());` ### 为什么StpUtil.setLoginId() 不能直接写入一个User对象？ diff --git a/sa-token-doc/doc/start/webflux-example.md b/sa-token-doc/doc/start/webflux-example.md index 152606c7..c1cf8ae8 100644 --- a/sa-token-doc/doc/start/webflux-example.md +++ b/sa-token-doc/doc/start/webflux-example.md @@ -58,7 +58,7 @@ public class SaTokenConfigure { // 指定[认证函数]: 每次请求执行 .setAuth(r -> { System.out.println("---------- sa全局认证"); - // SaRouterUtil.match("/test/test", () -> StpUtil.checkLogin()); + // SaRouter.match("/test/test", () -> StpUtil.checkLogin()); }) // 指定[异常处理函数]：每次[认证函数]发生异常时执行此函数 .setError(e -> { diff --git a/sa-token-doc/doc/use/global-filter.md b/sa-token-doc/doc/use/global-filter.md index 0763c7f7..a1ba6aa1 100644 --- a/sa-token-doc/doc/use/global-filter.md +++ b/sa-token-doc/doc/use/global-filter.md @@ -43,7 +43,7 @@ public class SaTokenConfigure { System.out.println("---------- 进入sa-token全局认证 -----------"); // 登录验证 -- 拦截所有路由，并排除/user/doLogin 用于开放登录 - SaRouterUtil.match("/**", "/user/doLogin", () -> StpUtil.checkLogin()); + SaRouter.match("/**", "/user/doLogin", () -> StpUtil.checkLogin()); // 更多拦截处理方式，请参考“路由拦截式鉴权”章节 }) diff --git a/sa-token-doc/doc/use/route-check.md b/sa-token-doc/doc/use/route-check.md index d75740d7..ddf59d29 100644 --- a/sa-token-doc/doc/use/route-check.md +++ b/sa-token-doc/doc/use/route-check.md @@ -9,7 +9,7 @@ -## 1、注册路由拦截器 +### 1、注册路由拦截器 以`SpringBoot2.0`为例, 新建配置类`SaTokenConfigure.java` ``` java @Configuration @@ -26,7 +26,7 @@ public class SaTokenConfigure implements WebMvcConfigurer { 那么我们如何进行权限认证拦截呢，且往下看 -## 2、自定义权限验证规则 +### 2、自定义权限验证规则 你可以使用函数式编程自定义验证规则 ``` java @@ -35,20 +35,20 @@ public class SaTokenConfigure implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { // 注册路由拦截器，自定义验证规则 - registry.addInterceptor(new SaRouteInterceptor((request, response, handler)->{ + registry.addInterceptor(new SaRouteInterceptor((req, res, handler)->{ // 根据路由划分模块，不同模块不同鉴权 - SaRouterUtil.match("/user/**", () -> StpUtil.checkPermission("user")); - SaRouterUtil.match("/admin/**", () -> StpUtil.checkPermission("admin")); - SaRouterUtil.match("/goods/**", () -> StpUtil.checkPermission("goods")); - SaRouterUtil.match("/orders/**", () -> StpUtil.checkPermission("orders")); - SaRouterUtil.match("/notice/**", () -> StpUtil.checkPermission("notice")); - SaRouterUtil.match("/comment/**", () -> StpUtil.checkPermission("comment")); + SaRouter.match("/user/**", () -> StpUtil.checkPermission("user")); + SaRouter.match("/admin/**", () -> StpUtil.checkPermission("admin")); + SaRouter.match("/goods/**", () -> StpUtil.checkPermission("goods")); + SaRouter.match("/orders/**", () -> StpUtil.checkPermission("orders")); + SaRouter.match("/notice/**", () -> StpUtil.checkPermission("notice")); + SaRouter.match("/comment/**", () -> StpUtil.checkPermission("comment")); })).addPathPatterns("/**"); } } ``` -## 3、完整示例 +### 3、完整示例 所有用法示例： ``` java @@ -58,37 +58,41 @@ public class SaTokenConfigure implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { // 注册路由拦截器，自定义验证规则 - registry.addInterceptor(new SaRouteInterceptor((request, response, handler) -> { + registry.addInterceptor(new SaRouteInterceptor((req, res, handler) -> { // 登录验证 -- 拦截所有路由，并排除/user/doLogin 用于开放登录 - SaRouterUtil.match("/**", "/user/doLogin", () -> StpUtil.checkLogin()); + SaRouter.match("/**", "/user/doLogin", () -> StpUtil.checkLogin()); // 登录验证 -- 排除多个路径 - SaRouterUtil.match(Arrays.asList("/**"), Arrays.asList("/user/doLogin", "/user/reg"), () -> StpUtil.checkLogin()); + SaRouter.match(Arrays.asList("/**"), Arrays.asList("/user/doLogin", "/user/reg"), () -> StpUtil.checkLogin()); // 角色认证 -- 拦截以 admin 开头的路由，必须具备[admin]角色或者[super-admin]角色才可以通过认证 - SaRouterUtil.match("/admin/**", () -> StpUtil.checkRoleOr("admin", "super-admin")); + SaRouter.match("/admin/**", () -> StpUtil.checkRoleOr("admin", "super-admin")); // 权限认证 -- 不同模块, 校验不同权限 - SaRouterUtil.match("/user/**", () -> StpUtil.checkPermission("user")); - SaRouterUtil.match("/admin/**", () -> StpUtil.checkPermission("admin")); - SaRouterUtil.match("/goods/**", () -> StpUtil.checkPermission("goods")); - SaRouterUtil.match("/orders/**", () -> StpUtil.checkPermission("orders")); - SaRouterUtil.match("/notice/**", () -> StpUtil.checkPermission("notice")); - SaRouterUtil.match("/comment/**", () -> StpUtil.checkPermission("comment")); + SaRouter.match("/user/**", () -> StpUtil.checkPermission("user")); + SaRouter.match("/admin/**", () -> StpUtil.checkPermission("admin")); + SaRouter.match("/goods/**", () -> StpUtil.checkPermission("goods")); + SaRouter.match("/orders/**", () -> StpUtil.checkPermission("orders")); + SaRouter.match("/notice/**", () -> StpUtil.checkPermission("notice")); + SaRouter.match("/comment/**", () -> StpUtil.checkPermission("comment")); // 匹配 restful 风格路由 - SaRouterUtil.match("/article/get/{id}", () -> StpUtil.checkPermission("article")); + SaRouter.match("/article/get/{id}", () -> StpUtil.checkPermission("article")); // 检查请求方式 - SaRouterUtil.match("/notice/**", () -> { - if(request.getMethod().equals(HttpMethod.GET.toString())) { + SaRouter.match("/notice/**", () -> { + if(req.getMethod().equals(HttpMethod.GET.toString())) { StpUtil.checkPermission("notice"); } }); + // 提前退出 + + + // 在多账号模式下，可以使用任意StpUtil进行校验 - SaRouterUtil.match("/user/**", () -> StpUserUtil.checkLogin()); + SaRouter.match("/user/**", () -> StpUserUtil.checkLogin()); })).addPathPatterns("/**"); } @@ -96,10 +100,27 @@ public class SaTokenConfigure implements WebMvcConfigurer { ``` +### 4、提前退出匹配链条 +使用 `SaRouter.stop()` 可以提前退出匹配链，例： + +``` java +// 原写法 +registry.addInterceptor(SaRouteInterceptor.createPermissionVal("user")).addPathPatterns("/user/**"); + +// 改为以下方式，效果同上 +registry.addInterceptor(new SaRouteInterceptor((req, res, handler) -> { + SaRouter.match("/**", () -> System.out.println("进入1")); + SaRouter.match("/**", () -> {System.out.println("进入2"); SaRouter.stop();}); + SaRouter.match("/**", () -> System.out.println("进入3")); +})).addPathPatterns("/**"); +``` +如上示例，代码运行至第2条匹配链时，会在stop函数处提前退出整个匹配函数，从而忽略掉剩余的所有match匹配 -## 注意事项 + + \ No newline at end of file diff --git a/sa-token-starter/sa-token-reactor-spring-boot-starter/src/main/java/cn/dev33/satoken/reactor/filter/SaReactorFilter.java b/sa-token-starter/sa-token-reactor-spring-boot-starter/src/main/java/cn/dev33/satoken/reactor/filter/SaReactorFilter.java index 86a8f98b..b36f0350 100644 --- a/sa-token-starter/sa-token-reactor-spring-boot-starter/src/main/java/cn/dev33/satoken/reactor/filter/SaReactorFilter.java +++ b/sa-token-starter/sa-token-reactor-spring-boot-starter/src/main/java/cn/dev33/satoken/reactor/filter/SaReactorFilter.java @@ -10,11 +10,12 @@ import org.springframework.web.server.WebFilter; import org.springframework.web.server.WebFilterChain; import cn.dev33.satoken.exception.SaTokenException; +import cn.dev33.satoken.exception.StopMatchException; import cn.dev33.satoken.filter.SaFilterAuthStrategy; import cn.dev33.satoken.filter.SaFilterErrorStrategy; import cn.dev33.satoken.reactor.context.SaReactorHolder; import cn.dev33.satoken.reactor.context.SaReactorSyncHolder; -import cn.dev33.satoken.router.SaRouterUtil; +import cn.dev33.satoken.router.SaRouter; import cn.dev33.satoken.util.SaTokenConsts; import reactor.core.publisher.Mono; @@ -155,11 +156,13 @@ public class SaReactorFilter implements WebFilter { SaReactorSyncHolder.setContent(exchange); // 执行全局过滤器 - SaRouterUtil.match(includeList, excludeList, () -> { + SaRouter.match(includeList, excludeList, () -> { beforeAuth.run(null); auth.run(null); }); + } catch (StopMatchException e) { + } catch (Throwable e) { // 1. 获取异常处理策略结果 Object result = error.run(e); diff --git a/sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/SolonPluginImpl.java b/sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/XPluginImp.java similarity index 97% rename from sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/SolonPluginImpl.java rename to sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/XPluginImp.java index 509012e2..64892b73 100644 --- a/sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/SolonPluginImpl.java +++ b/sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/XPluginImp.java @@ -21,7 +21,7 @@ import cn.dev33.satoken.stp.StpInterface; * @author noear * @since 1.4 */ -public class SolonPluginImpl implements Plugin { +public class XPluginImp implements Plugin { @Override public void start(SolonApp app) { diff --git a/sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/integration/SaTokenPathFilter.java b/sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/integration/SaTokenPathFilter.java index 3db78d71..c6c10647 100644 --- a/sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/integration/SaTokenPathFilter.java +++ b/sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/integration/SaTokenPathFilter.java @@ -2,9 +2,10 @@ package cn.dev33.satoken.solon.integration; import cn.dev33.satoken.exception.SaTokenException; +import cn.dev33.satoken.exception.StopMatchException; import cn.dev33.satoken.filter.SaFilterAuthStrategy; import cn.dev33.satoken.filter.SaFilterErrorStrategy; -import cn.dev33.satoken.router.SaRouterUtil; +import cn.dev33.satoken.router.SaRouter; import org.noear.solon.core.handle.Context; import org.noear.solon.core.handle.Filter; import org.noear.solon.core.handle.FilterChain; @@ -141,12 +142,14 @@ public class SaTokenPathFilter implements Filter { public void doFilter(Context ctx, FilterChain chain) throws Throwable { try { // 执行全局过滤器 - SaRouterUtil.match(includeList, excludeList, () -> { + SaRouter.match(includeList, excludeList, () -> { beforeAuth.run(null); auth.run(null); }); - } catch (Throwable e) { + } catch (StopMatchException e) { + + } catch (Throwable e) { // 1. 获取异常处理策略结果 Object result = error.run(e); String resultString = String.valueOf(result); diff --git a/sa-token-starter/sa-token-solon-plugin/src/main/resources/META-INF/solon/cn.dev33.satoken.solon.properties b/sa-token-starter/sa-token-solon-plugin/src/main/resources/META-INF/solon/cn.dev33.satoken.solon.properties index 9eb0954d..51d8fd9a 100644 --- a/sa-token-starter/sa-token-solon-plugin/src/main/resources/META-INF/solon/cn.dev33.satoken.solon.properties +++ b/sa-token-starter/sa-token-solon-plugin/src/main/resources/META-INF/solon/cn.dev33.satoken.solon.properties @@ -1 +1 @@ -solon.plugin=cn.dev33.satoken.solon.SolonPluginImpl \ No newline at end of file +solon.plugin=cn.dev33.satoken.solon.XPluginImp \ No newline at end of file diff --git a/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/filter/SaServletFilter.java b/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/filter/SaServletFilter.java index c5ac4f38..34d9001f 100644 --- a/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/filter/SaServletFilter.java +++ b/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/filter/SaServletFilter.java @@ -15,7 +15,8 @@ import javax.servlet.ServletResponse; import org.springframework.core.annotation.Order; import cn.dev33.satoken.exception.SaTokenException; -import cn.dev33.satoken.router.SaRouterUtil; +import cn.dev33.satoken.exception.StopMatchException; +import cn.dev33.satoken.router.SaRouter; import cn.dev33.satoken.util.SaTokenConsts; /** @@ -153,11 +154,13 @@ public class SaServletFilter implements Filter { try { // 执行全局过滤器 - SaRouterUtil.match(includeList, excludeList, () -> { + SaRouter.match(includeList, excludeList, () -> { beforeAuth.run(null); auth.run(null); }); + } catch (StopMatchException e) { + } catch (Throwable e) { // 1. 获取异常处理策略结果 Object result = error.run(e); diff --git a/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/interceptor/SaRouteInterceptor.java b/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/interceptor/SaRouteInterceptor.java index d361c4e4..6d686b49 100644 --- a/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/interceptor/SaRouteInterceptor.java +++ b/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/interceptor/SaRouteInterceptor.java @@ -5,6 +5,7 @@ import javax.servlet.http.HttpServletResponse; import org.springframework.web.servlet.HandlerInterceptor; +import cn.dev33.satoken.exception.StopMatchException; import cn.dev33.satoken.router.SaRouteFunction; import cn.dev33.satoken.servlet.model.SaRequestForServlet; import cn.dev33.satoken.servlet.model.SaResponseForServlet; @@ -58,8 +59,11 @@ public class SaRouteInterceptor implements HandlerInterceptor { if(function == null) { StpUtil.checkLogin(); } else { - // 否则执行函数 - function.run(new SaRequestForServlet(request), new SaResponseForServlet(response), handler); + // 否则执行认证函数 + try { + function.run(new SaRequestForServlet(request), new SaResponseForServlet(response), handler); + } catch (StopMatchException e) { + } } // 通过验证