Spring 控制器 RequestMapping PathVariable 中 URL 的零长度部分破坏了解析

Question

我正在尝试使应用程序的 REST API 更多 RESTful，感觉我没有按照预期的方式使用 Spring RequestMappings。

我有一个用于读取的 GET 端点：

@RequestMapping(value = "thing/{thingName}",
        method = RequestMethod.GET,
        produces = MediaType.APPLICATION_JSON_VALUE)
@ResponseBody
public String getThing(
        @PathVariable(value = "thingName", required = false)
                String thingName,
        @RequestParam(value = "findByComponent", required = false)
                String findByComponentQuery,
        @AuthenticationPrincipal User user) {
...

要更 restful，我希望此端点同时执行这两项操作：

GET /thing/{thingName} returns 具有该名称的单个事物
使用查询参数获取 /thing 或 /thing/ returns 事物列表

所以在我的控制器中，我可以测试 {thingName} 是否为 null 或零长度，如果是，检查已知查询名称的查询参数。

然而，使用 http://localhost:8080/thing/?findByComponent=component123 returns 来自 Spring 的 404 调用此日志记录：

12:45:18.485 PageNotFound : No mapping found for HTTP request with URI [/thing/] in DispatcherServlet with name 'dispatcher' : WARN : XNIO-1 task-3 : org.springframework.web.servlet.DispatcherServlet

Answer 1

Spring 不允许将路径变量 ({thingName}) 映射到空的 String。实际上，这意味着 URL /thing/?findByComponent=component123 确实 not 映射到带有空 {thingName} 的 thing/{thingName}，而是它期望thing 会有一些映射。由于没有映射到路径 thing（没有路径变量）的端点，因此返回 404 错误。

要解决此问题，您可以将此单个端点拆分为两个单独的端点：

@RequestMapping(value = "thing/{thingName}",
        method = RequestMethod.GET,
        produces = MediaType.APPLICATION_JSON_VALUE)
@ResponseBody
public String getThing(
        @PathVariable(value = "thingName") String thingName,
        @AuthenticationPrincipal User user) {
    // ...
}

@RequestMapping(value = "thing",
        method = RequestMethod.GET,
        produces = MediaType.APPLICATION_JSON_VALUE)
@ResponseBody
public String getThings(,
        @RequestParam(value = "findByComponent", required = false) String findByComponentQuery,
        @AuthenticationPrincipal User user) {
    // ...
}

有关详细信息，请参阅 With Spring 3.0, can I make an optional path variable?。

required=false 标志允许两种类型的请求：

/thing
/thing/<some_value>

严格来说，在 URL 末尾包含斜杠（即 /thing/）意味着决定包含路径变量的值，但 none 提供。在 REST API 的上下文中，/thing 和 /thing/ 是两个不同的端点，其中后者表示期望尾部斜线后的值。

不必创建三个单独的请求映射（上述每种情况一个）的解决方法是将控制器的 @RequestMapping 值设置为基本路径，然后有一个 "" 和"/{thingName} 请求两个端点的映射：

@RestController
@RequestMapping("thing")
public class ThingController {

    @RequestMapping(value = "/{thingName}",
            method = RequestMethod.GET,
            produces = MediaType.APPLICATION_JSON_VALUE)
    @ResponseBody
    public String getThing(
            @PathVariable(value = "thingName") String thingName) {
        return "foo";
    }

    @RequestMapping(value = "",
            method = RequestMethod.GET,
            produces = MediaType.APPLICATION_JSON_VALUE)
    @ResponseBody
    public String getThings(
            @RequestParam(value = "findByComponent", required = false) String findByComponentQuery) {
        return "bar";
    }
}

在这种情况下，将发生以下映射：

/thing: getThings
/thing/: getThings
/thing/foo: getThing

此解决方法的示例，包括测试用例，可以是 found here。

Spring 控制器 RequestMapping PathVariable 中 URL 的零长度部分破坏了解析

Zero length part of URL in Spring controller RequestMapping PathVariable breaks resolution

java

rest

spring-web