我們有這樣一個(gè)需求，想要校驗(yàn)一個(gè)int類型的變量，校驗(yàn)它的值必須為我們所指定的值，且在修改狀態(tài)分組時(shí)生效。

? ?@ListValue(vals = {0, 1}, groups = {UpdateStatusGroup.class})

1. 導(dǎo)入依賴

<dependency><groupId>javax.validation</groupId><artifactId>validation-api</artifactId><version>2.0.1.Final</version></dependency>

2. 自定義注解類

@Documented @Constraint(//可以指定多個(gè)不同的校驗(yàn)器，適配不同類型的數(shù)據(jù)校驗(yàn)validatedBy = {ListValueConstraintValidator.class} ) @Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE}) @Retention(RetentionPolicy.RUNTIME) public @interface ListValue {String message() default "{com.yfy.study.common.valid.ListValue.message}"; ?Class<?>[] groups() default {}; ?Class<? extends Payload>[] payload() default {}; ?int[] vals() default {}; }

3. 自定義校驗(yàn)器

public class ListValueConstraintValidator implements ConstraintValidator<ListValue, Integer> {private Set<Integer> set = new HashSet<Integer>(); ?/*** 初始化方法** @param constraintAnnotation*/public void initialize(ListValue constraintAnnotation) {int[] vals = constraintAnnotation.vals();for (int val : vals) {set.add(val);}} ?/*** 判斷是否校驗(yàn)成功** @param value ? ? ? ? ? ? ? ? ? ? 需要校驗(yàn)的值* @param constraintValidatorContext* @return*/public boolean isValid(Integer value, ConstraintValidatorContext constraintValidatorContext) {return set.contains(value);} }

4. 配置默認(rèn)提示

創(chuàng)建ValidationMessages.properties

com.yfy.study.common.valid.ListValue.message=必須提交指定的值

5. 創(chuàng)建分組接口

我們的實(shí)體類有三種校驗(yàn)場(chǎng)景，新增、修改和修改狀態(tài)

public interface AddGroup { } ? public interface UpdateGroup { } ? public interface UpdateStatusGroup { }

6.測(cè)試

我們的實(shí)體類如下

@Data @TableName("pms_brand") public class BrandEntity implements Serializable {private static final long serialVersionUID = 1L; ?/*** 品牌id*/@TableId@Null(message = "新增不能指定品牌id", groups = {AddGroup.class})@NotNull(message = "修改必須指定品牌id", groups = {UpdateGroup.class})private Long brandId;/*** 品牌名*/@NotBlank(message = "品牌名不能為空", groups = {AddGroup.class, UpdateGroup.class})private String name;/*** 品牌logo地址*/@URL(message = "logo必須是一個(gè)合法的url地址", groups = {AddGroup.class, UpdateGroup.class})@NotEmpty(message = "url不能為空", groups = {AddGroup.class})private String logo;/*** 介紹*/private String descript;/*** 顯示狀態(tài)[0-不顯示；1-顯示]*/@ListValue(vals = {0, 1}, groups = {UpdateStatusGroup.class})@NotNull(message = "狀態(tài)不能為空",groups = {UpdateStatusGroup.class})private Integer showStatus;/*** 檢索首字母*/@Pattern(regexp = "^[a-zA-Z]$",message = "檢索首字母必須是一個(gè)字母",groups = {AddGroup.class,UpdateGroup.class})@NotEmpty(message = "檢索首字母不能為空", groups = {AddGroup.class})private String firstLetter;/*** 排序*/@Min(value = 0, message = "排序字段最小為0", groups = {AddGroup.class, UpdateGroup.class})@NotNull(message = "排序字段不能為空", groups = {AddGroup.class, UpdateGroup.class})private Integer sort; ? }

我們?cè)贑ontroller層指定分組，觸發(fā)對(duì)應(yīng)的校驗(yàn)

? ?/*** 保存*/@RequestMapping("/save")public R save(@RequestBody @Validated(value = AddGroup.class) BrandEntity brand) {brandService.save(brand);return R.ok();} ?/*** 修改*/@RequestMapping("/update")public R update(@Validated(value = UpdateGroup.class) @RequestBody BrandEntity brand) {brandService.updateById(brand);return R.ok();} ?/*** 修改狀態(tài)*/@RequestMapping("/update/status")public R updateStatus(@Validated(value = UpdateStatusGroup.class) @RequestBody BrandEntity brand) {brandService.updateById(brand);return R.ok();}

我們測(cè)試一個(gè)接口

http://localhost:88/api/product/brand/save ? 發(fā)送請(qǐng)求： {"brandId":1,"sort":1,"firstLetter":"VA","showStatus":3 } ? 返回： {"msg": "參數(shù)格式校驗(yàn)失敗","code": 10001,"data": {"brandId": "新增不能指定品牌id","name": "品牌名不能為空","logo": "url不能為空","showStatus": "必須提交指定的值","firstLetter": "檢索首字母必須是一個(gè)字母"} }

這里異常我們使用@ControllerAdvice統(tǒng)一處理了，返回了自定義的格式數(shù)據(jù)

@Slf4j @RestControllerAdvice(basePackages = "com.yfy.study.product.controller") public class GuliMallExceptionControllerAdvice { ? ?@ExceptionHandler(value = MethodArgumentNotValidException.class)public R handleValidException(MethodArgumentNotValidException e) {log.error("數(shù)據(jù)校驗(yàn)出現(xiàn)問題{},異常類型:{}", e.getMessage(), e.getClass());BindingResult bindingResult = e.getBindingResult();Map<String, String> errorMap = new HashMap<>();bindingResult.getFieldErrors().forEach(fieldError -> {errorMap.put(fieldError.getField(), fieldError.getDefaultMessage());});return R.error(BizCodeEnume.VALID_EXCEPTION.getCode(), BizCodeEnume.VALID_EXCEPTION.getMsg()).put("data", errorMap);}

7. 注意

• controller指定校驗(yàn)分組 @Validated(value = AddGroup.class)

• controller不指定校驗(yàn)分組 @Valid

• 默認(rèn)沒有指定分組的校驗(yàn)注解，在分組校驗(yàn)下@Validated(value = AddGroup.class)不會(huì)生效，只會(huì)在@Valid生效

比如：

@NotNull(message = "姓名不能為空") private String name; ? 我們?nèi)绻付四骋粋€(gè)分組，則不會(huì)觸發(fā)該字段的校驗(yàn)

?

總結(jié)

以上是生活随笔為你收集整理的Spring 使用 JSR303自定义校验注解+分组校验的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。