Spring源碼解析 - AntPathMatcher

最近在看SpringMVC的源碼,發現request分發時,路徑匹配最后是委托給AntPathMatcher實現的.索性看看吧.

文章摘要:

　　1. ant匹配規則

　　2. PathMatcher接口

　　3. 通過測試用例看AntPathMatcher的使用

 

ant匹配規則

AntPathMatcher如名使用的ant 的匹配規則,我們先看看吧.

　　字符wildcard　　　　描述

　　 ?　　　　　　　　　匹配一個字符

 　　*　　　　　　　　　匹配0個及以上字符

 　　**　　　　　　　　 匹配0個及以上目錄directories

看幾個官方的例子吧:

　　com/t?st.jsp - 　　　　　　　　　　  匹配: com/test.jsp  ,  com/tast.jsp  ,  com/txst.jsp
　　com/*.jsp - 　　　　　　　　　　　　匹配: com文件夾下的全部.jsp文件
　　com/**/test.jsp - 　　　　　　　　　匹配: com文件夾和子文件夾下的全部.jsp文件,
　　org/springframework/**/*.jsp - 　  匹配: org/springframework文件夾和子文件夾下的全部.jsp文件
　　org/**/servlet/bla.jsp - 　　　　　　匹配: org/springframework/servlet/bla.jsp  ,  org/springframework/testing/servlet/bla.jsp  ,  org/servlet/bla.jsp

 

PathMatcher接口

主要是判斷是否匹配pattern,並解析出path中的參數

package org.springframework.util;

public interface PathMatcher {

    /**
     * 判斷傳入的path是否可以作為pattern使用
     */
    boolean isPattern(String path);

    /**
     * 使用pattern匹配path
     */
    boolean match(String pattern, String path);

    /**
     * 如名,是否開始部分匹配
     */
    boolean matchStart(String pattern, String path);

    /**
     * 提取path中匹配到的部分,如pattern(myroot/*.html),path(myroot/myfile.html),返回myfile.html
     */
    String extractPathWithinPattern(String pattern, String path);

    /**
     * 提取path中匹配到的部分,只是這邊還需跟占位符配對為map,
     * 如pattern(/hotels/{hotel}),path(/hotels/1),解析出"hotel"->"1"
     */
    Map<String, String> extractUriTemplateVariables(String pattern, String path);

    /**
     * 提供比較器
     */
    Comparator<String> getPatternComparator(String path);

    /**
     * 合並pattern,pattern1然后pattern2
     */
    String combine(String pattern1, String pattern2);

}

 

 

通過測試用例看AntPathMatcher的使用

一看測試用例,瞬間服了,人家開發真是規范.

人家整這么規范,還是有空直接看源碼好了.這邊挑幾個簡單的例子看看就好

1. match 跟 matchStart 的差異,這個我們在測試用例看下面的情況會比較明確

　　這邊的代碼,我截取了一小部分

package org.springframework.util;
public class AntPathMatcherTests {
    @Test
    public void match() {
        // ...
        assertFalse(pathMatcher.match("/x/x/**/bla", "/x/x/x/"));
        // ...
    }
    @Test
    public void withMatchStart() {
        // ...
        assertTrue(pathMatcher.matchStart("/x/x/**/bla", "/x/x/x/"));
        // ...
    }
}

 

2. extractPathWithinPattern,代碼很清楚,不廢話

package org.springframework.util;
public class AntPathMatcherTests {
    @Test
    public void extractPathWithinPattern() throws Exception {
        // ...
        assertEquals("", pathMatcher.extractPathWithinPattern("/docs/commit.html", "/docs/commit.html"));
        assertEquals("cvs/commit", pathMatcher.extractPathWithinPattern("/docs/*", "/docs/cvs/commit"));
        assertEquals("docs/cvs/commit", pathMatcher.extractPathWithinPattern("/d?cs/*", "/docs/cvs/commit"));
        // ...
    }
}

3. extractUriTemplateVariables

package org.springframework.util;
public class AntPathMatcherTests {
    @Test
    public void extractUriTemplateVariables() throws Exception {
        Map<String, String> result = pathMatcher.extractUriTemplateVariables("/hotels/{hotel}", "/hotels/1");
        assertEquals(Collections.singletonMap("hotel", "1"), result);
        // ...
        result = pathMatcher.extractUriTemplateVariables("/{page}.*", "/42.html");
        assertEquals(Collections.singletonMap("page", "42"), result);
        // ...
    }
    /**
     * SPR-7787
     */
    @Test
    public void extractUriTemplateVarsRegexQualifiers() {
        Map<String, String> result = pathMatcher.extractUriTemplateVariables(
                "{symbolicName:[\\p{L}\\.]+}-sources-{version:[\\p{N}\\.]+}.jar",
                "com.example-sources-1.0.0.jar");
        assertEquals("com.example", result.get("symbolicName"));
        assertEquals("1.0.0", result.get("version"));
        // ...
    }
}

4. combine

package org.springframework.util;
public class AntPathMatcherTests {
    @Test
    public void combine() {
        // ...
        assertEquals("/hotels", pathMatcher.combine("/hotels", null));
        assertEquals("/hotels/booking", pathMatcher.combine("/hotels/*", "/booking"));
        assertEquals("/hotels/**/booking", pathMatcher.combine("/hotels/**", "booking"));
        assertEquals("/hotels/**/booking", pathMatcher.combine("/hotels/**", "/booking"));
        assertEquals("/hotels/booking", pathMatcher.combine("/hotels", "/booking"));
        assertEquals("/hotels/{hotel}", pathMatcher.combine("/hotels/*", "{hotel}"));
        assertEquals("/hotels/**/{hotel}", pathMatcher.combine("/hotels/**", "{hotel}"));
        assertEquals("/hotels/*/booking/{booking}", pathMatcher.combine("/hotels/*/booking", "{booking}"));
    }
}