使用 Spring 处理 REST 应用程序中映射的不明确的处理程序方法

Question

我尝试使用如下代码：

@RequestMapping(value = "/{id}", method = RequestMethod.GET)
public Brand getBrand(@PathVariable Integer id) {
    return brandService.getOne(id);
}
@RequestMapping(value = "/{name}", method = RequestMethod.GET)
public List<Brand> getBrand(@PathVariable String name) {
    return brandService.getSome(name);
}

但是我得到了这样的错误，我该怎么办？

java.lang.IllegalStateException: Ambiguous handler methods mapped for HTTP path 'http://localhost:8080/api/brand/1': {public java.util.List com.zangland.controller.BrandController.getBrand(java.lang.String), public com.zangland.entity.Brand com.zangland.controller.BrandController.getBrand(java.lang.Integer)}
at org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.lookupHandlerMethod(AbstractHandlerMethodMapping.java:375) ~[spring-webmvc-4.2.4.RELEASE.jar:4.2.4.RELEASE]

Answer 1

Spring 无法区分请求GET http://localhost:8080/api/brand/1是由getBrand(Integer)还是由getBrand(String)处理，因为您的映射不明确。

尝试对getBrand(String)方法使用查询参数。这似乎更合适，因为您正在执行查询：

@RequestMapping(value = "/{id}", method = RequestMethod.GET)
public Brand getBrand(@PathVariable Integer id) {
    return brandService.getOne(id);
}
@RequestMapping(method = RequestMethod.GET)
public List<Brand> getBrands(@RequestParam(value="name") String name) {
    return brandService.getSome(name);
}

使用上述方法：

• 像GET http://localhost:8080/api/brand/1这样的请求将由getBrand(Integer)处理。
• 像GET http://localhost:8080/api/brand?name=nike这样的请求将由getBrand(String)处理。

<小时 />

只是一个提示：作为一种常见的做法，首选复数名词作为资源集合。因此，与其使用 /brand，不如使用 /brands 。

Answer 2

@RequestMapping(value = "/{id}", method = RequestMethod.GET)
public Brand getBrand(@PathVariable Integer id) {
    return brandService.getOne(id);
}
@RequestMapping(value = "/{name}", method = RequestMethod.GET)
public List<Brand> getBrand(@PathVariable String name) {
    return brandService.getSome(name);
}

当您运行应用程序并访问您尝试编码的端点时，您会意识到以下内容，"http://localhost:8086/brand/1"和"http://localhost:8086/brand/FooBar"对应于相同的 URL 格式（可以描述为协议+端点+'品牌'+）。因此，SpringBoot 本质上是混淆了它是否应该使用 String 数据类型或 Integer 调用函数 'getBrand'。因此，为了解决这个问题，我建议您使用 @cassiomolin 提到的查询参数，或者为两个调用提供单独的路径。这可能违反了 REST 原则，但假设您只是在执行示例应用程序，这是另一种解决方法。

@RequestMapping(value = "/id/{id}", method = RequestMethod.GET)
public Brand getBrand(@PathVariable Integer id) {
    return brandService.getOne(id);
}
@RequestMapping(value = "/name/{name}", method = RequestMethod.GET)
public List<Brand> getBrand(@PathVariable String name) {
    return brandService.getSome(name);
}

这对我有用。