SpringMVC的匹配规则

淩亂°似流年 2022-05-28 07:09 351阅读 0赞

# SpringMVC的匹配规则 #

首先需要明确几容易混淆的规则：

1.  servlet容器中的匹配规则既不是简单的通配，也不是正则表达式，而是特定的规则。所以不要用通配符或者正则表达式的匹配规则来看待servlet的url-pattern。
2.  Servlet 2.5开始，一个servlet可以使用多个url-pattern规则，标签声明了与该servlet相应的匹配规则，每个标签代表1个匹配规则；
3.  当servlet容器接收到浏览器发起的一个url请求后，容器会用url减去当前应用的上下文路径，以剩余的字符串作为servlet映射，假如url是[http://localhost:8080/appDemo/index.html][http_localhost_8080_appDemo_index.html]，其应用上下文是appDemo，容器会将[http://localhost:8080/appDemo][http_localhost_8080_appDemo]去掉，用剩下的/index.html部分拿来做servlet的映射匹配
4.  url-pattern映射匹配过程是有优先顺序的
5.  而且当有一个servlet匹配成功以后，就不会去理会剩下的servlet了。
6.  这里有本人一点项目中总结出来的：当我们在web.xml中配置

<servlet-mapping>
            <servlet-name>taotao-portal</servlet-name>
            
            <url-pattern>*.html</url-pattern>
        </servlet-mapping>

而我们的访问路径是localhost:8080/mydome/user/login.html时，项目名为mydemo，我们在Controller中对应的映射是@RequestMapping(“/user/login”)

### 四种匹配规则 ###

###### 1. 精确匹配 ######

中配置的项必须与url完全精确匹配。

<servlet-mapping>
        <servlet-name>MyServlet</servlet-name>
        <url-pattern>/user/users.html</url-pattern>
        <url-pattern>/index.html</url-pattern>
        <url-pattern>/user/addUser.action</url-pattern>
    </servlet-mapping>

当在浏览器中输入如下几种url时，都会被匹配到该servlet  
　　[http://localhost:8080/appDemo/user/users.html][http_localhost_8080_appDemo_user_users.html]  
　　[http://localhost:8080/appDemo/index.html][http_localhost_8080_appDemo_index.html]  
　　[http://localhost:8080/appDemo/user/addUser.action][http_localhost_8080_appDemo_user_addUser.action]

注意：

[http://localhost:8080/appDemo/user/addUser/][http_localhost_8080_appDemo_user_addUser] 是非法的url，不会被当作[http://localhost:8080/appDemo/user/addUser][http_localhost_8080_appDemo_user_addUser 1]识别

另外上述url后面可以跟任意的查询条件，都会被匹配，如

[http://localhost:8080/appDemo/user/addUser?username=Tom&age=23][http_localhost_8080_appDemo_user_addUser_username_Tom_age_23] 会被匹配到MyServlet。

###### 2. 路径匹配 ######

以“/”字符开头，并以“/\*”结尾的字符串用于路径匹配

<servlet-mapping>
        <servlet-name>MyServlet</servlet-name>
        <url-pattern>/user/*</url-pattern>
    </servlet-mapping>

路径以/user/开始，后面的路径可以任意。比如下面的url都会被匹配。  
　　[http://localhost:8080/appDemo/user/users.html][http_localhost_8080_appDemo_user_users.html]  
　　[http://localhost:8080/appDemo/user/addUser.action][http_localhost_8080_appDemo_user_addUser.action]  
　　[http://localhost:8080/appDemo/user/updateUser.actionl][http_localhost_8080_appDemo_user_updateUser.actionl]

###### 3. 扩展名匹配 ######

以“\*.”开头的字符串被用于扩展名匹配

<servlet-mapping>
        <servlet-name>MyServlet</servlet-name>
        <url-pattern>*.jsp</url-pattern>
        <url-pattern>*.action</url-pattern>
    </servlet-mapping>

则任何扩展名为jsp或action的url请求都会匹配，比如下面的url都会被匹配  
　　[http://localhost:8080/appDemo/user/users.jsp][http_localhost_8080_appDemo_user_users.jsp]  
　　[http://localhost:8080/appDemo/toHome.action][http_localhost_8080_appDemo_toHome.action]

###### 4. 缺省匹配 ######

<servlet-mapping>
        <servlet-name>MyServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

### 匹配顺序 ###

1.  精确匹配，servlet-mapping1：/user/users.html，servlet-mapping2：/\*。当一个请求[http://localhost:8080/appDemo/user/users.html][http_localhost_8080_appDemo_user_users.html]来的时候，servlet-mapping1匹配到，不再用servlet-mapping2匹配
2.  路径匹配，先最长路径匹配，再最短路径匹配servlet-mapping1：/user/，servlet-mapping2：/。当一个请求[http://localhost:8080/appDemo/user/users.html][http_localhost_8080_appDemo_user_users.html]来的时候，servlet-mapping1匹配到，不再用servlet-mapping2匹配
3.  扩展名匹配，servlet-mapping1：/user/，servlet-mapping2：.action。当一个请求[http://localhost:8080/appDemo/user/addUser.action][http_localhost_8080_appDemo_user_addUser.action]来的时候，servlet-mapping1匹配到，不再用servlet-mapping2匹配
4.  缺省匹配，以上都找不到servlet，就用默认的servlet，配置为/

### 需要注意的问题 ###

###### 1. 路径匹配和扩展名匹配无法同时设置 ######

匹配方法只有三种，要么是路径匹配（以“/”字符开头，并以“/*”结尾），要么是扩展名匹配（以“*.”开头），要么是精确匹配，三种匹配方法不能进行组合，不要想当然使用通配符或正则规则。

如/user/\*.action是非法的

另外注意：/aa/*/bb*是精确匹配，合法，这里的不是通配的含义

###### \#2. “/\*”和”/”含义并不相同 ######

1.  “/*\*”属于路径匹配，并且可以匹配所有request，由于路径匹配的优先级仅次于精确匹配，所以“/*”会覆盖所有的扩展名匹配，很多404错误均由此引起，所以这是一种特别恶劣的匹配模式，一般只用于filter的url-pattern
2.  “/”是servlet中特殊的匹配模式，切该模式有且仅有一个实例，优先级最低，不会覆盖其他任何url-pattern，只是会替换servlet容器的内建default servlet ，该模式同样会匹配所有request。
3.  配置“/”后，一种可能的现象是myServlet会拦截诸如[http://localhost:8080/appDemo/user/addUser.action][http_localhost_8080_appDemo_user_addUser.action]、[http://localhost:8080/appDemo/user/updateUser][http_localhost_8080_appDemo_user_updateUser]的格式的请求，但是并不会拦截[http://localhost:8080/appDemo/user/users.jsp][http_localhost_8080_appDemo_user_users.jsp]、[http://localhost:8080/appDemo/index.jsp][http_localhost_8080_appDemo_index.jsp]，这是应为servlet容器有内置的“\*.jsp”匹配器，而扩展名匹配的优先级高于缺省匹配，所以才会有上述现象。

###### Tomcat在%CATALINA\_HOME%\\conf\\web.xml文件中配置了默认的Servlet，配置代码如下 ######

<servlet>
            <servlet-name>default</servlet-name>
            <servlet-class>org.apache.catalina.servlets.DefaultServlet</servlet-class>
            <init-param>
                <param-name>debug</param-name>
                <param-value>0</param-value>
            </init-param>
            <init-param>
                <param-name>listings</param-name>
                <param-value>false</param-value>
            </init-param>
            <load-on-startup>1</load-on-startup>
        </servlet>
    <servlet>
            <servlet-name>jsp</servlet-name>
            <servlet-class>org.apache.jasper.servlet.JspServlet</servlet-class>
            <init-param>
                <param-name>fork</param-name>
                <param-value>false</param-value>
            </init-param>
            <init-param>
                <param-name>xpoweredBy</param-name>
                <param-value>false</param-value>
            </init-param>
            <load-on-startup>3</load-on-startup>
     </servlet>
    <servlet-mapping>
            <servlet-name>default</servlet-name>
            <url-pattern>/</url-pattern>
    </servlet-mapping>
    
        
    <servlet-mapping>
            <servlet-name>jsp</servlet-name>
            <url-pattern>*.jsp</url-pattern>
            <url-pattern>*.jspx</url-pattern>
    </servlet-mapping>

可以阅读[http://stackoverflow.com/questions/4140448/difference-between-and-in-servlet-mapping-url-pattern][http_stackoverflow.com_questions_4140448_difference-between-and-in-servlet-mapping-url-pattern]  
“/\*”和“/”均会拦截静态资源的加载，需要特别注意

### 举例 ###

![这里写图片描述][70]  
实际请求映射的结果  
![这里写图片描述][70 1]  
本文转载自：[http://www.cnblogs.com/canger/p/6084846.html][http_www.cnblogs.com_canger_p_6084846.html]

[http_localhost_8080_appDemo_index.html]: http://localhost:8080/appDemo/index.html
[http_localhost_8080_appDemo]: http://localhost:8080/appDemo
[http_localhost_8080_appDemo_user_users.html]: http://localhost:8080/appDemo/user/users.html
[http_localhost_8080_appDemo_user_addUser.action]: http://localhost:8080/appDemo/user/addUser.action
[http_localhost_8080_appDemo_user_addUser]: http://localhost:8080/appDemo/user/addUser/
[http_localhost_8080_appDemo_user_addUser 1]: http://localhost:8080/appDemo/user/addUser
[http_localhost_8080_appDemo_user_addUser_username_Tom_age_23]: http://localhost:8080/appDemo/user/addUser?username=Tom&age=23
[http_localhost_8080_appDemo_user_updateUser.actionl]: http://localhost:8080/appDemo/user/updateUser.actionl
[http_localhost_8080_appDemo_user_users.jsp]: http://localhost:8080/appDemo/user/users.jsp
[http_localhost_8080_appDemo_toHome.action]: http://localhost:8080/appDemo/toHome.action
[http_localhost_8080_appDemo_user_updateUser]: http://localhost:8080/appDemo/user/updateUser
[http_localhost_8080_appDemo_index.jsp]: http://localhost:8080/appDemo/index.jsp
[http_stackoverflow.com_questions_4140448_difference-between-and-in-servlet-mapping-url-pattern]: http://stackoverflow.com/questions/4140448/difference-between-and-in-servlet-mapping-url-pattern
[70]: /images/20220528/1e0050d6ae804c798c51f01173a3817a.png
[70 1]: /images/20220528/975a8459b8a54cd0a13379ac8a4b3675.png
[http_www.cnblogs.com_canger_p_6084846.html]: http://www.cnblogs.com/canger/p/6084846.html