Spring Validation 参数校验 学习笔记

SpringBoot 已经整合了 Hibernate Validation。Spring 2.3.0 起需要自己添加依赖。
验证本身比较好理解。主要是与全局异常配合这块，要根据自己项目实际情况来考虑。
提醒：如果你在纠结某个字段要加两种校验规则，并且它们还冲突时，多加一个DTO试试

区别	@Valid	@Validated
提供者	JSR-303规范	Spring框架
支持分组	否	是
标注位置	METHOD, FIELD, CONSTRUCTOR, PARAMETER, TYPE_USE	TYPE, METHOD, PARAMETER
支持嵌套校验	是	否

基本用法

注解校验

注解说明 摘自：锦成同学的《这么写参数校验(validator)就不会被劝退了~》

验证注解	验证的数据类型	说明
@AssertFalse	Boolean,boolean	验证注解的元素值是false
@AssertTrue	Boolean,boolean	验证注解的元素值是true
@NotNull	任意类型	验证注解的元素值不是null
@Null	任意类型	验证注解的元素值是null
@Min(value=值)	BigDecimal，BigInteger, byte,short, int, long，等任何Number或CharSequence（存储的是数字）子类型	验证注解的元素值大于等于@Min指定的value值
@Max（value=值）	和@Min要求一样	验证注解的元素值小于等于@Max指定的value值
@DecimalMin(value=值)	和@Min要求一样	验证注解的元素值大于等于@ DecimalMin指定的value值
@DecimalMax(value=值)	和@Min要求一样	验证注解的元素值小于等于@ DecimalMax指定的value值
@Digits(integer=整数位数, fraction=小数位数)	和@Min要求一样	验证注解的元素值的整数位数和小数位数上限
@Size(min=下限, max=上限)	字符串、Collection、Map、数组等	验证注解的元素值的在min和max（包含）指定区间之内，如字符长度、集合大小
@Past	java.util.Date,java.util.Calendar;Joda Time类库的日期类型	验证注解的元素值（日期类型）比当前时间早
@Future	与@Past要求一样	验证注解的元素值（日期类型）比当前时间晚
@NotBlank	CharSequence子类型	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的首位空格
@Length(min=下限, max=上限)	CharSequence子类型	验证注解的元素值长度在min和max区间内
@NotEmpty	CharSequence子类型、Collection、Map、数组	验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@Range(min=最小值, max=最大值)	BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子类型和包装类型	验证注解的元素值在最小值和最大值之间
@Email(regexp=正则表达式,flag=标志的模式)	CharSequence子类型（如String）	验证注解的元素值是Email，也可以通过regexp和flag指定自定义的email格式
@Pattern(regexp=正则表达式,flag=标志的模式)	String，任何CharSequence的子类型	验证注解的元素值与指定的正则表达式匹配
@Valid	任何非原子类型	指定递归验证关联的对象如用户对象中有个地址对象属性，如果想在验证用户对象时一起验证地址对象的话，在地址对象上加@Valid注解即可级联验证

package jerry.demo.entity;

import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;

public class Player {
	@NotNull
	private Long id;
	
	@NotBlank(message = "岂能无名？")
    @Size(max = 12, message = "名字最长12个字")
	private String name;
	
	@Min(value = 18,message = "未成年人，禁止入内")
	@Max(value = 200,message = "我一眼就看出你不是人！")
	private Integer age;

	// getter,setter 略
}

校验List

    /** 角色id组 */
    @Valid // 嵌套验证先加：@Valid
    @NotNull(message = "角色必填")
    @Size(min = 1, message = "至少选择一个角色")
    private Long[] roleIds;

控制器

要校验的对象前添加注解：@Valid
校验结果自动保存在：BindingResult result
以下只是演示校验功能。真正使用场景中应该向上抛锅到全局异常中去处理。

@RestController
public class WelcomeController {

	@RequestMapping("/")
	public Map welcome(@Valid Player player, BindingResult result) {
		Map map = new HashMap();
		 
		String msg = "你好: " + player.getName();
		int code = 200;
		
		if(result.hasErrors()){
			ArrayList<String> errorMsg = new ArrayList<String>();
            for (ObjectError error : result.getAllErrors()) {
                errorMsg.add(error.getDefaultMessage());
            }            
            
            code = 400;
            msg = errorMsg.toString();
        }
		
		map.put("code", code);
		map.put("msg", msg);
        return map;
	}
}

