Spring RequestParam 参数校验：禁止空字符串与空白字符

本文介绍了如何利用 Spring Validation 框架，在 Controller 层对 @RequestParam 注解修饰的请求参数进行校验，特别是禁止接收空字符串（""）或只包含空白字符的字符串。通过添加 @Validated 注解和相应的校验注解，可以有效防止非法参数进入业务逻辑，提高代码健壮性。

使用 Spring Validation 校验 RequestParam

Spring Validation 提供了一套强大的机制来校验请求参数，可以有效避免无效数据进入业务逻辑。对于 @RequestParam 修饰的参数，我们可以通过以下步骤进行校验：

1. 开启校验： 在 Controller 类上添加 @Validated 注解，启用 Spring Validation 功能。
2. 添加校验注解： 在 @RequestParam 注解修饰的参数上添加相应的校验注解。

例如，要禁止接收空字符串或只包含空白字符的字符串列表，可以使用 @NotEmpty 和 @NotBlank 注解：

@RestController
@Validated
public class TestController {
    @GetMapping("/test")
    public List<StatesInfoVO> getTestStates(@RequestParam @NotEmpty List<@NotBlank String> states) {
        //...
    }
}

注解说明：

• @Validated: 用于类级别，启用 Spring Validation。
• @NotEmpty: 用于集合类型，确保集合不为 null 且不为空（size > 0）。
• @NotBlank: 用于字符串类型，确保字符串不为 null 且去除首尾空格后长度大于 0。

请求示例与预期结果：

怪兽AI数字人

数字人短视频创作，数字人直播，实时驱动数字人

44

查看详情

• /test?states=""：将会抛出 ConstraintViolationException，提示 states 不能为空。
• /test?states=" "：将会抛出 ConstraintViolationException，提示 states 中的元素不能为空白字符。
• /test?states=state1,state2：校验通过，正常执行业务逻辑。

注意事项：

• 确保项目中已经引入 spring-boot-starter-validation 依赖。
• @Validated 注解必须添加到 Controller 类上才能生效。
• 校验失败时，Spring 会抛出 ConstraintViolationException 异常，需要全局异常处理机制来捕获并处理该异常，例如返回友好的错误信息给客户端。

全局异常处理示例：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(ConstraintViolationException.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public Map<String, String> handleConstraintViolationException(ConstraintViolationException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getConstraintViolations().forEach(violation -> {
            errors.put(violation.getPropertyPath().toString(), violation.getMessage());
        });
        return errors;
    }
}

总结：

通过使用 Spring Validation 框架，我们可以方便地对 @RequestParam 注解修饰的请求参数进行校验，特别是禁止接收空字符串或只包含空白字符的字符串。这有助于提高代码的健壮性和安全性，防止无效数据进入业务逻辑。结合全局异常处理机制，可以更好地处理校验失败的情况，提升用户体验。

以上就是Spring RequestParam 参数校验：禁止空字符串与空白字符的详细内容，更多请关注php中文网其它相关文章！