Spring Boot PathVariable空值验证问题：isBlank/isEmpty不生效

问题场景 #

需要在Spring Boot控制器中验证PathVariable不可为null，当用户访问http://localhost:8080/api/details/expired-timeoff/（路径末尾无参数）时，要求触发自定义的InvalidArgumentException并返回自定义错误信息，而非默认的Whitelabel 404页面。

当前代码存在的问题：访问带参数的路径（如/expired-timeoff/a）时能正常触发自定义异常，但访问无参数的/expired-timeoff/时，直接返回404，无法进入目标方法执行校验逻辑。

现有控制器代码 #

@RestController
@CrossOrigin("*")
@RequestMapping("/api/details")
public class DetailsController {
    @Autowired
    DetailsService detailsService;
    
    @Autowired
    OvertimeService overtimeService;
        
    @GetMapping("/expired-timeoff/{empNo}")
    public List<Details> getExpiredTimeOffBalancesByUser(@PathVariable String empNo) {

        if (empNo.isBlank() || empNo.isEmpty() || empNo.trim().equals("a")) {
            throw new InvalidArgumentException("Error Message");
        }
        return detailsService.findExpiredTimeOffBalancesByCreatedBy(empNo);
    }
}

全局异常处理器代码 #

package com.sicmsb.timeofftracker.controller.Advice;

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.client.HttpClientErrorException;

import com.sicmsb.timeofftracker.exceptions.ResourceNotFoundException;
import com.sicmsb.timeofftracker.exceptions.InvalidArgumentException;

@RestControllerAdvice
public class RequestExceptionHandler {
    @ResponseStatus(HttpStatus.NOT_FOUND) //404
    @ExceptionHandler(ResourceNotFoundException.class)
    public String notFound(Exception e) {
        return e.getMessage();
    }
    
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) //500
    @ExceptionHandler({RuntimeException.class, Exception.class})
    public String internalError(Exception e) {
        e.printStackTrace();
        return "error/internal_error";
    }
    
    @ResponseStatus(HttpStatus.BAD_REQUEST) //400
    @ExceptionHandler({InvalidArgumentException.class})
    public String badRequest(Exception e) {
        return e.getMessage();
    }
}

尝试过新增无参数的GetMapping处理该情况，但希望用同一个方法覆盖所有场景，之前用StringUtils判断和empNo==null均无效，寻求优化方案。

优化方案 #

方案1：配置路径匹配+可选PathVariable #

Spring Boot默认路径匹配规则下，/expired-timeoff/不会匹配/expired-timeoff/{empNo}，需先调整配置让尾部斜杠能匹配到带PathVariable的路径，再将PathVariable设为可选。

1. 配置路径匹配规则
   在application.properties中添加：

spring.mvc.pathmatch.matching-strategy=ant_path_matcher
spring.mvc.pathmatch.use-trailing-slash-match=true

或通过配置类实现：

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.setUseTrailingSlashMatch(true);
    }
}

2. 修改控制器方法
   将@PathVariable的required属性设为false，并增加null校验：

@GetMapping("/expired-timeoff/{empNo}")
public List<Details> getExpiredTimeOffBalancesByUser(@PathVariable(required = false) String empNo) {
    if (empNo == null || empNo.isBlank()) {
        throw new InvalidArgumentException("员工编号不能为空");
    }
    if (empNo.trim().equals("a")) {
        throw new InvalidArgumentException("无效的员工编号");
    }
    return detailsService.findExpiredTimeOffBalancesByCreatedBy(empNo);
}

此时访问/expired-timeoff/会进入该方法，empNo为null，触发自定义异常。

方案2：全局捕获404异常并转换 #

若不想调整路径匹配规则，可在全局异常处理器中捕获NoHandlerFoundException，针对特定路径返回自定义错误信息。

1. 开启404异常抛出
   在application.properties中添加：

spring.mvc.throw-exception-if-no-handler-found=true
spring.web.resources.add-mappings=false

2. 修改全局异常处理器
   添加NoHandlerFoundException的处理逻辑：

@RestControllerAdvice
public class RequestExceptionHandler {
    // 原有异常处理器...
    
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(NoHandlerFoundException.class)
    public String handleMissingPathVariable(NoHandlerFoundException e) {
        // 判断是否是目标路径，避免所有404返回相同信息
        if (e.getRequestURL().endsWith("/expired-timeoff/")) {
            return "员工编号不能为空";
        }
        return "请求路径不存在";
    }
}

方案3：映射多个路径到同一个方法 #

直接让目标方法同时匹配带参数和无参数的路径，无需额外配置：

@GetMapping({"/expired-timeoff/{empNo}", "/expired-timeoff/"})
public List<Details> getExpiredTimeOffBalancesByUser(@PathVariable(required = false) String empNo) {
    if (empNo == null || empNo.isBlank()) {
        throw new InvalidArgumentException("员工编号不能为空");
    }
    if (empNo.trim().equals("a")) {
        throw new InvalidArgumentException("无效的员工编号");
    }
    return detailsService.findExpiredTimeOffBalancesByCreatedBy(empNo);
}

方案对比 #

• 方案1：符合RESTful路径规范，适合全局需要支持尾部斜杠匹配的场景
• 方案2：无需修改控制器代码，但需区分不同404场景，适合仅个别路径需要处理的情况
• 方案3：实现最简单，无需额外配置，适合单个方法的场景

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