URL匹配之AntPathMatcher

已于 2023-08-16 15:11:22 修改
阅读量2.5k 收藏 34
点赞数 3
分类专栏： Java知识大杂烩 文章标签： AntPathMatcher PathMatcher AntMatcher UrlMatcher Ant
于 2022-03-21 17:31:21 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/justry_deng/article/details/123641133
版权

URL匹配之AntPathMatcher

背景说明

Ant匹配模式是当下（2022-03-18）最火的对URL进行匹配的模式。很多框架都采用Ant对URL进行匹配，如Spring框架中的org.springframework.util.AntPathMatcher。
在这里插入图片描述

Ant基础通配符简介

通配符介绍示例说明
?匹配1个字符模板：/jd/a?c
匹配示例：/jd/abc
不匹配示例1：/jd/ac
不匹配示例2：/jd/axyzc
*匹配>=0个字符模板：/jd/a*c
匹配示例1：/jd/ac
匹配示例2：/jd/abc
匹配示例3：/jd/axyzc
不匹配示例1：/jd/a
不匹配示例2：/jd/xc
不匹配示例3：/jk/ac
**匹配>=0个目录示例1：/**/abc.html匹配所有以abc.html结尾的路径
示例2：/abc/**匹配所有以/abc/打头的路径，当然也匹配/abc
示例3：abc**匹配所有以abc打头的路径
示例4：/xyz/**/qwer匹配所有以/xyz/打头并以/qwer结尾的路径
………

AntPathMatcher常用方法介绍及示例

提示：以下内容基于spring 5.3.12

常用的构造方法

  • 示例

    // 无参构造，默认以 "/" 作为路径分隔符
AntPathMatcher antPathMatcher = new AntPathMatcher();
// 也可以指定路径分隔符
antPathMatcher = new AntPathMatcher("-");

extractUriTemplateVariables(String pattern, String path)：根据pattern的规则，从path中抽取对应的变量值

当pattern与path不匹配时，会报错

  • 示例一

    AntPathMatcher antPathMatcher = new AntPathMatcher();
Map<String, String> map = antPathMatcher.extractUriTemplateVariables("/root/{a}/{b}/{c}/{d}.html", "/root/aa/bb/cc/xyz.html");
map.forEach((k, v) -> System.out.println(k + "=" + v));

    输出

    a=aa
b=bb
c=cc
d=xyz

  • 示例二

    AntPathMatcher antPathMatcher = new AntPathMatcher();
Map<String, String> map = antPathMatcher.extractUriTemplateVariables("/root/{a}/{b}/{c}", "/root/aa/bb/cc/xyz.html");
map.forEach((k, v) -> System.out.println(k + "=" + v));

    输出

    Exception in thread "main" java.lang.IllegalStateException: Pattern "/root/{a}/{b}/{c}" is not a match for "/root/aa/bb/cc/xyz.html"
	at org.springframework.util.AntPathMatcher.extractUriTemplateVariables(AntPathMatcher.java:517)
	at com.example.springbootdemo.MainApplication.main(MainApplication.java:17)

isPattern(String str)：判断str是否可以作为一个pattern匹配器

注：当str是一个不带任何通配符（如：?、*、**、{}等）的字符串，即：str是一个准确的字符串时。此方法返回false，该方法认为：既然pattern是一个不带通配符的明确字符串，那么你直接和要匹配的path进行相等比较即可

  • 示例一

    AntPathMatcher antPathMatcher = new AntPathMatcher();
boolean isPattern = antPathMatcher.isPattern("/aa/bb/cc/xyz.html");
System.out.println(isPattern);

    输出

    false

  • 示例二

    AntPathMatcher antPathMatcher = new AntPathMatcher();
boolean isPattern = antPathMatcher.isPattern("/aa/*/cc/xyz.html");
System.out.println(isPattern);

    输出

    true

  • 示例三

    AntPathMatcher antPathMatcher = new AntPathMatcher();
boolean isPattern = antPathMatcher.isPattern("/aa/**/xyz.html");
System.out.println(isPattern);

    输出

    true

  • 示例四

    AntPathMatcher antPathMatcher = new AntPathMatcher();
