【Java 进阶篇】Java Servlet URL Patterns 详解

Java Servlet 是构建动态 Web 应用程序的关键组件之一，而 URL Patterns（URL 模式）则是定义 Servlet 如何响应不同 URL 请求的重要部分。在本文中，我们将深入探讨 Java Servlet URL Patterns 的各个方面，适用于初学者，无需太多的先验知识。

什么是 URL Patterns？

URL Patterns 是一种用于匹配 URL 请求的模式。在 Web 开发中，我们需要指定哪些 URL 请求由哪个 Servlet 处理。URL Patterns 就是这些规则的集合，它决定了请求的分发方式。

URL Patterns 使用通配符和规则来定义 URL，以便 Servlet 容器可以将请求分配给正确的 Servlet。这使得开发者能够更灵活地控制应用程序的 URL 结构和路由。

Servlet 容器和 URL Patterns

在 Java Web 应用中，Servlet 容器（例如 Tomcat、Jetty 等）负责接收 HTTP 请求并将其路由到正确的 Servlet 处理。这个路由过程依赖于 URL Patterns 的定义。Servlet 容器会检查每个请求的 URL，然后根据 URL Patterns 找到匹配的 Servlet，从而实现请求的分发。

URL Patterns 不仅用于确定哪个 Servlet 处理请求，还可以用于提取 URL 中的参数，以便 Servlet 可以访问请求的数据。这使得 Web 应用能够接收各种不同的请求并执行不同的操作。

基本的 URL Patterns 规则

URL Patterns 使用通配符和规则来匹配 URL 请求。以下是一些常见的 URL Patterns 规则和通配符：

