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

在开发 spring Boot 应用程序时，经常需要从 http 请求中获取参数，并进行相应的处理。为了保证程序的稳定性和安全性，对这些参数进行校验是至关重要的。本文将介绍如何利用 spring boot 的参数校验机制，在 RequestParam 中禁止接收空字符串 “” 或仅包含空白字符的字符串。

使用 Bean Validation 进行参数校验

Spring Boot 提供了对 JSR-303 Bean Validation 的支持，可以方便地对请求参数进行校验。要实现禁止 RequestParam 接收空字符串或仅包含空白字符的字符串，可以结合使用 @Validated 注解、@NotEmpty 和 @NotBlank 注解。

具体步骤如下：

1. 添加 @Validated 注解: 在 Controller 类上添加 @Validated 注解，以启用参数校验功能。

2. 使用 @NotEmpty 和 @NotBlank 注解: 在 RequestParam 参数上使用 @NotEmpty 和 @NotBlank 注解。

   • @NotEmpty：用于校验集合或字符串是否为空。对于字符串，它会检查字符串是否为 NULL 或长度是否为 0。
   • @NotBlank：用于校验字符串是否为空白字符串。它会检查字符串是否为 null、长度是否为 0，以及是否只包含空白字符。

示例代码：

import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController;  import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotBlank; import java.util.List;  @RestController @Validated public class TestController {      @GetMapping("/test")     public List<String> getTestStates(@RequestParam @NotEmpty List<@NotBlank String> states) {         // 处理 states 参数         return states;     } }

代码解释：

• @RestController：声明这是一个 REST Controller。
• @Validated：启用参数校验。
• @GetMapping(“/test”)：映射 /test 路径的 GET 请求。
• @RequestParam @NotEmpty List states：声明 states 参数是一个 RequestParam，并且是一个字符串列表。 @NotEmpty 确保列表不能为空，@NotBlank 确保列表中的每个字符串不能为空白字符串。

测试用例：

• /test?states=state1,state2：有效请求，states 参数包含两个非空字符串。
• /test?states=：无效请求，states 参数为空字符串，违反 @NotEmpty 约束。
• /test?states= ,state2：无效请求，states 参数包含一个空白字符串，违反 @NotBlank 约束。

注意事项：

• 确保项目中已添加 spring-boot-starter-validation 依赖。
• 当参数校验失败时，Spring Boot 会抛出 ConstraintViolationException 异常。需要配置全局异常处理，以便将该异常转换为合适的 HTTP 响应。
• 可以自定义校验消息，以提供更友好的错误提示。

总结：

通过使用 @Validated 注解和 JSR-303 Bean Validation 注解，可以方便地对 Spring Boot 的 RequestParam 参数进行校验，禁止接收空字符串或仅包含空白字符的字符串。这种方法简单易用，无需额外的代码逻辑，即可提升 API 的健壮性和安全性。 建议在所有需要参数校验的 API 接口中应用此方法，以确保程序的稳定性和安全性。