Spring RestController中带@RequestParam的GET请求映射冲突解决

嘿，这个问题我之前也碰到过，其实核心原因是Spring MVC会忽略URL末尾的斜杠，所以你新增的@GetMapping("/")和原来的@GetMapping（无路径）最终都映射到了同一个路径/customers（或者/customers/，两者在Spring眼里是等价的），导致容器无法区分该调用哪个方法，自然就抛出冲突异常了。

给你几个靠谱的解决方案：

方案1：利用请求参数自动匹配方法 #

不需要给getByEmail指定额外路径，直接用@GetMapping，让Spring根据请求中是否存在email参数来自动匹配对应的方法：

@RestController
@RequestMapping(value = UserRestController.REST_URL, produces = MediaType.APPLICATION_JSON_VALUE)
public class UserRestController {
    static final String REST_URL = "/customers";

    // 处理无参数的GET请求：/customers
    @GetMapping
    public List<User> getAll() {
        return service.getAll();
    }

    // 处理带email参数的GET请求：/customers?email=xxx
    @GetMapping
    public User getByEmail(@RequestParam("email") String email) {
        return super.getByEmail(email);
    }
}

Spring会智能判断：当请求携带email参数时，会调用getByEmail方法；没有参数时则调用getAll，完美避开冲突。

方案2：给查询方法指定独立路径 #

如果觉得参数匹配不够直观，也可以给getByEmail指定一个明确的子路径，让两个方法的映射路径完全区分开：

@RestController
@RequestMapping(value = UserRestController.REST_URL, produces = MediaType.APPLICATION_JSON_VALUE)
public class UserRestController {
    static final String REST_URL = "/customers";

    @GetMapping
    public List<User> getAll() {
        return service.getAll();
    }

    // 处理GET请求：/customers/by-email?email=xxx
    @GetMapping("/by-email")
    public User getByEmail(@RequestParam("email") String email) {
        return super.getByEmail(email);
    }
}

这种方式更清晰，后续如果要加其他查询条件（比如按用户名），也可以用类似的/by-username路径，代码可读性更高。

方案3：在单个方法中处理两种场景（不推荐） #

如果非要把逻辑放在一个方法里，可以给email参数设置required = false，然后根据参数是否为空来分支处理：

@GetMapping
public Object getUsers(@RequestParam(value = "email", required = false) String email) {
    if (email != null) {
        return super.getByEmail(email);
    } else {
        return service.getAll();
    }
}

不过这种方法会让方法职责不单一，返回类型也只能用Object或者通用父类，后续维护起来比较麻烦，所以不太推荐。

内容的提问来源于stack exchange，提问作者Jelly