在使用postman测试spring boot restful api时，常见的404 not found错误往往源于对url路径的误解。本文将深入解析spring boot默认上下文路径的工作机制，结合具体代码示例，指导开发者如何正确构建api请求url，并提供自定义上下文路径的配置方法，旨在帮助用户高效定位并解决此类路径相关的404问题。
理解Spring Boot REST API的404错误与路径配置
当Spring Boot应用程序返回404 Not Found错误时，通常意味着客户端请求的URL与服务器上任何已定义的API端点不匹配。这可能是由于多种原因，但最常见的是URL路径构造不正确，尤其是涉及到应用程序的上下文路径（context path）。
案例分析：Postman请求404错误
考虑一个Spring Boot应用程序，其目标是管理产品信息并将其存储到MongoDB。开发者尝试使用Postman向http://localhost:8080/mdb-spring-boot-product-organizer/api/addProduct发送POST请求，但收到了以下404错误响应：
{
"timestamp": "2022-12-07T22:56:33.866+00:00",
"status": 404,
"error": "Not Found",
"path": "/mdb-spring-boot-product-organizer/api/addProduct"
}这个错误明确指出，服务器在/mdb-spring-boot-product-organizer/api/addProduct这个路径上没有找到对应的资源。
深入解析Spring Boot控制器与URL映射
为了理解为什么会出现404错误，我们需要查看Spring Boot应用程序的控制器代码。
ProductController.java
package com.example.mdbspringbootproductorganizer.controller;
import java.util.List;
import java.util.Optional;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
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;
import com.example.mdbspringbootproductorganizer.model.Product;
import com.example.mdbspringbootproductorganizer.repository.ProductRepository;
@RestController
@RequestMapping("/api") // 控制器级别的基础路径
public class ProductController {
@Autowired
private ProductRepository repository;
@PostMapping("/addProduct") // 方法级别的路径
public String saveProduct(@RequestBody Product product) {
repository.save(product);
return "Added product with id : " + product.getId();
}
// ... 其他API方法 ...
}从上述代码中，我们可以看到：
- ProductController类上使用了@RequestMapping("/api")注解。这意味着该控制器中所有方法的路径都将以/api作为前缀。
- saveProduct方法上使用了@PostMapping("/addProduct")注解。这表示该方法处理POST请求，并且其相对路径是/addProduct。
因此，saveProduct方法在应用程序中的完整URL路径应该是/api/addProduct。
默认上下文路径与URL构造
Spring Boot应用程序在嵌入式Servlet容器（如Tomcat、Jetty）中运行时，默认的上下文路径是/。这意味着应用程序会直接响应根路径下的请求，而不会自动包含项目名称或artifact ID作为URL的一部分。
在给定的错误示例中，mdb-spring-boot-product-organizer是项目名称，但它不应该出现在默认的URL路径中。开发者错误地将项目名称当作了应用程序的上下文路径。
正确的API请求URL
基于上述分析，正确的Postman请求URL应该是：
http://localhost:8080/api/addProduct
这里，http://localhost:8080是服务器地址和端口，/api是控制器级别的基础路径，/addProduct是方法级别的路径。
Postman请求示例：
- Method: POST
- URL: http://localhost:8080/api/addProduct
- Headers: Content-Type: application/json
-
Body (raw, JSON):
{ "id": 1, "name": "Laptop", "listedPrice": 1200.00, "purchasePrice": 1000.00, "condition": "New", "brand": "Dell", "shelf": "A", "bin": 101 }
自定义应用程序上下文路径
虽然Spring Boot的默认上下文路径是/，但在某些场景下，你可能希望为应用程序设置一个特定的上下文路径，例如/my-app。这可以通过在application.properties或application.yml文件中配置server.servlet.context-path属性来实现。
application.properties示例：
server.port=8080 server.servlet.context-path=/mdb-spring-boot-product-organizer
如果配置了上述属性，那么应用程序的根路径将变为/mdb-spring-boot-product-organizer。此时，要访问saveProduct方法，正确的URL将是：
http://localhost:8080/mdb-spring-boot-product-organizer/api/addProduct
这种情况下，原始请求中的URL反而是正确的。因此，在排查404错误时，检查application.properties或application.yml中是否存在server.servlet.context-path配置是至关重要的一步。
总结与注意事项
- 默认上下文路径： Spring Boot应用程序默认的上下文路径是/。这意味着你的API路径直接跟在host:port后面。
- 控制器映射： @RequestMapping注解可以应用于类和方法。类上的@RequestMapping定义了所有方法的基础路径，方法上的注解则定义了相对路径。
- URL构造： 正确的URL是 [协议]://[主机]:[端口]/[可选的自定义上下文路径]/[控制器基础路径]/[方法路径]。
-
排查404：
- 检查URL是否与代码中的@RequestMapping和@PostMapping等注解完全匹配。
- 确认application.properties或application.yml中是否存在server.servlet.context-path配置。 如果存在，请将其纳入URL构造中；如果不存在，则不要在URL中包含项目名称或任何额外的路径段。
- 确保Spring Boot应用程序已成功启动，并且没有端口冲突或其他启动错误。
- 检查请求方法是否正确（GET, POST, PUT, DELETE等）。
- 检查路径变量（@PathVariable）和请求参数（@RequestParam）是否正确传递。
通过理解Spring Boot的URL映射机制和上下文路径配置，开发者可以更有效地避免和解决Postman测试中出现的404 Not Found错误。
