Spring Boot 集成 validation验证

谁借莪１个温暖的怀抱￠ 2023-06-08 06:34 71阅读 0赞

# 1.依赖导入 #

<dependency>
                <groupId>javax.validation</groupId>
                <artifactId>validation-api</artifactId>
                <version>2.0.0.Final</version>
            </dependency>
            <dependency>
                <groupId>org.hibernate</groupId>
                <artifactId>hibernate-validator</artifactId>
                <version>6.0.13.Final</version>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.8</version>
            </dependency>

# 2.部分标签含义 #

<table> 
 <thead> 
  <tr> 
   <th>限制</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Null</td> 
   <td>限制只能为null</td> 
  </tr> 
  <tr> 
   <td>@NotNull</td> 
   <td>限制必须不为null</td> 
  </tr> 
  <tr> 
   <td>@AssertFalse</td> 
   <td>限制必须为false</td> 
  </tr> 
  <tr> 
   <td>@AssertTrue</td> 
   <td>限制必须为true</td> 
  </tr> 
  <tr> 
   <td>@DecimalMax(value)</td> 
   <td>限制必须为一个不大于指定值的数字</td> 
  </tr> 
  <tr> 
   <td>@DecimalMin(value)</td> 
   <td>限制必须为一个不小于指定值的数字</td> 
  </tr> 
  <tr> 
   <td>@Digits(integer,fraction)</td> 
   <td>限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction</td> 
  </tr> 
  <tr> 
   <td>@Future</td> 
   <td>限制必须是一个将来的日期&nbsp;格式为：yyyy/MM/dd HH:mm:ss</td> 
  </tr> 
  <tr> 
   <td>@Max(value)</td> 
   <td>限制必须为一个不大于指定值的数字</td> 
  </tr> 
  <tr> 
   <td>@Min(value)</td> 
   <td>限制必须为一个不小于指定值的数字</td> 
  </tr> 
  <tr> 
   <td>@Past</td> 
   <td>限制必须是一个过去的日期</td> 
  </tr> 
  <tr> 
   <td>@Pattern(value)</td> 
   <td>限制必须符合指定的正则表达式</td> 
  </tr> 
  <tr> 
   <td>@Size(max,min)</td> 
   <td>限制字符长度必须在min到max之间</td> 
  </tr> 
  <tr> 
   <td>@Past</td> 
   <td>验证注解的元素值（日期类型）比当前时间早 格式为：yyyy/MM/dd HH:mm:ss</td> 
  </tr> 
  <tr> 
   <td>@NotBlank(message =)</td> 
   <td>验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格</td> 
  </tr> 
  <tr> 
   <td>@Email</td> 
   <td>验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式</td> 
  </tr> 
  <tr> 
   <td>@Length(min=,max=)</td> 
   <td>验证对象长度是否在指定范围内</td> 
  </tr> 
  <tr> 
   <td>@NotEmpty&nbsp;</td> 
   <td>验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）</td> 
  </tr> 
  <tr> 
   <td>@Range(min=,max=,message=)&nbsp;</td> 
   <td>验证 对象必须在合适范围内</td> 
  </tr> 
 </tbody> 
</table>

# 3.Valid 参数校验示例 #

**Bean:**

import lombok.Data;
    import org.hibernate.validator.constraints.Range;
    import org.hibernate.validator.constraints.URL;
    import javax.validation.constraints.*;
    import java.util.Date;
    import java.util.List;
    
    @Data
    public class User {
        @NotBlank(message = "姓名不能为空")
        @Size(min = 1,max = 10,message="姓名长度1~10")
        private String name;
    
        @Max(value=120, message="年龄最大为120")
        @DecimalMin(value = "10",message = "年龄低于10") // 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
        private int age;
    
        @Range(min = 5, max = 10, message = "range 不在范围内")
        private int range;
    
        @Email(message = "email格式错误")
        private String email;
    
        @AssertTrue(message = "flag只能为true")
        private boolean flag;
    
        @Past(message = "birthday时间大于当前日期")
        private Date birthday;//格式为yyyy/MM/dd HH:mm:ss
    
        @Future(message = "expire时间小于当前日期")
        private Date expire;
    
        @URL
        private String url;
    
        @NotEmpty
        @Size(min = 2, max = 6, message = "长度在2-6位") //字符串，集合，map限制大小
        private List<Integer> list;
    
    }

**controller:**

import com.comet.common.core.pojo.AjaxResult;
    import org.springframework.validation.BindingResult;
    import org.springframework.validation.annotation.Validated;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    
    /**
     * @author Unclue_liu
     * @organization comet
     * @date 2019/10/15 0015 10:37
     * @desc TODO
     */
    @RestController
    public class AController {
    
        @GetMapping("/")
        public AjaxResult get(@Validated User aa, BindingResult bindingResult){
            System.out.println(aa);
            return AjaxResult.error(bindingResult);
    
        }
    
    }

