Servlet映射路径匹配解析详解

背景

在 Java Web 开发中，Servlet 是最基本的组件之一，而 Servlet 的映射路径（即 <url-pattern> 标签所配置的路径）则能够指定 Servlet 对哪些请求进行处理。传统的映射路径匹配规则较为简单，只支持 * 和 / 两种通配符，但实际开发中，我们常常需要更加灵活的映射路径配置，因此 Servlet 4.0 规范中引入了全新的 Servlet 映射路径匹配规则。

策略

新的 Servlet 映射路径匹配规则中，映射路径可以写为以下几种形式：

1. 纯文本
2. * 通配符
3. ** 通配符
4. / 与 .

下面将分别介绍每种形式的匹配规则。

1. 纯文本

输入的映射路径直接与请求的路径进行比对。例如，配置了映射路径为 /test 的 Servlet，只有包含 /test 的请求路径才会被该 Servlet 处理，如 /myapp/test、/test/abc 等。

2. * 通配符

输入的映射路径以 * 作为前缀，并将其后面的字符作为前缀匹配，如果请求的路径以该前缀开始，则匹配成功。例如，配置了映射路径为 /test/* 的 Servlet，与 /test/abc、/test/abc/123 等请求路径匹配。

3. ** 通配符

输入的映射路径以 ** 作为前缀，并将其后面的字符作为路径匹配，如果请求路径以该部分路径结尾，则匹配成功。例如，配置了映射路径为 /test/** 的 Servlet，与 /test/abc、/test/abc/123、/test/abc/123/xyz等请求路径匹配，但不与 /testabc 等请求路径匹配。

4. / 与 .

输入的映射路径以 / 或 . 作为结束符，表示精确匹配路径或扩展名匹配。例如，配置了映射路径为 /test.do 的 Servlet，只有请求路径为 /test.do 时才匹配，则请求路径为 /test/do 或 /test/do/123 等都不匹配。

示例

下面通过两个具体的示例来说明 Servlet 映射路径匹配规则的使用。

示例 1

假设有一个 Servlet 需要接收所有以 /api 开头的请求，并对请求路径进行日志记录。此时可以选择将该 Servlet 的映射路径配置为 /api/**，代码如下：

<servlet>
    <servlet-name>ApiServlet</servlet-name>
    <servlet-class>com.example.ApiServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>ApiServlet</servlet-name>
    <url-pattern>/api/**</url-pattern>
</servlet-mapping>

如此，在应用程序中所有请求路径以 /api 开头的请求都将被该 Servlet 处理，例如 GET /api/user/list、POST /api/user/create 等请求均会触发该 Servlet 的 service() 方法调用。

示例 2

假设有一个 Servlet 用于处理用户登录请求，该请求只支持 POST 方法，并且必须携带 username、password 两个参数。此时可以选择将该 Servlet 的映射路径配置为 /login.do，代码如下：

<servlet>
    <servlet-name>LoginServlet</servlet-name>
    <servlet-class>com.example.LoginServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>LoginServlet</servlet-name>
    <url-pattern>/login.do</url-pattern>
</servlet-mapping>

如此，在应用程序中任何请求路径为 /login.do 的 POST 请求，且请求参数中包含 username 和 password 两个参数，都将被该 Servlet 处理。

总结

本文分别介绍了新的 Servlet 映射路径匹配规则中的四种匹配形式，以及两个具体的示例说明。当开发者在编写 Servlet 时，有了这种更加灵活的映射路径匹配规则，将大大方便映射路径的配置，提高了其应用的可维护性和可扩展性。