boolean isPattern = antPathMatcher.isPattern("/aa/?/xyz.html");
System.out.println(isPattern);

    输出

    true

  • 示例五

    AntPathMatcher antPathMatcher = new AntPathMatcher();
boolean isPattern = antPathMatcher.isPattern("/aa/{qwer}/xyz.html");
System.out.println(isPattern);

    输出

    true

match(String pattern, String path)：path是否完全匹配pattern

  • 示例一（示例统配符?）

    AntPathMatcher antPathMatcher = new AntPathMatcher();
// 输出：true
System.out.println(antPathMatcher.match("/jd/a?c", "/jd/abc"));
// 输出：false
System.out.println(antPathMatcher.match("/jd/a?c", "/jd/ac"));
// 输出：false
System.out.println(antPathMatcher.match("/jd/a?c", "/jd/axyzc"));

  • 示例二（示例统配符*）

    AntPathMatcher antPathMatcher = new AntPathMatcher();
// 输出：true
System.out.println(antPathMatcher.match("/jd/a*c", "/jd/ac"));
// 输出：true
System.out.println(antPathMatcher.match("/jd/a*c", "/jd/abc"));
// 输出：true
System.out.println(antPathMatcher.match("/jd/a*c", "/jd/axyzc"));
// 输出：false
System.out.println(antPathMatcher.match("/jd/a*c", "/jd/a"));
// 输出：false
System.out.println(antPathMatcher.match("/jd/a*c", "/jd/xc"));
// 输出：false
System.out.println(antPathMatcher.match("/jd/a*c", "/jk/ac"));

  • 示例三（示例统配符**）

    AntPathMatcher antPathMatcher = new AntPathMatcher();
//true
//false
//false
System.out.println(antPathMatcher.match("**", ""));
System.out.println(antPathMatcher.match("**", "/"));
System.out.println(antPathMatcher.match("**", ""));

//false
//true
//true
System.out.println(antPathMatcher.match("/**", ""));
System.out.println(antPathMatcher.match("/**", "/"));
System.out.println(antPathMatcher.match("/**", ""));

//true
//false
//false
System.out.println(antPathMatcher.match("**/", ""));
System.out.println(antPathMatcher.match("**/", "/"));
System.out.println(antPathMatcher.match("**/", ""));

//false
//true
//true
System.out.println(antPathMatcher.match("/**/", ""));
System.out.println(antPathMatcher.match("/**/", "/"));
System.out.println(antPathMatcher.match("/**/", ""));

//true
//true
//true
//true
//false
//false
System.out.println(antPathMatcher.match("/**/abc.html", "/abc.html"));
System.out.println(antPathMatcher.match("/**/abc.html", "//abc.html"));
System.out.println(antPathMatcher.match("/**/abc.html", "/1/2/3/4/5/abc.html"));
System.out.println(antPathMatcher.match("/**/abc.html", "/a/b/c//jd/ac/abc.html"));
System.out.println(antPathMatcher.match("/**/abc.html", "/a/abc"));
System.out.println(antPathMatcher.match("/**/abc.html", "/a/bc.html"));

  • 示例四（示例占位符{}）

    AntPathMatcher antPathMatcher = new AntPathMatcher();
//true
//false
//false
System.out.println(antPathMatcher.match("a/{b}/c", "a/b0/c"));
System.out.println(antPathMatcher.match("a/{b}/c", "a/b1/b2/b3/c"));
System.out.println(antPathMatcher.match("a/{b}", "a/b1/b2/b3/c"));

matchStart(String pattern, String path)：pattern的前面一部分是否就能匹配上整个path

注：若path与pattern完全匹配，那么也算：pattern的前面一部分匹配上了整个path

注：可理解为，path是pattern的一个子集

  • 示例

    AntPathMatcher antPathMatcher = new AntPathMatcher();
//false
//true
//true
System.out.println(antPathMatcher.matchStart("a/{b}", "a/b0/c"));
System.out.println(antPathMatcher.matchStart("a/{b}/c", "a/b0/c"));
System.out.println(antPathMatcher.matchStart("a/{b}/c/d", "a/b0/c"));

