springboot web 自定义参数验证
当需要前端必传某些参数的时候,可在代码里面校验,但是这样每一个方法都需要自己写代码验证。我们可以使用spring提供的@Validate
1、单一参数验证
接口是单一参数写在方法上时:
@GetMapping("/user") public AjaxResult<User> getUser(@RequestParam String username){ System.err.println("username:"+username); User user = userService.findByUsername(username); return AjaxResult.success(user); }
username 是要求必传的,直接请求接口,不传username参数,服务端会报错
但是,传空字符串时,就会通过验证:
在类上加@Validate,参数加@NotBlank验证:
@RestControllerAdvice @RestController @Validated @RequestMapping("/users") public class UserController { @Resource private IUserService userService; @GetMapping("/user") public AjaxResult<User> getUser(@NotBlank(message = "用户名不能为空") @RequestParam String username){ System.err.println("username:"+username); User user = userService.findByUsername(username); return AjaxResult.success(user); }
}
配合全局异常处理:
@RestControllerAdvice public class CommonExceptionHandler { @ExceptionHandler(value = {ConstraintViolationException.class}) public AjaxResult<?> exceptionHandler(ConstraintViolationException e){ return AjaxResult.fail(e.getMessage()); } @ExceptionHandler(value = {MethodArgumentNotValidException.class}) public AjaxResult<?> exceptionHandler(MethodArgumentNotValidException e){ return AjaxResult.fail(e.getBindingResult().getFieldError().getDefaultMessage()); } }
2、多个参数验证
@Data public class UserEditRequest implements Serializable { @NotBlank(message = "username不能为空") private String username; @NotBlank(message = "密码不能为空") private String password; }
@PutMapping
public AjaxResult<Boolean> save(@Validated @RequestBody UserEditRequest request){
System.err.println(request);
return AjaxResult.success(true);
}
3、一些注解作用
@NotNull:不能为null
@NotEmpty:不能为null且字符串长度 >0,集合大小>0
@NotBlank:不能为null,且使用trim()后,字符串长度>0
。。。
不想打了。从别人那截个图
注意:有的限制只是限制它的值,并没有限制不能为null,为null时也可以过
比如:在传了marriage的情况下,只能传false、"false"、0。要么不传
@AssertFalse(message = "只能已婚的参加") private Boolean marriage;