解决Spring Boot应用中Postman 404错误的URL路径解析指南

本教程旨在解决spring boot应用开发中，使用postman发送请求时遇到的404 not found错误。核心问题通常源于对url路径的误解，特别是spring boot默认的应用上下文路径与控制器层级映射的组合。文章将通过分析代码示例，详细阐述正确的url构建方式，并提供一系列实用的排查技巧，帮助开发者准确识别并修正此类问题。

在Spring Boot应用开发中，当使用Postman等工具测试API接口时，收到404 Not Found错误是一个常见的问题。这通常意味着客户端请求的URL与服务器端定义的API路径不匹配。理解Spring Boot如何解析URL路径是解决此类问题的关键。

理解Spring Boot中的URL映射

Spring Boot应用程序的URL路径由几个部分组成：

1. 协议和主机端口： 例如 http://localhost:8080。
2. 应用上下文路径 (Context Path)： 默认情况下，Spring Boot应用部署在根上下文路径 /。这意味着你的应用无需额外的路径前缀即可访问。然而，可以通过在 application.properties 或 application.yml 中配置 server.servlet.context-path 来改变这一默认行为。例如，如果设置为 /my-app，则所有API都将以 /my-app 开头。
3. 控制器级别路径： 通过在控制器类上使用 @RequestMapping 注解定义。这为控制器内的所有方法提供了一个基础路径。
4. 方法级别路径： 通过在控制器方法上使用 @GetMapping, @PostMapping, @PutMapping, @DeleteMapping 或 @RequestMapping 注解定义。这定义了特定HTTP方法和路径的组合。

结合以上规则，一个完整的API路径是：{协议}://{主机}:{端口}/{应用上下文路径}/{控制器级别路径}/{方法级别路径}。

案例分析：Postman 404错误

根据提供的代码和错误信息，我们来具体分析导致404错误的原因。

错误请求URL:http://localhost:8080/mdb-spring-boot-product-organizer/api/addProduct

Spring Boot应用结构: 主应用类 MdbSpringBootApplication 位于 com.example.mdbspringbootproductorganizer 包下，并通过 @SpringBootApplication 启动。

package com.example.mdbspringbootproductorganizer;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.data.mongodb.repository.config.EnableMongoRepositories;

@SpringBootApplication
@EnableMongoRepositories
public class MdbSpringBootApplication {
    public static void main(String[] args) {
        SpringApplication.run(MdbSpringBootApplication.class, args);
    }
}

控制器代码:ProductController 定义了API接口。

package com.example.mdbspringbootproductorganizer.controller;

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

// ... 其他导入和方法 ...

@RestController
@RequestMapping("/api") // 控制器级别路径
public class ProductController {

    // ... 其他依赖和方法 ...

    @PostMapping("/addProduct") // 方法级别路径
    public String saveProduct(@RequestBody Product product) {
        // ... 保存产品逻辑 ...
        return "Added product with id : " + product.getId();
    }
}

从上述代码中，我们可以得出以下关键信息：

1. 应用上下文路径： 在 MdbSpringBootApplication 中，没有显式配置 server.servlet.context-path，因此默认的应用上下文路径是 /。这意味着应用程序本身不会在URL中添加 mdb-spring-boot-product-organizer 这样的前缀。
2. 控制器级别路径： ProductController 类上标注了 @RequestMapping("/api")。这意味着该控制器中的所有方法都将以 /api 作为基础路径。
3. 方法级别路径： saveProduct 方法上标注了 @PostMapping("/addProduct")。这意味着该方法在控制器基础路径 /api 之上，又添加了 /addProduct。

综合来看，saveProduct 方法的完整有效路径应该是 /api/addProduct。

错误分析： 用户在Postman中使用的URL是 http://localhost:8080/mdb-spring-boot-product-organizer/api/addProduct。其中多余的 /mdb-spring-boot-product-organizer 部分导致了404错误。Spring Boot应用在默认配置下，并不会将项目名称或包路径作为URL的一部分。

正确的URL构建与Postman请求示例

要正确访问 saveProduct 接口，Postman请求的URL应该是：

http://localhost:8080/api/addProduct

ChatsNow

ChatsNow是一款免费的AI写作类浏览器插件，提供智能聊天机器人、智能翻译、智能搜索等工具

253

查看详情

Postman请求配置示例：

• Method (方法): POST
• URL: http://localhost:8080/api/addProduct
• Headers (请求头):
  • Content-Type: application/json
• Body (请求体): 选择 raw 和 JSON 类型，输入以下JSON数据（根据你的 Product 模型）：

{
    "id": 1,
    "name": "Laptop Pro",
    "listedPrice": 1200.00,
    "purchasePrice": 1000.00,
    "condition": "New",
    "brand": "TechBrand",
    "shelf": "A",
    "bin": 101
}

常见404错误排查技巧

当在Spring Boot应用中遇到404错误时，可以按照以下步骤进行排查：

1. 检查URL路径是否匹配：

   • 确认 @RequestMapping 或特定HTTP方法注解（如 @GetMapping, @PostMapping）中的路径与请求URL完全一致，包括大小写。
   • 检查控制器类上的 @RequestMapping 是否正确，以及方法上的路径是否基于控制器路径正确拼接。
   • 确保没有多余的路径段（如本例中的 /mdb-spring-boot-product-organizer），除非你在 application.properties 中明确配置了 server.servlet.context-path。

2. 检查HTTP方法是否匹配：

   • 确保Postman中选择的HTTP方法（GET, POST, PUT, DELETE等）与控制器方法上使用的注解（@GetMapping, @PostMapping等）一致。例如，对 @PostMapping 方法发送GET请求会导致404或405 Method Not Allowed错误。

3. 检查Spring Boot应用是否成功启动：

   • 查看控制台日志，确保应用已成功启动，没有端口冲突或其他启动失败的错误。
   • 确认应用正在监听你请求的端口（通常是8080）。

4. 检查Controller是否被Spring扫描到：

   • 确保你的Controller类位于 @SpringBootApplication 注解所在包或其子包中，以便Spring Boot能够自动扫描并注册它。
   • 确认Controller类上使用了 @RestController 或 @Controller 注解。

5. 检查依赖是否正确：

   • 确保 pom.xml 中包含了 spring-boot-starter-web 依赖，这是构建Web应用所必需的。

6. 查看Spring Boot日志：

   • 启动应用时，Spring Boot会在控制台输出所有映射的URL路径。仔细检查这些日志，确认你的API路径是否按预期注册。例如，你可能会看到类似 Mapped "{[/api/addProduct],methods=[POST]}" 的日志。

总结

Spring Boot中的404错误通常是由于URL路径配置不当造成的。通过理解应用上下文路径、控制器级别路径和方法级别路径的组合规则，并仔细检查代码中的 @RequestMapping 及相关注解，可以有效地定位并解决这些问题。始终记住，Spring Boot默认的应用上下文路径是根路径 /，除非你在 application.properties 中进行了自定义配置。在排查问题时，结合Postman的请求细节和Spring Boot的启动日志，将大大提高解决效率。

以上就是解决Spring Boot应用中Postman 404错误的URL路径解析指南的详细内容，更多请关注php中文网其它相关文章！