From cd14651dccf1f1a1c8fb5a0bd7b815647638c400 Mon Sep 17 00:00:00 2001 From: click33 <2393584716@qq.com> Date: Thu, 21 Sep 2023 05:06:40 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E5=A4=8D=20SaRouter.match=20=E5=8C=B9?= =?UTF-8?q?=E9=85=8D=E8=A7=84=E5=88=99=E4=B8=8E=20Spring=20=E9=BB=98?= =?UTF-8?q?=E8=AE=A4=E4=B8=8D=E4=B8=80=E8=87=B4=E5=AF=BC=E8=87=B4=E7=9A=84?= =?UTF-8?q?=E8=B6=8A=E6=9D=83=E6=BC=8F=E6=B4=9E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../SaTokenContextForSpringReactor.java | 4 +- .../SaTokenContextForSpringReactor.java | 4 +- .../sa-token-spring-boot-autoconfig/pom.xml | 6 ++ .../satoken/spring/SaPathMatcherHolder.java | 2 +- .../spring/SaPathPatternParserUtil.java | 53 ++++++++++++++ .../SaPatternsRequestConditionHolder.java | 71 +++++++++++++++++++ .../spring/SaTokenContextForSpring.java | 2 +- ...TokenContextForSpringInJakartaServlet.java | 2 +- 8 files changed, 137 insertions(+), 7 deletions(-) create mode 100644 sa-token-starter/sa-token-spring-boot-autoconfig/src/main/java/cn/dev33/satoken/spring/SaPathPatternParserUtil.java create mode 100644 sa-token-starter/sa-token-spring-boot-autoconfig/src/main/java/cn/dev33/satoken/spring/SaPatternsRequestConditionHolder.java diff --git a/sa-token-starter/sa-token-reactor-spring-boot-starter/src/main/java/cn/dev33/satoken/reactor/spring/SaTokenContextForSpringReactor.java b/sa-token-starter/sa-token-reactor-spring-boot-starter/src/main/java/cn/dev33/satoken/reactor/spring/SaTokenContextForSpringReactor.java index 71635a1a..a919656e 100644 --- a/sa-token-starter/sa-token-reactor-spring-boot-starter/src/main/java/cn/dev33/satoken/reactor/spring/SaTokenContextForSpringReactor.java +++ b/sa-token-starter/sa-token-reactor-spring-boot-starter/src/main/java/cn/dev33/satoken/reactor/spring/SaTokenContextForSpringReactor.java @@ -16,7 +16,7 @@ package cn.dev33.satoken.reactor.spring; import cn.dev33.satoken.context.SaTokenContextForThreadLocal; -import cn.dev33.satoken.spring.SaPathMatcherHolder; +import cn.dev33.satoken.spring.SaPathPatternParserUtil; /** * Sa-Token 上下文处理器 [ Spring Reactor 版本实现 ] ，基于 SaTokenContextForThreadLocal 定制 @@ -31,7 +31,7 @@ public class SaTokenContextForSpringReactor extends SaTokenContextForThreadLocal */ @Override public boolean matchPath(String pattern, String path) { - return SaPathMatcherHolder.getPathMatcher().match(pattern, path); + return SaPathPatternParserUtil.match(pattern, path); } } diff --git a/sa-token-starter/sa-token-reactor-spring-boot3-starter/src/main/java/cn/dev33/satoken/reactor/spring/SaTokenContextForSpringReactor.java b/sa-token-starter/sa-token-reactor-spring-boot3-starter/src/main/java/cn/dev33/satoken/reactor/spring/SaTokenContextForSpringReactor.java index 3d47d3ab..59a0cf1c 100644 --- a/sa-token-starter/sa-token-reactor-spring-boot3-starter/src/main/java/cn/dev33/satoken/reactor/spring/SaTokenContextForSpringReactor.java +++ b/sa-token-starter/sa-token-reactor-spring-boot3-starter/src/main/java/cn/dev33/satoken/reactor/spring/SaTokenContextForSpringReactor.java @@ -16,7 +16,7 @@ package cn.dev33.satoken.reactor.spring; import cn.dev33.satoken.context.SaTokenContextForThreadLocal; -import cn.dev33.satoken.spring.SaPathMatcherHolder; +import cn.dev33.satoken.spring.SaPathPatternParserUtil; /** * Sa-Token 上下文处理器 [ Spring Reactor 版本实现 ] ，基于 SaTokenContextForThreadLocal 定制 @@ -31,7 +31,7 @@ public class SaTokenContextForSpringReactor extends SaTokenContextForThreadLocal */ @Override public boolean matchPath(String pattern, String path) { - return SaPathMatcherHolder.getPathMatcher().match(pattern, path); + return SaPathPatternParserUtil.match(pattern, path); } } diff --git a/sa-token-starter/sa-token-spring-boot-autoconfig/pom.xml b/sa-token-starter/sa-token-spring-boot-autoconfig/pom.xml index 4ab74948..fe7c64da 100644 --- a/sa-token-starter/sa-token-spring-boot-autoconfig/pom.xml +++ b/sa-token-starter/sa-token-spring-boot-autoconfig/pom.xml @@ -24,6 +24,12 @@ spring-boot-starter true + + org.springframework + spring-webmvc + 5.3.7 + true + com.fasterxml.jackson.core jackson-databind diff --git a/sa-token-starter/sa-token-spring-boot-autoconfig/src/main/java/cn/dev33/satoken/spring/SaPathMatcherHolder.java b/sa-token-starter/sa-token-spring-boot-autoconfig/src/main/java/cn/dev33/satoken/spring/SaPathMatcherHolder.java index 1903cfc9..02e02dd7 100644 --- a/sa-token-starter/sa-token-spring-boot-autoconfig/src/main/java/cn/dev33/satoken/spring/SaPathMatcherHolder.java +++ b/sa-token-starter/sa-token-spring-boot-autoconfig/src/main/java/cn/dev33/satoken/spring/SaPathMatcherHolder.java @@ -19,7 +19,7 @@ import org.springframework.util.AntPathMatcher; import org.springframework.util.PathMatcher; /** - * 持有 PathMatcher 全局引用，方便快捷的调用 PathMatcher 相关方法 + * 路由匹配工具类：持有 PathMatcher 全局引用，方便快捷的调用 PathMatcher 相关方法 * * @author click33 * @since 1.34.0 diff --git a/sa-token-starter/sa-token-spring-boot-autoconfig/src/main/java/cn/dev33/satoken/spring/SaPathPatternParserUtil.java b/sa-token-starter/sa-token-spring-boot-autoconfig/src/main/java/cn/dev33/satoken/spring/SaPathPatternParserUtil.java new file mode 100644 index 00000000..6dd740c2 --- /dev/null +++ b/sa-token-starter/sa-token-spring-boot-autoconfig/src/main/java/cn/dev33/satoken/spring/SaPathPatternParserUtil.java @@ -0,0 +1,53 @@ +/* + * Copyright 2020-2099 sa-token.cc + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package cn.dev33.satoken.spring; + +import org.springframework.http.server.PathContainer; +import org.springframework.web.util.pattern.PathPattern; +import org.springframework.web.util.pattern.PathPatternParser; + +/** + * 路由匹配工具类：使用 PathPatternParser 模式匹配 + * + * @author click33 + * @since 1.35.1 + */ +public class SaPathPatternParserUtil { + + private SaPathPatternParserUtil() { + } + + /** + * 判断：指定路由匹配符是否可以匹配成功指定路径 + * @param pattern 路由匹配符 + * @param path 要匹配的路径 + * @return 是否匹配成功 + */ + public static boolean match(String pattern, String path) { + PathPattern pathPattern = PathPatternParser.defaultInstance.parse(pattern); + PathContainer pathContainer = PathContainer.parsePath(path); + return pathPattern.matches(pathContainer); + } + + /* + 表现： + springboot 2.x SpringMVC match("/test/test", "/test/test/") // true + springboot 2.x WebFlux match("/test/test", "/test/test/") // true + springboot 3.x SpringMVC match("/test/test", "/test/test/") // false + springboot 3.x WebFlux match("/test/test", "/test/test/") // false + */ + +} diff --git a/sa-token-starter/sa-token-spring-boot-autoconfig/src/main/java/cn/dev33/satoken/spring/SaPatternsRequestConditionHolder.java b/sa-token-starter/sa-token-spring-boot-autoconfig/src/main/java/cn/dev33/satoken/spring/SaPatternsRequestConditionHolder.java new file mode 100644 index 00000000..cf786706 --- /dev/null +++ b/sa-token-starter/sa-token-spring-boot-autoconfig/src/main/java/cn/dev33/satoken/spring/SaPatternsRequestConditionHolder.java @@ -0,0 +1,71 @@ +/* + * Copyright 2020-2099 sa-token.cc + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package cn.dev33.satoken.spring; + +import cn.dev33.satoken.exception.SaTokenException; +import org.springframework.web.servlet.mvc.condition.PatternsRequestCondition; + +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; + +/** + * 路由匹配工具类 + * + * @author click33 + * @since 1.35.1 + */ +public class SaPatternsRequestConditionHolder { + + private SaPatternsRequestConditionHolder() { + } + + public static PatternsRequestCondition patternsRequestCondition; + + public static Method matcherMethod; + + static { + try { + patternsRequestCondition = new PatternsRequestCondition(); + matcherMethod = PatternsRequestCondition.class.getDeclaredMethod("getMatchingPattern", String.class, String.class); + matcherMethod.setAccessible(true); + } catch (NoSuchMethodException e) { + throw new SaTokenException("路由匹配器初始化失败", e); + } + } + + /** + * 判断：指定路由匹配符是否可以匹配成功指定路径 + * @param pattern 路由匹配符 + * @param lookupPath 要匹配的路径 + * @return 是否匹配成功 + */ + public static boolean match(String pattern, String lookupPath) { + try { + return matcherMethod.invoke(patternsRequestCondition, pattern, lookupPath) != null; + } catch (IllegalAccessException | InvocationTargetException e) { + throw new SaTokenException("路由匹配器调用失败", e); + } + } + + /* + 性能测试： + 100万次 + new 对象方式，耗时：3.685s 最慢 + 反射调方法方式，耗时：1.311s 中等 + 原始方式，耗时：0.445s 最快，但有bug + */ + +} diff --git a/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/spring/SaTokenContextForSpring.java b/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/spring/SaTokenContextForSpring.java index ae9fcd63..3648958f 100644 --- a/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/spring/SaTokenContextForSpring.java +++ b/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/spring/SaTokenContextForSpring.java @@ -60,7 +60,7 @@ public class SaTokenContextForSpring implements SaTokenContext { */ @Override public boolean matchPath(String pattern, String path) { - return SaPathMatcherHolder.getPathMatcher().match(pattern, path); + return SaPatternsRequestConditionHolder.match(pattern, path); } /** diff --git a/sa-token-starter/sa-token-spring-boot3-starter/src/main/java/cn/dev33/satoken/spring/SaTokenContextForSpringInJakartaServlet.java b/sa-token-starter/sa-token-spring-boot3-starter/src/main/java/cn/dev33/satoken/spring/SaTokenContextForSpringInJakartaServlet.java index ec51de10..949429bd 100644 --- a/sa-token-starter/sa-token-spring-boot3-starter/src/main/java/cn/dev33/satoken/spring/SaTokenContextForSpringInJakartaServlet.java +++ b/sa-token-starter/sa-token-spring-boot3-starter/src/main/java/cn/dev33/satoken/spring/SaTokenContextForSpringInJakartaServlet.java @@ -60,7 +60,7 @@ public class SaTokenContextForSpringInJakartaServlet implements SaTokenContext { */ @Override public boolean matchPath(String pattern, String path) { - return SaPathMatcherHolder.getPathMatcher().match(pattern, path); + return SaPathPatternParserUtil.match(pattern, path); } /**