//false
//true
//true
System.out.println(antPathMatcher.matchStart("a/?", "a/b/c"));
System.out.println(antPathMatcher.matchStart("a/?/c", "a/b/c"));
System.out.println(antPathMatcher.matchStart("a/?/c/d", "a/b/c"));

//false
//true
//true
System.out.println(antPathMatcher.matchStart("a/*", "a/b0/c"));
System.out.println(antPathMatcher.matchStart("a/*/c", "a/b0/c"));
System.out.println(antPathMatcher.matchStart("a/*/c/d", "a/b0/c"));

//true
//true
//true
System.out.println(antPathMatcher.matchStart("a/**", "a/b0/c"));
System.out.println(antPathMatcher.matchStart("a/**/c", "a/b0/c"));
System.out.println(antPathMatcher.matchStart("a/**/c/d", "a/b0/c"));

^_^ 如有不当之处，欢迎指正
^_^ 本文已经被收录进《程序员成长笔记》 ，笔者JustryDeng

justry_deng
关注
  • 3
    点赞
  • 踩
  • 34
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
URLPath匹配原则
10-21 899
URLPath匹配原则 URLPath匹配原则 路 径匹配原则(Path Matching) Spring MVC中的路径匹配要比标准的web.xml要灵活的多。默认的策略实现了 org.springframework.util.AntPathMatcher，就像名字提示的那样，路径模式是使用了Apache Ant的样式路径，Apache Ant样式的路径有三种通配符匹配方法（在下面的表格中列
AntPathMatcher路径匹配器，Ant风格的URL.md
最新发布
04-15
AntPathMatcher路径匹配器，Ant风格的URL
如何使用Spring工具类动态匹配url
08-25
主要介绍了如何使用Spring工具类动态匹配url,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
Spring工具类--路径匹配(AntPathMatcher)--使用/实例
热门推荐
IT利刃出鞘的博客
10-09 1万+
整个Spring（SpringBoot）框架的路径解析都是按照Ant的风格来的，比如：Controller的请求路径、文件路径、包的路径。所以，掌握Ant的路径匹配很重要。 Spring中的具体实现： org.springframework.util.AntPathMatcher。
spring security AntPathMatcher通配符
jonathan_joestar的博客
08-08 569
不过注册应该不需要后面的参数。这是我前端写错了，不过加个通配符之后 万一前端传了path参数 至少能走进后端逻辑。“/account/register” 这个没有通配符，需要 “/account/register?因为 register 后面带着一个key，所以要 匹配符号。...
AntPathMatcher路径匹配器
Java领域优秀创作者
04-09 3950
Ant风格（Ant Style）：该风格源自Apache的Ant项目，若你是个“老”程序员或许你还用过Apache Ant，若你是个小鲜肉也许闻所未闻，毕竟现在是Maven（Gradle）的天下。借助Spring强大的号召力，该概念似乎已是规范一样的存在，大家在不成文的约定着、交流着、书写着。boolean matchStart(String pattern, String path)：判断path是否和模式pattern前缀匹配（前缀匹配：path的前缀匹配上patter了即可，当然全部匹配也是可以的）
Spring路径匹配器AntPathMatcher
骑个小蜗牛的博客
11-13 1万+
PathMatcher接口 使用场景 接口方法 AntPathMatcher类 匹配规则 主要方法 1. isPattern 2. match 3. matchStart 4. extractPathWithinPattern 5. extractUriTemplateVariables 6. getPatternComparator 7. combine
AntPathMatcher路径匹配器，Ant风格的URL
a1k2l45k的博客
12-28 2896
AntPathMatcher路径匹配器
Spring工具类AntPathMatcher的用法及源码分析
死牛胖子的技术随笔
05-25 6980
路径在很多地方都会使用，比如：文件名，URL地址等，JDK 提供了 Path 类用来表示路径。实际使用时，经常需要通过一个路径表示多个地址，比如，Spring 启动时的扫描路径，这就需要增加对通配符的支持，同时也就需要支持对通配符的匹配。 Spring 设计了 PathMatcher 路径匹配器接口，用于支持带通配符的资源路径匹配。这个接口在 Spring 的多个地方得到应用，比如： PathMatchingResourcePatternResolver：资源扫描，启动时扫描并加载资源 AbstractU
AntPathMatcher
pscool的博客
02-11 9183
ant匹配规则 原文：https://www.cnblogs.com/leftthen/p/5212221.html AntPathMatcher如名使用的ant 的匹配规则,我们先看看吧. 　　字符wildcard　　　　描述 　　 ?　　　　　　　　　匹配一个字符 　　*　　　　　　　　　匹配0个及以上字符 　　**　　　　　　　　 匹配0个及以上目录directories 看几个官方的例子吧: 　　com/t?st.jsp - 　　　　　　　　　　 匹配: com/test.jsp
spring mvc路径匹配原则详解
08-28
默认的策略实现了 `org.springframework.util.AntPathMatcher`，使用了 Apache Ant 样式的路径，这种路径模式有三种通配符匹配方法： * `?` 匹配任何单字符 * `*` 匹配 0 或者任意数量的字符 * `` 匹配 0 或者更多...
SpringMVC源码解读之HandlerMapping
09-02
3. `pathMatcher`：路径匹配器，如`AntPathMatcher`用于处理像`/books/{id}`这样的路径占位符。 `AbstractHandlerMapping`还提供了`initApplicationContext`方法，用于在应用启动时初始化上下文。子类可以重写此...
PathMatchers：Path断言的Matcherclass
02-19
- `AntPathMatcher`的`match()`方法用于检查给定的路径是否与模式匹配。 - `AntPathMatcher`还提供了`extractUriTemplateVariables()`方法，用于在匹配成功时获取路径变量。 2. **RegexPathMatcher**： - 正则...
登入验证过滤器，AntPathMatcher路径匹配器
qq_65455837的博客
04-14 877
用于在多线程环境下存储线程局部变量。每个线程都有自己的ThreadLocal 变量，这个变量可以被线程读取和修改，而不会影响其他线程的值。Filter 表示过滤器，是JavaWeb三大组件(Servlet、Filter、Listener) 之一。如果未登入，直接进入主页面，查看网站主内容，这是不允许的（数据安全)，需要退回登入页面。通过下面的例子感受AntPathMatcher功能和用法。
Spring5新宠：PathPattern，AntPathMatcher：那我走？
架构师：通透，才能写出好代码！
06-25 1万+
新宠上位，还是雨露均沾？
springBoot--web--路径匹配
m0_50207524的博客
10-20 661
spring5.3之后加入了更多的请求路径匹配的实现策略以前只支持antPathMatcher策略，现在提供了PathPatternParse策略，并且可以让我们指定到底使用哪种策略在jmh基准测试下，有6-8倍的吞吐量提升，降低30%-40%空间分配律兼容AntPathMatcher语法，并支持更多类型路径模式**多段匹配的支持仅允许在模式末尾使用。
url 正则匹配工具类
08-03
URL 正则匹配工具类是用于在字符串中匹配和提取 URL 的工具类。URL（统一资源定位符）是用于唯一标识网络资源的地址，正则表达式是一种基于模式匹配的工具，可以用来描述和匹配字符串的特定模式。 URL 正则匹配工具类主要包括以下功能： 1. URL 匹配：通过正则表达式，筛选出符合特定 URL 格式的字符串。一般的 URL 格式包括协议（如https://）、域名、路径和查询参数等。 2. URL 提取：提取出匹配到的 URL 字符串，将其作为结果返回，方便后续的处理和分析。 3. URL 替换：将匹配到的 URL 字符串替换成指定的文本，常用于对 URL 进行链接文本的替换或修饰。 4. URL 分割：将匹配到的 URL 字符串按照协议、域名、路径和参数等部分进行分割，方便对 URL 进行进一步解析和处理。 5. URL 校验：对提取或匹配到的 URL 进行校验，验证其是否是一个合法的 URL。例如，检查 URL 是否包含有效的协议、域名是否可解析、路径是否存在等。 URL 正则匹配工具类可以方便地处理各种 URL 场景，如网页中的链接提取、URL 参数解析和修改等。正则表达式的灵活性和强大的匹配能力，使得 URL 正则匹配工具类可以适应不同的 URL 格式和需求，提高开发效率和代码的可维护性。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值