依賴添加

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

一些較老版本的SpringBoot需要添加相關依賴，我使用的2.1.4發行版不用這個操作。

驗證使用對象接收參數的情況

public class PointDeductSetRequest { private Long id; @NotBlank(message = '租戶id為空') private String tenantId; private Integer status; @NotNull private Integer pointValue; @NotNull private Integer deductValue; @NotBlank(message = '操作員id為空') private String operator;}

首先在需要驗證的對象的對應字段上方加上校驗注解，以下為一些常用注解：

@Null 限制只能為null @NotNull 限制必須不為null @AssertFalse 限制必須為false @AssertTrue 限制必須為true @DecimalMax(value) 限制必須為一個不大于指定值的數字 @DecimalMin(value) 限制必須為一個不小于指定值的數字 @Digits(integer,fraction) 限制必須為一個小數，且整數部分的位數不能超過integer，小數部分的位數不能超過fraction @Future 限制必須是一個將來的日期 @Max(value) 限制必須為一個不大于指定值的數字 @Min(value) 限制必須為一個不小于指定值的數字 @Past 限制必須是一個過去的日期 @Pattern(value) 限制必須符合指定的正則表達式 @Size(max,min) 限制字符長度必須在min到max之間 @Past 驗證注解的元素值（日期類型）比當前時間早 @NotEmpty 驗證注解的元素值不為null且不為空（字符串長度不為0、集合大小不為0） @NotBlank 驗證注解的元素值不為空（不為null、去除首位空格后長度為0），不同于@NotEmpty，@NotBlank只應用于字符串且在比較時會去除字符串的空格 @Email 驗證注解的元素值是Email，也可以通過正則表達式和flag指定自定義的email格式

@RequestMapping(value = '/deduct', method = RequestMethod.POST)public BusinessResponse setPointDeduct(@RequestBody @Valid PointDeductSetRequest request){ pointDeductService.setPointDeductRule(request); return new BusinessResponse(ResponseEnum.OK);}

之后在controller方法的對象參數前加@Valid注解。

校驗使用單個參數接受的情況

@RequestMapping(value = '/deduct', method = RequestMethod.GET)public PageResponse<TPointDeduct> getPointDeductList(@RequestParam(value = 'page', required = false) Integer page, @RequestParam(value = 'pageSize', required = false) Integer pageSize, @RequestParam(value = 'tenantId', required = false) @NotBlank(message = '租戶id為空') String tenantId, @RequestParam(value = 'status', required = false) Integer status){ PageResponse<TPointDeduct> response = pointDeductService.getPointDeductList(page, pageSize, tenantId, status); response.setCodeMsg(ResponseEnum.OK); return response;}

首先需要在controller類上加@Validated注解，之后在方法中需要校驗的參數前加上對應的校驗注解進行校驗。

對校驗產生的異常的捕獲

定義全局異常處理類并用@ControllerAdvice標注，由于對象和單個參數因校驗產生的異常類型不同，因此需要分別處理。

對于對象作為接收前端請求的情況，因校驗產生的異常類型為MethodArgumentNotValidException，示例方法如下：

/** * 捕獲303對于body中的對象字段校驗 * @param e * @param request * @return */@ExceptionHandler(MethodArgumentNotValidException.class)@ResponseBodyResponseEntity<Object> handleMethodArgumentNotValidException(MethodArgumentNotValidException e, HttpServletRequest request){ List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors(); if (fieldErrors != null && !fieldErrors.isEmpty()){ String message = fieldErrors.get(0).getDefaultMessage(); log.error(message, e); } HttpStatus httpStatus = HttpStatus.INTERNAL_SERVER_ERROR; HttpHeaders headers = new HttpHeaders(); Response response = new Response(); response.setCode(ResponseEnum.FORMAT_ERROR.code()); response.setMessage(ResponseEnum.FORMAT_ERROR.message()); return new ResponseEntity<>(response, headers, httpStatus);}

對于使用單個參數接受前端請求，因校驗產生的異常類為ConstraintViolationException，示例方法如下：

/** * 捕獲303對于request param單個參數的校驗 * @param e * @param request * @return */@ExceptionHandler(ConstraintViolationException.class)@ResponseBodyResponseEntity<Object> handleConstraintViolationException(ConstraintViolationException e, HttpServletRequest request){ HttpStatus httpStatus = HttpStatus.INTERNAL_SERVER_ERROR; HttpHeaders headers = new HttpHeaders(); Response response = new Response(); response.setCode(ResponseEnum.FORMAT_ERROR.code()); response.setMessage(ResponseEnum.FORMAT_ERROR.message()); return new ResponseEntity<>(response, headers, httpStatus);}

到此這篇關于SpringBoot使用jsr303校驗的實現的文章就介紹到這了,更多相關SpringBoot jsr303校驗內容請搜索好吧啦網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持好吧啦網！