Spring Boot @GetMapping 路径映射指南：解决404错误

在使用 Spring Boot 开发 Web 应用时，若 `@GetMapping` 注解未明确指定路径，访问根 URL 可能会导致 404 Whitelabel Error。本文旨在阐述 `@GetMapping` 注解的正确路径映射机制，指导开发者如何通过为该注解提供显式路径参数来避免此类路由错误，确保 HTTP GET 请求能够准确地映射到对应的控制器方法。

理解 Spring Boot 中的请求映射

Spring Boot 应用程序通常通过 @RestController 或 @Controller 注解的类来处理传入的 HTTP 请求。其中，@GetMapping 是一个便捷的组合注解，用于将 HTTP GET 请求映射到特定的处理方法。然而，一个常见的误解是，当 @GetMapping 不带任何参数时，它会自动映射到应用程序的根路径（/）。实际上，为了确保请求能够被正确路由，@GetMapping 必须显式地指定一个或多个路径。

当您在方法上仅使用 @GetMapping 而不提供路径参数时，Spring 框架并不知道该方法应该响应哪个具体的 URL。因此，当客户端尝试访问应用程序的根路径或其他未显式映射的路径时，Spring DispatcherServlet 将无法找到匹配的处理程序，从而返回 404 Not Found 错误，通常表现为“Whitelabel Error Page”。

正确使用 @GetMapping 进行路径映射

解决此问题的关键在于为 @GetMapping 注解提供一个明确的路径参数。这个路径可以是根路径 /，也可以是任何自定义的路径，例如 /hello 或 /api/data。

示例代码：修复前的控制器

以下是可能导致 404 错误的原始代码示例：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    // 错误示例：未指定路径，可能导致404
    @GetMapping
    public String index() {
        return "Greetings from Spring Boot!";
    }
}

当运行上述代码并尝试访问 http://localhost:8080/ 时，您会看到一个 404 Whitelabel Error Page。控制台日志可能显示 DispatcherServlet 已经初始化，但没有关于 / 路径的映射信息。

示例代码：修复后的控制器

为了正确映射请求，我们需要为 @GetMapping 注解指定一个路径。

艺映AI

艺映AI - 免费AI视频创作工具

62

查看详情

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    // 正确示例1：映射到根路径 "/"
    @GetMapping("/")
    public String home() {
        return "Welcome to the home page!";
    }

    // 正确示例2：映射到自定义路径 "/hello"
    @GetMapping("/hello")
    public String hello() {
        return "Greetings from Spring Boot!";
    }

    // 您也可以使用 path 属性，效果相同
    @GetMapping(path = "/greeting")
    public String greeting() {
        return "Hello from /greeting!";
    }
}

在上述修复后的代码中：

• @GetMapping("/") 将 home() 方法映射到应用程序的根路径 http://localhost:8080/。
• @GetMapping("/hello") 将 hello() 方法映射到 http://localhost:8080/hello。
• @GetMapping(path = "/greeting") 将 greeting() 方法映射到 http://localhost:8080/greeting。

通过这种方式，Spring DispatcherServlet 就能找到对应的处理器方法，并返回预期的响应。

关键注意事项与排查

1. 显式路径是必需的： 始终为 @GetMapping（以及 @PostMapping, @PutMapping, @DeleteMapping 等）提供一个明确的路径。
2. spring-boot-starter-web 依赖： 确保您的 pom.xml 文件中包含了 spring-boot-starter-web 依赖。这是 Spring Boot 构建 Web 应用程序的基础，它包含了内嵌的 Tomcat 服务器、Spring MVC 等核心组件。

   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
   </dependency>

   登录后复制

   原始的 pom.xml 中已经包含了此依赖，因此这个问题通常不是由于缺少依赖引起的。

3. 控制台日志分析： 仔细检查应用程序启动时的控制台日志。成功的启动会显示 Tomcat 监听的端口和上下文路径。例如：

   Tomcat started on port(s): 8080 (http) with context path ''

   登录后复制

   这表示应用程序在 http://localhost:8080 上运行，且根路径为 /。

4. @RestController 或 @Controller： 确保您的类被 @RestController（对于 RESTful API）或 @Controller（对于传统的 MVC 应用）注解。这些注解告诉 Spring 这是一个处理 HTTP 请求的组件，并会扫描其中的请求映射方法。
5. 父级路径（Optional）： 您也可以在类级别使用 @RequestMapping("/api")，然后在方法级别使用 @GetMapping("/users")，这样完整的路径将是 /api/users。这有助于组织和管理大量端点。

总结

当在 Spring Boot 中遇到 @GetMapping 相关的 404 错误时，最常见的原因是未给 @GetMapping 注解提供明确的路径参数。通过为 @GetMapping 指定一个字符串路径，您可以清晰地定义每个控制器方法所响应的 URL，从而有效地解决请求无法映射的问题，并确保您的 Web 应用程序按预期工作。遵循这些简单的路径映射规则，将帮助您构建健壮且易于维护的 Spring Boot 应用。

以上就是Spring Boot @GetMapping 路径映射指南：解决404错误的详细内容，更多请关注php中文网其它相关文章！