servlet的url-pattern匹配规则简介

怼烎@ 2022-05-09 10:54 211阅读 0赞

前言：正在看SpringMVC的前端控制器，正好看到了一个<url-pattern>/</url-pattern>，由此引发对url-pattern匹配规则的思考。

#                                        第一章 匹配概述 #

<url-pattern>是我们用Servlet做Web项目时需要经常配置的标签，例：

<servlet>
    <servlet-name>index</servlet-name>
    <servlet-class>com.we.servlet.IndexServlet</servlet-class>
    </servlet>
    <servlet-mapping>
    <servlet-name>index</servlet-name>
    <url-pattern>/index</url-pattern>
    </servlet-mapping>

当我们在浏览器的地址栏里输入http://localhost:8080/we/index时（假设我部署在webapps目录下的项目名为we）

就会匹配到我们指定的<url-pattern>中，即/index然后一步一步找到对应的<servlet-class>

那我们输入的URL：http://localhost:8080/we/index又是如何与<url-pattern>中的/index匹配的呢？

首先我们要知道URL的组成

http://localhost:8080    我们可以理解为是我们的服务器地址，而该地址之后的部分我们统称为：RequestURI

RequestURI是我们需要重点注意的部分，其又可以分解为几部分

/we  是我们的ServletConext的上下文地址，我们称为ServletContext Path，可以简单理解为部署项目时的webapps目录下的项目名

/index  是我们的Servlet的地址，我们称为Servlet Path，这里就是需要与我们的<url-pattern>匹配的内容**。**

在利用servlet或Filter进行url请求的匹配时，很关键的一点就是匹配规则，但servlet容器中的匹配规则既不是简单的通配，也不是正则表达式，而是由自己的规则，比较容易混淆。

这个映射匹配过程是有优先顺序的(具体的优先顺序规则后面介绍)，而且当有一个servlet匹配成功以后，就不会去理会剩下的servlet了。

Filter的匹配规则与servlet一样，但对于filter，不会像servlet那样只匹配一个servlet，因为filter的集合是一个链，所以只会有处理的顺序不同，而不会出现只选择一个filter。Filter的处理顺序和filter-mapping在web.xml中定义的顺序相同。

#                                          第二章 匹配规则 #

## 2.1 精准匹配 ##

<url-pattern>中配置的项必须与url完全精确匹配。

如配置信息如下：

<servlet-mapping>
        <servlet-name>MyServlet</servlet-name>
        <url-pattern>/kata/detail.html</url-pattern>
        <url-pattern>/demo.html</url-pattern>
        <url-pattern>/table</url-pattern>
    </servlet-mapping>

当在浏览器中输入如下几种url时，都会被匹配到该servlet  
http://10.43.11.143/myapp/kata/detail.html  
http://10.43.11.143/myapp/demo.html  
http://10.43.11.143/myapp/table

注意：

http://10.43.11.143/myapp/table/ 是非法的url，不会被当作http://10.43.11.143/myapp/table识别

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

http://10.43.11.143/myapp/table?hello 这个请求就会被匹配到MyServlet。

## 2.2 扩展名匹配 ##

匹配规则如下：

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

则任何扩展名为jsp（文件名和路径任意）的url请求都会匹配，比如下面的url都会被匹配  
http://10.43.11.143/myapp/demo.jsp  
http://10.43.11.143/myapp/test.jsp

## 2.3 路径匹配 ##

匹配规则如下：

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

则请求的ulr只要前面（myapp之后）的路径是/kata，而后面的路径可以任意。比如下面的url都会被匹配。  
http://10.43.11.143/myapp/kata/demo.html  
http://10.43.11.143/myapp/kata/test.jsp  
http://10.43.11.143/myapp/kata/test/detail.html

http://10.43.11.143/myapp/kata/action

http://10.43.11.143/myapp/kata/action/

注意：路径和扩展名匹配无法同时设置，比如下面的三个<url-pattern>都是非法的，如果设置，启动tomcat服务器会报错。

<url-pattern>/kata/\*.jsp</url-pattern>