分组校验

同一个DTO可能在 Add和Upd两个接口中使用。

public class Player {
	@NotNull(groups = {Upd.class, Del.class}) /groups 多个值时用数组
	private Long id;
	
	@NotBlank(message = "岂能无名？", groups = Add.class)
    @Size(max = 12, message = "名字最长12个字")
	private String name;
	
	@Min(value = 18,message = "未成年人，禁止入内")
	@Max(value = 200,message = "我一眼就看出你不是人！")
	private Integer age;

	// getter,setter 略
}

控制器

要校验的对象前添加注解：@Validated 支持分组功能

@RestController
public class WelcomeController {

	@RequestMapping("/upd")
	public Map welcome(@Validated(Upd.class) Player player, BindingResult result) {
		//。。。同上
	}
}

校验顺序

支持定义校验的先后顺序
定义两个接口，用来分组

public interface A {}
public interface B {}

@GroupSequence({A.class,B.class})  
public interface GroupSeq {}

校验规则用接口分组

public class Player {
	@NotNull(groups = A.class)
	private Long id;
	
	@NotBlank(message = "岂能无名？", groups = B.class)
    @Size(max = 12, message = "名字最长12个字")
	private String name;
	
	@Min(value = 18,message = "未成年人，禁止入内")
	@Max(value = 200,message = "我一眼就看出你不是人！")
	private Integer age;

	// getter,setter 略
}

校验GroupSequence``

@RestController
public class WelcomeController {

	@RequestMapping("/upd")
	public Map welcome(@Validated(GroupSeq.class) Player player, BindingResult result) {
		//。。。同上
	}
}

自定义校验

自定义注解

@MyValid 验证小写英文字母

@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {MyValidator.class})
public @interface MyValid {

    // 默认错误消息
    String message() default "错误了";

    // 默认分组
    Class<?>[] groups() default {};

    // 默认负载
    Class<? extends Payload>[] payload() default {};
}

实现ConstraintValidator接口编写约束校验器

public class MyValidator implements ConstraintValidator<Player, String> {

    private static final Pattern PATTERN = Pattern.compile("^[a-z]+$");

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 有值才校验
        if (value != null) {
            Matcher matcher = PATTERN.matcher(value);
            return matcher.find();
        }
        return true;
    }
}

代码方式校验

@Autowired
private javax.validation.Validator validator;

// 编程式校验
@PostMapping("/saveWithCodingValidate")
public Result saveWithCodingValidate(@RequestBody Player player ) {
    Set<ConstraintViolation<Player>> validate = validator.validate(player, A.class);
    // validate 为空校验通过。否则未通过的信息都存在 validate
    if (!validate.isEmpty()) {
    	ArrayList<Object> errorMsg = new ArrayList<Object>();
        for (ConstraintViolation<Player> vd: validate) {
            errorMsg.add(vd);
        }
        return Result.fail(errorMsg.toString());
    }
    // 验证通过
    return Result.ok();
}

快速失败

有时只要一个参数错了就不需要继续了，但默认规则会校验完全部参数才一起返回错误。这时我们可以开启快速失败。

@Bean
public Validator validator() {
    ValidatorFactory vf = Validation.byProvider(HibernateValidator.class)
            .configure()
            .failFast(true) // 快速失败开启
            .buildValidatorFactory();
    return vf.getValidator();
}

踩坑

Spring 2.3.0 起 web starters 不包含 Validation Starter 了

详情见：官方文档：Validation Starter no longer included in web starters
自己添加Validation Starter吧

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

参考资料

官网：Validating Form Input
Hibernate Validator JSR 303 的参考实现
Spring Framework provides support for the Java Bean Validation API.

springboot使用hibernate validator校验
Spring Boot：Spring Validation数据校验
springboot全局异常捕获统一处理及整合Validation
Spring Boot 全局异常处理 与 Hibernate Validator校验框架整合