关于tomcat中servlet的url-pattern匹配规则
首先需要明确几点容易混淆的规则:
- servlet容器中的匹配规则既不是简单的通配,也不是正则表达式,而是特定的规则。所以不要用通配符或者正则表达式的匹配规则来看待servlet的url-pattern
- Servlet 2.5开始,一个servlet可以使用多个url-pattern规则,<servlet-mapping>标签声明了与该servlet相应的匹配规则,每个<url-pattern>标签代表1个匹配规则
- 当servlet容器接收到浏览器发起的一个url请求后,容器会用url减去当前应用的上下文路径,以剩余的字符串作为servlet映射,假如url是http://localhost:8080/appDemo/index.html,其应用上下文是appDemo,容器会将http://localhost:8080/appDemo去掉,用剩下的/index.html部分拿来做servlet的映射匹配
- url-pattern映射匹配过程是有优先顺序的
- 而且当有一个servlet匹配成功以后,就不会去理会剩下的servlet了
一、四种匹配规则
1 精确匹配
<url-pattern>中配置的项必须与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/index.html
http://localhost:8080/appDemo/user/addUser.action
注意:
http://localhost:8080/appDemo/user/addUser.action/ 是非法的url,不会被当作 http://localhost:8080/appDemo/user/addUser.action 识别
另外上述url后面可以跟任意的查询条件(即参数),都会被匹配,如
http://localhost:8080/appDemo/user/addUser.action?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/addUser.action
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/toHome.action
4 缺省匹配
<servlet-mapping>
<servlet-name>MyServlet</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
二、匹配顺序
-
精确匹配:
servlet-mapping1:<url-pattern>/user/users.html</url-pattern>
servlet-mapping2:<url-pattern>/*</url-pattern>
当一个请求 http://localhost:8080/appDemo/user/users.html 来的时候,servlet-mapping1匹配到,不再用servlet-mapping2匹配
-
路径匹配:
先最长路径匹配,再最短路径匹配
servlet-mapping1:<url-pattern>/user/*</url-pattern>
servlet-mapping2:<url-pattern>/*</url-pattern>
当一个请求 http://localhost:8080/appDemo/user/users.html 来的时候,servlet-mapping1匹配到,不再用servlet-mapping2匹配
-
扩展名匹配:
servlet-mapping1:<url-pattern>/user/*</url-pattern>
servlet-mapping2:<url-pattern>*.action</url-pattern>
当一个请求 http://localhost:8080/appDemo/user/addUser.action 来的时候,servlet-mapping1匹配到,不再用servlet-mapping2匹配
-
缺省匹配:
以上都找不到servlet,就用默认的servlet,配置为<url-pattern>/</url-pattern>
三、需要注意的问题
1 路径匹配和扩展名匹配无法同时设置
匹配方法只有三种,要么是路径匹配(以“/”字符开头,并以“/*”结尾),要么是扩展名匹配(以“*.”开头),要么是精确匹配,三种匹配方法不能进行组合,不要想当然使用通配符或正则规则。
如<url-pattern>/user/*.action</url-pattern>是非法的
另外注意:<url-pattern>/aa/*/bb</url-pattern>是精确匹配,合法,这里的*不是通配的含义,就是字面实体含义
2 "/*"和"/"含义并不相同
“/*”属于路径匹配,并且可以匹配所有request,由于路径匹配的优先级仅次于精确匹配,所以“/*”会覆盖所有的扩展名匹配,很多404错误均由此引起,所以这是一种特别恶劣的匹配模式,一般只用于filter的url-pattern
“/”是servlet中特殊的匹配模式,且该模式有且仅有一个实例,优先级最低,不会覆盖其他任何url-pattern,只是会替换tomcat容器的内建default servlet ,该模式同样会匹配所有request。
配置“/”后,一种可能的现象是myServlet会拦截诸如 http://localhost:8080/appDemo/user/addUser.action 、 http://localhost:8080/appDemo/user/updateUser 的格式的请求,但是并不会拦截 http://localhost:8080/appDemo/user/users.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
- “/*”和“/”均会拦截静态资源的加载,需要特别注意
四、举例
映射的URL | 对应的Servlet |
/hello | servlet1 |
/bbs/admin/* | servlet2 |
/bbs/* | servlet3 |
*.jsp | servlet4 |
/ | servlet5 |
实际请求映射的结果
去掉上下文路径的剩余路径 |
处理请求的Servlet |
/hello |
servlet1 |
/bbs/admin/login |
servlet2 |
/bbs/admin/index.jsp |
servlet2 |
/bbs/display |
servlet3 |
/bbs/index.jsp |
servlet3 |
/bbs |
servlet3 |
/index.jsp |
servler4 |
/hello/index.jsp |
servlet4 |
/hello/index.html |
servlet5 |
/news |
servlet5 |
补充:
1、”缺省“ 的意思就是默认,这是古早计算机翻译的锅,将英文单词 'default' 翻译成了这个词
2、web应用程序的根目录是一个特殊的目录,当它被default servlet(即url-pattern配置为”/“)匹配时,不会先进入到这个servlet,而是被转发到欢迎页面,如果找不到欢迎页面,才会进入default servlet
tomcat源码片段:
<!-- ==================== Default Welcome File List ===================== -->
<!-- When a request URI refers to a directory, the default servlet looks -->
<!-- for a "welcome file" within that directory and, if present, to the -->
<!-- corresponding resource URI for display. -->
<!-- If no welcome files are present, the default servlet either serves a -->
<!-- directory listing (see default servlet configuration on how to -->
<!-- customize) or returns a 404 status, depending on the value of the -->
<!-- listings setting. -->
<!-- -->
<!-- If you define welcome files in your own application's web.xml -->
<!-- deployment descriptor, that list *replaces* the list configured -->
<!-- here, so be sure to include any of the default values that you wish -->
<!-- to use within your application. -->
大意👇
当请求URI指向目录(即web应用程序的根目录)时,默认的servlet在该目录中查找“欢迎文件”(即index.jsp),如果存在,则在相应的资源URI中查找以进行显示。如果不存在欢迎文件,则默认的servlet会提供目录列表(在web.xml中配置的<welcome-file-list>)(请参阅默认servlet配置中的有关如何自定义的内容)或返回404状态,具体取决于列表设置的值
注意:请求URI是要被 default servlet 匹配,才会去查找欢迎页面,如果被其他的servlet匹配(例如url-pattern为”/*“的路径匹配),会直接进入这个servlet,不会再去查找欢迎页面
原文年代太久远,有些地方难免有缺漏和错误,已由MoonDream博主对其进行了润色和补充,可以放心食用