<url-pattern>/\*.jsp</url-pattern>

<url-pattern>he\*.jsp</url-pattern>

另外注意：<url-pattern>/aa/\*/bb</url-pattern>  
这个是精确匹配，url必须是 /aa/\*/bb，这里的\*不是通配的含义

## 2.4 匹配任意的url ##

如果<url-pattern>配置成如下两种的任意一种

<url-pattern>/</url-pattern>

<url-pattern>/\*</url-pattern>

则所有的url都可以被匹配上。其中/\*是路径匹配，只是路径就是/。

以上两种是有区别的，内容较多较重要，放在第三章细说。

## 2.5 优先顺序 ##

当一个url与多个servlet的匹配规则可以匹配时，则按照 “ 精确路径 > 最长路径>扩展名”这样的优先级匹配到对应的servlet。举例如下：

**例1：**比如servletA 的url-pattern为 /test，servletB的url-pattern为 /\* ，这个时候，如果我访问的url为http://localhost/test ，这个时候容器就会先进行精确路径匹配，发现/test正好被servletA精确匹配，那么就去调用servletA，不会去管servletB。

**例2：**比如servletA的url-pattern为/test/\*，而servletB的url-pattern为/test/a/\*，此时访问http://localhost/test/a时，容器会选择路径最长的servlet来匹配，也就是这里的servletB。

**例3: 比如**servletA的url-pattern：\*.action ，servletB的url-pattern为 /\* ，这个时候，如果我访问的url为http://localhost/test.action，这个时候容器就会优先进行路径匹配，而不是去匹配扩展名，这样就去调用servletB。

# 第三章 <url-pattern>/</url-pattern>与<url-pattern>/\*</url-pattern>的区别 #

<url-pattern>/</url-pattern> 看官方文档可知，果我们的项目中配置了"/"，会覆盖掉tomcat中的默认servlet，当其他的url-pattern匹配不上时都会走这个servlet，它会匹配到后缀型url，它除了能够处理静态资源如“.js”，“.css”，".png"等，还能够处理HTTP缓存请求，媒体（音频/视频）数据流和文件下载简历。说到为什么JSP页面的请求（\*.jsp）并不会命中这个servlet，那是因为当有这种url请求时，servlet容器内建的JSP servlet将会被调用，而这个容器内建的JSP servlet已经默认地映射在了\*.jsp上。

<url-pattern>/\*</url-pattern>

这种形式将会覆盖所有其它的servlet。不管你发出了什么样的请求，最终都会在这个servlet中结束。因此，对于servlet来说，这是一个很糟糕的URL模式。通常来讲，你只会想要在一个Filter中使用这种模式。它可以通过调用doFilter()方法来使请求继续。

参考博客：

[https://www.cnblogs.com/huangwentian/p/6417792.html][https_www.cnblogs.com_huangwentian_p_6417792.html]

[https://www.cnblogs.com/51kata/p/5152400.html][https_www.cnblogs.com_51kata_p_5152400.html]

[https://blog.csdn.net/qq\_36870779/article/details/62883466][https_blog.csdn.net_qq_36870779_article_details_62883466]

[https://blog.csdn.net/u012679583/article/details/52816257][https_blog.csdn.net_u012679583_article_details_52816257]

可能有用的英文解释：[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][]

注：本人的这篇文章大部分是从上面几篇中拿了感觉比较好的部分复制粘贴的，进行了自我归纳和整理，非常感谢，如有侵权，请私聊，我会删除（逃）

[https_www.cnblogs.com_huangwentian_p_6417792.html]: https://www.cnblogs.com/huangwentian/p/6417792.html
[https_www.cnblogs.com_51kata_p_5152400.html]: https://www.cnblogs.com/51kata/p/5152400.html
[https_blog.csdn.net_qq_36870779_article_details_62883466]: https://blog.csdn.net/qq_36870779/article/details/62883466
[https_blog.csdn.net_u012679583_article_details_52816257]: https://blog.csdn.net/u012679583/article/details/52816257
[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/20220509/8324fa9d3b164f72b4155c9299b019d5.png