利用javax.validation實現對bean屬性校驗

1.使用場景介紹

controller層對傳入的bean的屬性進行非空、屬性長度等合法性的校驗。
傳統的方式是我們要自己寫if…else…去判斷，比較麻煩。

2.實現效果

3.代碼介紹

代碼結構：

pom.xml

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

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

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

3.1 工具類

/**
 * @Description: 校驗結果
 * @Author laoxu
 * @Date 2020/5/27 23:30
 **/
@Data
public class ValidationResult {
    // 校驗結果是否有錯
    private boolean hasErrors;

    // 校驗錯誤信息
    private Map<String, String> errorMsg;
}

public class ValidationUtils {
    private static Validator validator = Validation.buildDefaultValidatorFactory().getValidator();

    public static <T> ValidationResult validateEntity(T obj) {
        ValidationResult result = new ValidationResult();
        Set<ConstraintViolation<T>> set = validator.validate(obj, Default.class);
        // if( CollectionUtils.isNotEmpty(set) ){
        if (set != null && set.size() != 0) {
            result.setHasErrors(true);
            Map<String, String> errorMsg = new HashMap<String, String>();
            for (ConstraintViolation<T> cv : set) {
                errorMsg.put(cv.getPropertyPath().toString(), cv.getMessage());
            }
            result.setErrorMsg(errorMsg);
        }
        return result;
    }

    public static <T> ValidationResult validateProperty(T obj, String propertyName) {
        ValidationResult result = new ValidationResult();
        Set<ConstraintViolation<T>> set = validator.validateProperty(obj, propertyName, Default.class);
        if (set != null && set.size() != 0) {
            result.setHasErrors(true);
            Map<String, String> errorMsg = new HashMap<String, String>();
            for (ConstraintViolation<T> cv : set) {
                errorMsg.put(propertyName, cv.getMessage());
            }
            result.setErrorMsg(errorMsg);
        }
        return result;
    }

    /**
     * bean整體校驗，把所有違規信息，輸出String。
     */
    public static String validate(Object o, Class<?>... groups){
        Set<ConstraintViolation<Object>> resultSet=validator.validate(o, groups);
        if(resultSet == null || resultSet.size() ==0){
            return null;
        }
        StringBuilder sb = new StringBuilder();
        for(ConstraintViolation<Object> constraintViolation : resultSet) {
            sb.append(constraintViolation.getMessageTemplate()).append(",");
        }
        return sb.substring(0,sb.length()-1);
    }

}

3.2 模型類

@Data
public class Student {
    @Length(max=20,message="姓名長度不能大於20")
    @NotEmpty(message="姓名不能爲空")
    private String name;
    @Range(min = 0, max = 1, message = "性別只能輸入只能輸入0或1")
    private Integer gender;
    private Integer age;
    @Email
    private String email;
    @NotBlank(message = "身份證號不能爲空")
    @PhoneNumber
    private String phone;
}

3.3 註解類

/**
 *  自定義驗證
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER, ElementType.FIELD})
// 指定真正實現校驗規則的類
@Constraint(validatedBy = PhoneValidator.class)
public @interface PhoneNumber {
    String message() default "手機號不合法";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

3.4 實現類

public class PhoneValidator implements ConstraintValidator<PhoneNumber,String> {
    @Override
    public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) 
    {
        return s.length()==11;
    }
}

3.5 控制器

@RestController
@RequestMapping("/api/student")
public class StudentController {
    private static final Logger log = LoggerFactory.getLogger(StudentController.class);

    @PostMapping("add")
    public String add(@RequestBody Student student){
        ValidationResult validationResult = ValidationUtils.validateEntity(student);
        if(validationResult.isHasErrors()){
            return validationResult.getErrorMsg().toString();
        }

        return "添加成功";

    }
}