• /*：匹配所有 URL 请求。
• /somedir/*：匹配以 /somedir/ 开头的所有 URL 请求。
• *.extension：匹配以指定文件扩展名结尾的所有 URL 请求。
• /exactURL：精确匹配指定的 URL。

下面我们将详细讨论这些规则并提供示例。

/* - 匹配所有 URL 请求

/* 是最通用的 URL Patterns 规则，它会匹配所有 URL 请求。这意味着无论用户请求什么路径，都将由相应的 Servlet 处理。这通常用于处理默认请求或处理全站点的共享操作。

示例：假设我们有一个名为 DefaultServlet 的 Servlet，我们可以使用以下 URL Patterns 配置：

<servlet-mapping>
    <servlet-name>DefaultServletservlet-name>
    <url-pattern>/*url-pattern>
servlet-mapping>

这将导致 DefaultServlet 处理所有请求，无论请求的路径是什么。

/somedir/* - 匹配特定目录下的所有 URL 请求

/somedir/* 规则用于匹配以 /somedir/ 开头的所有 URL 请求。这在将多个相关 Servlet 分组到同一目录下时非常有用，以实现更有组织的 URL 结构。

示例：假设我们有一个名为 AdminServlet 的 Servlet，它处理所有 /admin/* 下的请求。我们可以使用以下 URL Patterns 配置：

<servlet-mapping>
    <servlet-name>AdminServletservlet-name>
    <url-pattern>/admin/*url-pattern>
servlet-mapping>

这将导致 AdminServlet 处理以 /admin/ 开头的所有请求。

*.extension - 匹配特定文件扩展名的 URL 请求

*.extension 规则用于匹配以指定文件扩展名结尾的 URL 请求。这对于处理特定类型的文件请求非常有用，如图像文件、样式表或脚本文件。

示例：假设我们有一个名为 ImageServlet 的 Servlet，它处理以 .jpg 和 .png 结尾的图像文件。我们可以使用以下 URL Patterns 配置：

<servlet-mapping>
    <servlet-name>ImageServletservlet-name>
    <url-pattern>*.jpgurl-pattern>
servlet-mapping>
<servlet-mapping>
    <servlet-name>ImageServletservlet-name>
    <url-pattern>*.pngurl-pattern>
servlet-mapping>

这将导致 ImageServlet 处理所有以 .jpg 和 .png 结尾的 URL 请求。

/exactURL - 精确匹配指定的 URL

/exactURL 规则用于精确匹配指定的 URL。这意味着只有当请求的 URL 与指定的 URL 完全匹配时，才会由相应的 Servlet 处理。

示例：假设我们有一个名为 AboutServlet 的 Servlet，它处理 /about 页面的请求。我们可以使用以下 URL Patterns 配置：

<servlet-mapping>
    <servlet-name>AboutServletservlet-name>
    <url-pattern>/abouturl-pattern>
servlet-mapping>

这将导致 AboutServlet 处理 /about 页面的请求。

多个 URL Patterns 和 Servlet 映射

在实际应用中，通常需要为不同的 URL 请求分配多个 Servlet。为此，您可以在 web.xml 文件中定义多个 条目。

示例：假设我们有三个不同的 Servlet，分别是 HomeServlet、ContactServlet 和 ServicesServlet，并且我们希望它们分别处理 /home、/contact 和 /services 页面的请求。我们可以这样配置 web.xml 文件：

<servlet-mapping>
    <servlet-name>HomeServletservlet-name>
    <url-pattern>/homeurl-pattern>
servlet-mapping>
<servlet-mapping>
    <servlet-name>ContactServletservlet-name>
    <url-pattern>/contacturl-pattern>
servlet-mapping>
<servlet-mapping>
    <servlet-name>ServicesServletservlet-name>
    <url-pattern>/servicesurl-pattern>
servlet-mapping>

这将使 HomeServlet 处理 /home 页面的请求，ContactServlet 处理 /contact 页面的请求，而 ServicesServlet 处理 /services 页面的请求。

URL Patterns 中的通配符

除了上述基本规则，URL Patterns 还支持一些通配符，以更精细地定义 URL 匹配模式。以下是一些常见的通配符：

• *：匹配零个或多个字符。
• ?：匹配单个字符。
• **：匹配多级目录。
• /：路径分隔符。

这些通配符可以用于创建更复杂的 URL Patterns。

* - 匹配零个或多个字符

* 通配符表示匹配零个或多个字符。这在需要匹配多个 URL 请求时非常有用。

示例：假设我们有一个名为 ProductServlet 的 Servlet，它处理所有以 /product/ 开头的请求，但后面的部分可以是任何字符。我们可以使用以下 URL Patterns 配置：

<servlet-mapping>
    <servlet-name>ProductServletservlet-name>
    <url-pattern>/product/*url-pattern>
servlet-mapping>

这将使 ProductServlet 处理所有以 /product/ 开头的请求，无论后面的字符是什么。

? - 匹配单个字符

? 通配符表示匹配单个字符。这对于需要精确匹配某些字符的 URL 请求非常有用。

示例：假设我们有一个名为 FileServlet 的 Servlet，它处理所有以 /file/ 开头，然后跟随两个字符的请求。我们可以使用以下 URL Patterns 配置：

<servlet-mapping>
    <servlet-name>FileServletservlet-name>
    <url-pattern>/file/??url-pattern>
servlet-mapping>

这将使 FileServlet 处理所有以 /file/ 开头，然后跟随两个字符的请求，如 /file/ab。

** - 匹配多级目录

** 通配符表示匹配多级目录。这对于需要处理多级目录结构的 URL 请求非常有用。

示例：假设我们有一个名为 DirectoryServlet 的 Servlet，它处理所有以 /dir/ 开头的请求，后面可以跟随任意数量的目录级别。我们可以使用以下 URL Patterns 配置：

<servlet-mapping>
    <servlet-name>DirectoryServletservlet-name>
    <url-pattern>/dir/**url-pattern>
servlet-mapping>

这将使 DirectoryServlet 处理所有以 /dir/ 开头的请求，无论后面有多少目录级别，如 /dir/subdir1/subdir2。

/ - 路径分隔符

/ 表示路径分隔符，通常用于分隔目录和文件名。在 URL Patterns 中，它表示 URL 路径的分隔符。

示例：假设我们有一个名为 ResourceServlet 的 Servlet，它处理所有以 /resources/ 开头的请求，后面可以跟随文件名。我们可以使用以下 URL Patterns 配置：

<servlet-mapping>
    <servlet-name>ResourceServletservlet-name>
    <url-pattern>/resources/*url-pattern>
servlet-mapping>

这将使 ResourceServlet 处理所有以 /resources/ 开头的请求，并根据路径分隔符后的部分来查找相应的文件，如 /resources/css/styles.css。

URL Patterns 中的优先级

如果存在多个 URL Patterns 可以匹配同一个 URL 请求，Servlet 容器会根据它们的优先级来决定哪个 Servlet 处理请求。Servlet 容器通常遵循以下规则：

1. 精确匹配（/exactURL）的 URL Patterns 优先级最高。
2. 下级目录匹配（/somedir/*）的 URL Patterns 优先级次之。
3. 文件扩展名匹配（*.extension）的 URL Patterns 优先级较低。
4. 通配符（*、?、**）的 URL Patterns 优先级最低。

这意味着如果存在多个 URL Patterns 可以匹配同一个 URL 请求，Servlet 容器将选择具有最高优先级的 URL Patterns 对应的 Servlet 来处理请求。

示例：创建一个使用 URL Patterns 的 Servlet

为了更好地理解 URL Patterns 的使用，我们将创建一个简单的 Servlet，它将处理不同类型的 URL 请求。在这个示例中，我们将创建一个名为 PageServlet 的 Servlet，它将处理以下几种 URL 请求：

1. /home：显示主页。
2. /about：显示关于页面。
3. /contact：显示联系页面。
4. /products/*：显示产品页面，并接受产品 ID 作为参数。

下面是 web.xml 配置的示例：

<servlet-mapping>
    <servlet-name>PageServletservlet-name>
    <url-pattern>/homeurl-pattern>
servlet-mapping>
<servlet-mapping>
    <servlet-name>PageServletservlet-name>
    <url-pattern>/abouturl-pattern>
servlet-mapping>
<servlet-mapping>
    <servlet-name>PageServletservlet-name>
    <url-pattern>/contacturl-pattern>
servlet-mapping>
<servlet-mapping>
    <servlet-name>PageServletservlet-name>
    <url-pattern>/products/*url-pattern>
servlet-mapping>

现在，让我们来编写 PageServlet 的代码：

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebServlet("/home")
@WebServlet("/about")
@WebServlet("/contact")
@WebServlet("/products/*")
public class PageServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response, throws ServletException, IOException {
        // 获取请求的 URL
        String requestURL = request.getRequestURI();

        // 根据 URL Patterns 匹配相应的操作
        if (requestURL.endsWith("/home")) {
            showHomePage(response);
        } else if (requestURL.endsWith("/about")) {
            showAboutPage(response);
        } else if (requestURL.endsWith("/contact")) {
            showContactPage(response);
        } else if (requestURL.startsWith("/products/")) {
            // 从 URL 中提取产品 ID
            String[] parts = requestURL.split("/");
            if (parts.length > 2) {
                String productId = parts[2];
                showProductPage(response, productId);
            } else {
                response.sendError(HttpServletResponse.SC_BAD_REQUEST);
            }
        } else {
            response.sendError(HttpServletResponse.SC_NOT_FOUND);
        }
    }

    private void showHomePage(HttpServletResponse response) throws IOException {
        response.setContentType("text/html");
        response.getWriter().write("
Welcome to the Home Page
");
    }

    private void showAboutPage(HttpServletResponse response) throws IOException {
        response.setContentType("text/html");
        response.getWriter().write("
About Us
");
    }

    private void showContactPage(HttpServletResponse response) throws IOException {
        response.setContentType("text/html");
        response.getWriter().write("
Contact Us
");
    }

    private void showProductPage(HttpServletResponse response, String productId) throws IOException {
        response.setContentType("text/html");
        response.getWriter().write("
Product Page
");
        response.getWriter().write("
Product ID: " + productId + "
");
    }
}

这个示例中的 PageServlet 接受不同的 URL 请求，并根据 URL Patterns 执行相应的操作。通过使用 URL Patterns，我们可以轻松地为每种请求创建不同的处理逻辑，实现更灵活的路由。

结语

Java Servlet URL Patterns 是构建 Web 应用程序的关键部分，它允许您根据 URL 请求的不同部分将请求分发给不同的 Servlet。通过灵活使用 URL Patterns，您可以创建更有组织的 URL 结构，并处理不同类型的请求。希望本文对理解和使用 URL Patterns 有所帮助，无论您是初学者还是有经验的开发者。如果您有任何问题或需要更多信息，请随时提问。祝您在 Web 开发中取得成功！

作者信息 作者 ： 繁依Fanyi CSDN： https://techfanyi.blog.csdn.net 掘金：https://juejin.cn/user/4154386571867191