Springboot实现参数校验

导入依赖

java"><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId>
</dependency>

实体类中加上相应注解

java">
public class User {// 用户名@NotBlank(message = "用户名不能为空") // 注解确保用户名不为空private String username;// 性别@NotNull(message = "性别不能为空") // 注解确保性别不为空private Integer sex;// 年龄@NotNull(message = "年龄不能为空")@Min(value = 18, message = "年龄必须大于或等于 18")  // 注解确保年龄大于等于 18@Max(value = 100, message = "年龄必须小于或等于 100")  // 注解确保年龄小于等于 100private Integer age;// 邮箱@NotBlank(message = "邮箱不能为空")@Email(message = "邮箱格式不正确")  // 注解确保邮箱格式正确private String email;
}

Controller 参数校验

针对每个字段的校验注解添加完成后，还需要在 controller 层进行捕获(@Validated)，并将错误信息返回。编辑 TestController 类，代码如下：

java">@RestController
@Slf4j
public class TestController {@PostMapping("/test")@ApiOperationLog(description = "测试接口")public ResponseEntity<String> test(@RequestBody @Validated User user, BindingResult bindingResult) {// 是否存在校验错误if (bindingResult.hasErrors()) {// 获取校验不通过字段的提示信息String errorMsg = bindingResult.getFieldErrors().stream().map(FieldError::getDefaultMessage).collect(Collectors.joining(", "));return ResponseEntity.badRequest().body(errorMsg);}// 返参return ResponseEntity.ok("参数没有任何问题");}}

全局异常处理器捕获该异常完成最佳实践

java">    /*** 捕获参数校验异常* @return*/@ExceptionHandler({ MethodArgumentNotValidException.class })@ResponseBodypublic Response<Object> handleMethodArgumentNotValidException(HttpServletRequest request, MethodArgumentNotValidException e) {// 参数错误异常码String errorCode = ResponseCodeEnum.PARAM_NOT_VALID.getErrorCode();// 获取 BindingResultBindingResult bindingResult = e.getBindingResult();StringBuilder sb = new StringBuilder();// 获取校验不通过的字段，并组合错误信息，格式为： email 邮箱格式不正确, 当前值: '123124qq.com';Optional.ofNullable(bindingResult.getFieldErrors()).ifPresent(errors -> {errors.forEach(error ->sb.append(error.getField()).append(" ").append(error.getDefaultMessage()).append(", 当前值: '").append(error.getRejectedValue()).append("'; "));});// 错误信息String errorMessage = sb.toString();log.warn("{} request error, errorCode: {}, errorMessage: {}", request.getRequestURI(), errorCode, errorMessage);return Response.fail(errorCode, errorMessage);}

状态码

java"> PARAM_NOT_VALID("10001", "参数错误"),

检验不通过的异常会自动捕获并返回给前端