Spring5路徑匹配器PathPattern解析

Posted on 2021-11-24 by WalkonNet

Spring5路徑匹配器PathPattern

PathPattern 對url地址匹配的處理更加快速，它和AntPathMatcher 主要差異如下：

1.PathPattern 隻支持結尾部分使用 **

如果在路徑的中間使用 ** 就會報錯；

@GetMapping("/funyi/**")
public String act1() {
    return "/funyi/**";
}

2.PathPattern 支持使用例如 {*path}

的方式匹配請求路徑，同時可以匹配到多級路徑，並將獲取的值賦給對應controller方法的形參path；

@GetMapping("/funyi/{*path}")
public void act2(@PathVariable String path) {
    System.out.println("path = " + path);
}

SpringBoot 項目添加如下配置即可開啟PathPattern：

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.setPatternParser(new PathPatternParser());
    }
}

路徑匹配工具（AntPathMatcher vs PathPattern）

AntPathMatcher：Sping第一個版本（2013念）引入。
PathPattern：Spring 5 引入，所在包：org.springframework.web.util.pattern.PathPattern，所屬模塊為spring-web。可見它專為Web設計的“工具”。

PathPattern去掉瞭Ant字樣，但保持瞭很好的向下兼容性：除瞭不支持將**寫在path中間之外（以消除歧義），其它的匹配規則從行為上均保持和AntPathMatcher一致，並且還新增瞭強大的{*pathVariable} 的支持。整體上可認為後者兼容瞭前者的功能。

PathPattern性能比AntPathMatcher好。理論上pattern越復雜，PathPattern的優勢越明顯；
AntPathMatcher可用於非Web環境，而PathPattern隻適用於Web環境。所以PathPattern也不是能完全替代AntPathMatcher的。

內部實現原理上看，AntPathMatcher進行的是純字符串操作和比對；而PathPattern則對於任何一個字符串的pattern最終都會被解析為若幹段的PathElement，這些PathElement以鏈式結構連接起來用以表示該pattern，形成一個對象數據，這種結構化的表示使得可讀性更強、更具靈活性，從而獲得更好的性能表現。

兩者簡單使用示例：

new AntPathMatcher().match("/api/v1/**", "/api/v1/2/3**");
new PathPatternParser().parse("/api/v1/**").matches(PathContainer.parsePath("/api/v1/2/3**")); 
//每一個pathPattern串對應一個PathPatternParser、每一個parsedPath串對應一個PathContainer

可能有小夥伴會說：在Service層，甚至Dao層我也可以正常使用PathPattern對象呀，何解？

這個問題就相當於：HttpServletRequest屬於web層專用組件，但你依舊可以將其傳到Service層，甚至Dao層供以使用，在編譯、運行時不會報錯。但你可深入思考下，這麼做合適嗎？

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

Spring5路徑匹配器PathPattern解析

目錄