JSR-303 Bean Validation API概述以及验证

JSR是Java Specification Requests的缩写,意思是Java 规范提案。是指向JCP(Java Community Process)提出新增一个标准化技术规范的正式请求。任何人都可以提交JSR,以向Java平台增添新的API和服务。JSR已成为Java界的一个重要标准。

JSR 303 基本的校验规则

空检查
@Null 验证对象是否为null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.

Booelan检查
@AssertTrue 验证 Boolean 对象是否为 true @AssertFalse 验证 Boolean
对象是否为 false

长度检查
@Size(min=, max=) 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内
@Length(min=, max=) Validates that the annotated string is between min
and max included.

日期检查
@Past 验证 Date 和 Calendar 对象是否在当前时间之前,验证成立的话被注释的元素一定是一个过去的日期
@Future 验证 Date 和 Calendar 对象是否在当前时间之后 ,验证成立的话被注释的元素一定是一个将来的日期
@Pattern 验证 String 对象是否符合正则表达式的规则,被注释的元素符合制定的正则表达式,regexp:正则表达式 flags:
指定 Pattern.Flag 的数组,表示正则表达式的相关选项。

数值检查
建议使用在Stirng,Integer类型,不建议使用在int类型上,因为表单值为“”时无法转换为int,但可以转换为Stirng为”“,Integer为null
@Min 验证 Number 和 String 对象是否大等于指定的值 @Max 验证 Number 和 String
对象是否小等于指定的值 @DecimalMax 被标注的值必须不大于约束中指定的最大值.
这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits 验证 Number 和 String 的构成是否合法 @Digits(integer=,fraction=)
验证字符串是否是符合指定格式的数字,interger指定整数精度,fraction指定小数精度。
@Range(min=, max=) 被指定的元素必须在合适的范围内 @Range(min=10000,max=50000,message=”range.bean.wage”)
@Valid 递归的对关联对象进行校验,
如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber信用卡验证
@Email 验证是否是邮件地址,如果为null,不进行验证,算通过验证。
@ScriptAssert(lang= ,script=, alias=) @URL(protocol=,host=,port=,regexp=, flags=)

实例代码:实体类

/**
 * 品牌
 * 
 * @author shenshiju
 * @email [email protected]
 * @date 2021-01-03 12:09:40
 */
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
	private static final long serialVersionUID = 1L;

	/**
	 * 品牌id
	 */
	@TableId
	private Long brandId;
	/**
	 * 品牌名
	 * @NotBlank 表示不能为空
	 */
	@NotBlank(message = "品牌名必须提交")
	private String name;
	/**
	 * 品牌logo地址
	 */
	@NotBlank
	@URL(message = "logo必须是一个合法的url地址")
	private String logo;
	/**
	 * 介绍
	 */
	@NotBlank
	@NotBlank(message = "介绍必须填写")
	private String descript;
	/**
	 * 显示状态[0-不显示;1-显示]
	 */
	private Integer showStatus;
	/**
	 * 检索首字母
	 * @Pattern() 所有自定义的规则,都使用这个注解
	 */
	@NotBlank
	@Pattern(regexp="/^[a-zA-Z]$/",message = "检索首字母必须是一个字母")
	private String firstLetter;
	/**
	 * 排序
	 * 数字校验非空判断时,只能使用@NotNull
	 */
	@NotNull
	@Min(value = 0,message = "排序必须大于等于0")
	private Integer sort;

}

controller:

 /**
     * 保存
     * JSR303 Java 规范提案
     *      1.给Bean添加校验注解 参考 javax.validation.constraints 包下的校验注解,
     *            在实体类字段上进行标注注解,并定义自己的message提示
     *      2.开启校验功能 @Valid 校验错误以后会有默认的响应
     *      3.给校验的bean后紧跟一个BindingResult 就可以获取到校验的结果
     * @Valid 告诉SpringMVC,这个字段是需要校验的
     */
    @RequestMapping("/save")
    public R save(@Valid @RequestBody BrandEntity brand, BindingResult result){
        //判断这次校验是否有错误
        if (result.hasErrors()){
            Map<String,String> map = new HashMap<>();
            //1.获取校验的结果
            result.getFieldErrors().forEach((item)->{
                //遍历获取校验错误之后的提示信息
                String message = item.getDefaultMessage();
                //获取错误的属性名称
                String field = item.getField();
                map.put(field,message);
            });
            return R.error(400,"提交的数据不合法").put("data",map);
        }else { //没有错误,才进行保存数据
            brandService.save(brand);
        }
        return R.ok();
    }

测试结果:
JSR-303 Bean Validation API概述以及验证_第1张图片

你可能感兴趣的:(Java,java)