java& JSR303之自定义校验注解 _java

什么是JSR303JSR是JAVA Specification Requests的缩写，意思是Java 规范提案。是指向JCP(Java Community Process)提出新增一个标准化技术规范的正式请求。任何人都可以提交JSR，以向Java平台增添新的API和服务。JSR已成为Java 界定的一个重要标准。
自带的校验注解都有哪些？提供的注解都在 import
javax.validation.constraints这个包下面的

文章插图

下面我们先简单的使用下基本注解校验首先我们先准备一个VO注解 @NotNull 校验 page 和 limit 属性这里手动制定了message 如果不手动指定的话会去加载默认的message
ValidationMessages.properties文件中

文章插图

@Data@ApiModel(description= "ListVO")public class ListVo {@NotNull(message = "页码不能为空")@ApiModelProperty(value = https://www.isolves.com/it/cxkf/yy/JAVA/2022-06-13/"页码")private Integer page;@NotNull(message = "分页大小不能为空")@ApiModelProperty(value = "分页大小")private Integer limit;@ApiModelProperty(value = "搜索条件")private Object searchObj;}复制代码

开启注解校验@Valid 开启校验，BindingResult 紧跟着注解校验对象后面可以获取到校验结果

@PostMApping("/getlist")@SysOperaLog("获取日志列表")public R getlist(@Valid @RequestBody ListVo parm, BindingResult bindingResult){if(bindingResult.hasErrors()){Map<String,Object> map = new HashMap<>();bindingResult.getFieldErrors().forEach((e)->{//错误提示信息String defaultMessage = e.getDefaultMessage();//出问题的属性String field = e.getField();map.put("message",defaultMessage);map.put("field",field);});returnR.error().data(map);}returniLogService.getList(parm);}复制代码

下面我们使用 postman 测试一下

文章插图

下面我们使用以下如何使用自定义校验1. 编写一个自定义的校验注解@DataCheck 注解

//可以被标注到那个地方@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})@Retention(RetentionPolicy.RUNTIME)@Documented//这里指向的是我们自定义的校验规则，可以治党多个不同校验器，适配不同的情况@Constraint(validatedBy = {DataCheckVaildator.class})public @interface DataCheck {//当然这里的message也可以去属性文件中指定String message() default "请提交规范数据";Class<?>[] groups() default {};Class<? extends Payload>[] payload() default {};//用来获取注解属性值int[] vals() default {};}复制代码

2. 编写一个自定义的校验器自定义校验器

public class DataCheckVaildator implements ConstraintValidator<DataCheck,Integer> {private Set<Integer> setNum = new HashSet<>();//初始化方法@Overridepublic void initialize(DataCheck constraintAnnotation) {int[] vals = constraintAnnotation.vals();for (int val : vals) {setNum.add(val);}}@Overridepublic boolean isValid(Integer integer, ConstraintValidatorContext constraintValidatorContext) {//如果包含我们规定的 数据就会返回true不包含就会返回falsereturn setNum.contains(integer);}}复制代码

3. 关联自定义的校验注解和自定义的校验器在自定义的注解上面将我们自定义的校验器进行绑定
@Constraint(validatedBy = {DataCheckVaildator.class})复制代码使用@DataCheck 进行分页大小的校验只能传递 10,20,30,40,50

@Data@ApiModel(description= "ListVO")public class ListVo {@NotNull(message = "页码不能为空")@ApiModelProperty(value = https://www.isolves.com/it/cxkf/yy/JAVA/2022-06-13/"页码")private Integer page;@NotNull(message = "分页大小不能为空")@DataCheck(vals={10,20,30,40,50})@ApiModelProperty(value = "分页大小")private Integer limit;@ApiModelProperty(value = "搜索条件")private Object searchObj;}复制代码

使用Postman调用可以看到 limit 传递的值不在规定返回之内时完成校验不在规定返回之内：