Spring Boot 2中@PathVariable路径参数校验的正确实现方式咨询

结论 #

你当前的实现可以正常运行，但不属于符合设计规范的通用实现，存在设计冗余、不符合REST接口设计原则的问题。

存在的问题 #

• 按照REST规范，/employee对应员工集合资源，/employee/{Id}对应单个员工资源，本身是两个完全不同的资源定位，将两个路径绑定到同一个查询单个员工的接口上，本身就不符合资源定位的设计逻辑。
• 你当前的实现属于强行让本不匹配单个查询接口的/employee请求落到该接口上，再依赖框架抛出异常再捕获返回错误，属于绕路实现，平白增加了不必要的异常处理流程，代码可读性和运行效率都有冗余。

规范实现方案 #

可选两种常用实现，按需选择即可：

1. 走404全局处理逻辑
   直接保留原有接口定义即可，不需要新增/employee路径映射：

@GetMapping(value="/employee/{Id}")
public EmployeeDTO getEmployeeDetails(@PathVariable String Id) {
    ...
}

Spring Boot默认会对没有匹配到处理器的路径返回404，你只需要在@ControllerAdvice标注的全局异常处理器中捕获NoHandlerFoundException，判断请求路径前缀为/employee时返回“请求中缺少Id”的自定义提示即可。
2. 接口内直接校验
将路径参数设为非必填，在接口内直接做判空处理，逻辑更直观：

@GetMapping(value={"/employee", "/employee/{Id}"})
public EmployeeDTO getEmployeeDetails(@PathVariable(required = false) String Id) {
    if (Id == null || Id.isBlank()) {
        // 直接抛出业务异常或者返回自定义错误响应
        throw new IllegalArgumentException("请求中缺少Id");
    }
    ...
}

这种方式不需要依赖框架的异常捕获逻辑，后续维护时可以直接在接口代码里看到校验逻辑，可读性更高。

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