依賴添加

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

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

驗(yàn)證使用對象接收參數(shù)的情況

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;}

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

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

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

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

校驗(yàn)使用單個參數(shù)接受的情況

@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注解，之后在方法中需要校驗(yàn)的參數(shù)前加上對應(yīng)的校驗(yàn)注解進(jìn)行校驗(yàn)。

對校驗(yàn)產(chǎn)生的異常的捕獲

定義全局異常處理類并用@ControllerAdvice標(biāo)注，由于對象和單個參數(shù)因校驗(yàn)產(chǎn)生的異常類型不同，因此需要分別處理。

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

/** * 捕獲303對于body中的對象字段校驗(yàn) * @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);}

對于使用單個參數(shù)接受前端請求，因校驗(yàn)產(chǎn)生的異常類為ConstraintViolationException，示例方法如下：

/** * 捕獲303對于request param單個參數(shù)的校驗(yàn) * @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);}

到此這篇關(guān)于SpringBoot使用jsr303校驗(yàn)的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)SpringBoot jsr303校驗(yàn)內(nèi)容請搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)！