**校验结果保存在BindingResult或Errors对象中**

public static AjaxResult error(BindingResult bindingResult){
            JSONObject jsonObject = new JSONObject();
            StringBuilder sb = new StringBuilder();
            if(bindingResult.hasErrors()) {
                List<ObjectError> errors = bindingResult.getAllErrors();
                for (ObjectError err : errors) {
                    sb.append(err.getDefaultMessage()+";");
                }
            }
            String s = sb.toString();
            return s.equals("")?success():error(s);
        }

## **示例结果：** ##

**失败：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70][]

**成功：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70 1][]

# 4.Validated 参数校验 #

import org.springframework.validation.annotation.Validated;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.RestController;
    import javax.validation.constraints.Size;
    
    /**
     * @author Unclue_liu
     * @organization comet
     * @date 2019/10/17 0017 11:01
     * @desc TODO
     */
    @RestController
    @Validated// 注解必须写在这里,参数校验不过会有 ConstraintViolationException 异常
    public class BController {
        @GetMapping("valid/{data}")
        public String getPathVariable(@Size(min = 3, max = 6) @PathVariable String data) {
            return data;
        }
    
        @GetMapping("valid")
        public String getRequestParam(@Size(min = 3, max = 6) @RequestParam(value = "name", defaultValue = "0") String name) {
            return name;
        }
        
    
    }

# 5.分组校验 #

针对同一个pojo被不同controller调用校验，但是校验的参数都不同，所以对校验参数进行分组，故而匹配不同的校验场景。

**定义分组接口，用于标记：**

public interface IA {
    }

public interface IB {
    }

**实体类参数配置如下：**

@Range(min = 5, max = 10, message = "range 不在范围内",groups = IA.class)
        private int range;
    
        @Email(message = "email格式错误",groups = IB.class)
        private String email;
    
        @AssertTrue(message = "flag只能为true",groups ={IB.class,IA.class})
        private boolean flag;

**controller：**

@RestController
    public class GroupsController {
    
        //访问此接口，所有参数用IA.class或IB.class分组标注的都要进行校验
        @GetMapping("group")
        public AjaxResult group(@Validated({IA.class,IB.class}) User aa, BindingResult bindingResult) {
            return AjaxResult.error(bindingResult);
        }
        //访问此接口，所有参数用IA.class分组标注的都要进行校验
        @GetMapping("groupA")
        public AjaxResult groupA(@Validated({IA.class}) User aa, BindingResult bindingResult) {
            return AjaxResult.error(bindingResult);
        }
        //访问此接口，所有参数用IB.class分组标注的都要进行校验
        @GetMapping("groupB")
        public AjaxResult groupB(@Validated({IB.class}) User aa, BindingResult bindingResult) {
            return AjaxResult.error(bindingResult);
        }
    
    }

# 6.自定义校验 #

import javax.validation.Constraint;
    import javax.validation.Payload;
    import java.lang.annotation.*;
    
    /**
     * 自定义注解
     */
    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target({ElementType.FIELD, ElementType.ANNOTATION_TYPE})
    //指定注解的处理类
    @Constraint(validatedBy = AppointValidatorClass.class)
    public @interface AppointValidator {
    
        String value();
    
        String message() default "不在指定的value中";
    
        Class<?>[] groups() default {};
    
        Class<? extends Payload>[] payload() default {};
    }

**注解处理类：**

import javax.validation.ConstraintValidator;
    import javax.validation.ConstraintValidatorContext;
    import java.util.Arrays;
    import java.util.List;
    import java.util.concurrent.atomic.AtomicBoolean;
    
    /**
     * @author Unclue_liu
     * @organization comet
     * @date 2019/10/17 0017 14:35
     * @desc TODO 注解处理类
     */
    public class AppointValidatorClass implements ConstraintValidator<AppointValidator, Object> {
        //指定的范围值
        private String value;
    
        @Override
        public void initialize(AppointValidator appointValidator) {
            this.value = appointValidator.value();
        }
        /**
        * @Author: Uncle liu
        * @Param: o 提交时接收value
        * @return:
        * @Date: 2019-10-17 14:45
        */
        @Override
        public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
            //指定的value
            List<String> list = Arrays.asList(value.split(","));
            final AtomicBoolean flag = new AtomicBoolean(false);
            list.forEach(one -> {
                if (one.equals(o)) {//匹配成功
                    flag.set(true);
                }
            });
            return flag.get();
        }
    }

**实体类属性:**

//校验是否为1、2、3
        @AppointValidator(value = "1,2,3",groups ={IB.class,IA.class})
        private String appoint;

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70]: /images/20230531/c51c118b627b446fa04c791b99272e92.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70 1]: /images/20230531/fe63c39cea6e4e748035a9259f687212.png