解决 Spring Boot 中 `Ambiguous mapping. Cannot map ‘xxxController‘ method` 错误

前言

在使用 Spring Boot 开发 Web 应用时，经常会遇到各种各样的错误。其中一种常见的错误是 Ambiguous mapping. Cannot map ‘testController‘ method。本文将详细介绍这个错误的原因及解决方法，帮助开发者快速定位并解决问题。

错误解释

这个错误表示在 Spring Boot 应用中存在两个或多个相同的映射，导致无法确定应当由哪一个控制器（Controller）处理特定的 HTTP 请求。具体来说，这通常是因为您的应用中有两个或多个使用 @RequestMapping 或其变体（如 @GetMapping、@PostMapping 等）注解的方法，它们的路径相同或容易混淆。

错误示例

假设您有以下两个方法：

@RestController
@RequestMapping("/api")
public class TestController {@GetMapping("/save")public String save() {return "Saved";}@PostMapping("/save")public String changeSave(@RequestBody String data) {return "Changed and Saved: " + data;}
}

在这个例子中，两个方法的路径都是 /api/save，但是请求方法不同（一个是 GET，另一个是 POST）。这是允许的，因为请求方法不同，Spring 可以正确区分这两个方法。

然而，如果您有以下两个方法：

@RestController
@RequestMapping("/api")
public class TestController {@PostMapping("/save")public String save() {return "Saved";}@PostMapping("/save")public String changeSave(@RequestBody String data) {return "Changed and Saved: " + data;}
}

在这个例子中，两个方法的路径和请求方法都相同，因此会导致 Ambiguous mapping 错误。

解决方法

1. 检查所有 @RequestMapping 和相关注解

   • 确保没有两个或多个路径相同的映射。检查您的 Controller 类中的所有 @RequestMapping、@GetMapping、@PostMapping 等注解，确保它们的路径是唯一的。
   • 如果确实有意图使用相同路径的情况，确保每个方法都有足够的区分性，比如通过 HTTP 请求方法（GET, POST 等）或参数来区分。

2. 避免类级别和方法级别的路径冲突

   • 如果您在类级别使用了 @RequestMapping，确保方法级别的 @RequestMapping 不会与之冲突。
   • 例如，如果类级别使用了 @RequestMapping("/api")，那么方法级别的映射应该是 /api/someMethod 而不是简单的 /someMethod。

3. 处理路径变量或参数导致的冲突

   • 如果冲突是由路径变量或参数引起的，考虑使用更具体的路径或参数配置。例如，使用 {id} 路径变量时，确保每个方法的路径变量名称是唯一的。

4. 检查 Spring 配置或组件扫描路径

   • 确保没有重复的 Spring 配置或组件扫描路径导致同一个控制器被多次加载。

示例

假设您有以下两个方法：

@RestController
@RequestMapping("/api")
public class TestController {@GetMapping("/save")public String save() {return "Saved";}@PostMapping("/save")public String changeSave(@RequestBody String data) {return "Changed and Saved: " + data;}
}

在这个例子中，两个方法的路径都是 /api/save，但是请求方法不同（一个是 GET，另一个是 POST）。这是允许的，因为请求方法不同，Spring 可以正确区分这两个方法。

总结

解决 Ambiguous mapping 错误的关键在于确保每个方法的路径映射是唯一的，或者通过请求方法和参数来区分不同的方法。