为互斥请求参数设计API的更好方法是什么

Question

当请求参数互斥时，在@Controller方法上设计API的更好方法是什么？

假设有一个API来提供与请求参数匹配的用户列表。

代码为：

public ResponseEntity getList(@RequestParam(required = false) Integer userId,
@RequestParam(required = false) User.Type userType,
@RequestParam(required = false) Integer age) {
List<User> userList = null;
if (userId != null) {
//logic
userList = getUserByUserId()
} else if (userType != null) {
//logic
userList = getUserByType()
} else if (age != null) {
//logic
userList = getListByAge()
} else {
userList = getAllWithoutCondition();
}
return ResponseEntity.ok(userList);
}

要点如下：

用户不能使用多个请求参数进行查询。只有一个请求参数或没有请求参数是有效的(请求中应该只存在userId、age或type中的一个(。

对于这种情况，我不确定设计API的更好方法是什么。你能给我一些建议吗？

Answer 1

我喜欢那些家伙在评论中建议的方法：

@RequestMapping(value = "...", params = {"!userType", "!userAge"})
public ResponseEntity<List<User>> getListByUserId(@RequestParam Integer userId) { ... }
// similarly, define two more

在您开始管理每个端点的限制之前，它看起来稳健且可行。它看起来既乏味又难以维护。此外，我不确定不带params的端点会有什么反应。它会被调用还是被其他方法遮蔽？

与其写限制，我建议引入条件——每个端点的要求。它可能是下一种格式的Map<String, Function<String, List<User>>>：

<param name> -> <action to get a list>

我还建议您将所有传入的请求参数收集到一个单独的Map<String, String>中，以按大小进行验证。

public class Controller {
private Map<String, Function<String, List<User>>> handlers = new HashMap<>();
{
handlers.put("userId", id -> getUsersById(Integer.valueOf(id)));
handlers.put("userType", type -> getUsersByType(User.Type.valueOf(type)));
handlers.put("userAge", age -> getUsersByAge(Integer.valueOf(age)));
}
@RequestMapping("...")
public ResponseEntity<List<User>> getList(@RequestParam Map<String, String> params) {
if (params.size() > 1) {
return ResponseEntity.unprocessableEntity().build();
}
if (params.size() == 0) {
return ResponseEntity.ok(getAllWithoutCondition());
}
Map.Entry<String, String> paramEntry = params.entrySet().iterator().next();
return ResponseEntity.ok(handlers.get(paramEntry.getKey()).apply(paramEntry.getValue()));
}
private List<User> getAllWithoutCondition() { ... }
private List<User> getUsersById(Integer id) { ... }
private List<User> getUsersByType(User.Type type) { ... }
private List<User> getUsersByAge(Integer age) { ... }
}