在springboot中引入参数校验-编程知识

在springboot中引入参数校验

一、概要

一般我们判断前端传过来的参数，需要对某些值进行判断，是否满足条件。

而springboot相关的参数校验注解，可以解决我们这个问题。

二、快速开始

首先，我用的springboot版本是 3.1.5

引入参数校验相关依赖

<!--1.导入JSR303规范--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId></dependency>

定义实体类，并在实体类上加入相关注解。

public class Dept {private Integer id; //ID@NotNullprivate String name; //部门名称private LocalDateTime createTime; //创建时间private LocalDateTime updateTime; //修改时间
}

在controller层给需要校验的参数加上 @ Validated

  @PostMapping("/depts")public Result addDept( @RequestBody @Validated Dept dept){//这里应该判断是否返回成功deptService.addDept(dept);return Result.success();}

此时如果再进行传入参数，如果name为null 就会报错。

三、额外补充

在前面我们谈到了校验的基本用法，但在开发中，我需要对这些异常进行统一处理，并返回符合相应规则的返回值。

因此，需要用到全局异常处理。

让gpt解答一下：

@RestControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(MethodArgumentNotValidException.class)public ResponseEntity<ErrorResponse> handleValidationException(MethodArgumentNotValidException ex) {BindingResult bindingResult = ex.getBindingResult();List<String> errors = bindingResult.getFieldErrors().stream().map(FieldError::getDefaultMessage).collect(Collectors.toList());ErrorResponse response = new ErrorResponse("Validation Failed", errors);return ResponseEntity.badRequest().body(response);}}

bindingResult.getAllErrors(); getFieldErrors（）有什么区别？

@RestController
@RequestMapping("/users")
public class UserController {@PostMappingpublic ResponseEntity<String> createUser(@Validated @RequestBody User user, BindingResult result) {if (result.hasErrors()) {// 获取字段错误列表List<FieldError> fieldErrors = result.getFieldErrors();// 遍历字段错误列表，输出错误信息for (FieldError error : fieldErrors) {String fieldName = error.getField();String errorMessage = error.getDefaultMessage();System.out.println("字段名：" + fieldName + "，错误信息：" + errorMessage);}return ResponseEntity.badRequest().body("参数校验失败");}// 校验通过，处理创建用户的逻辑return ResponseEntity.ok("用户创建成功");}}