javax.validation JSR验证框架

原文地址:https://blog.csdn.net/wuseyukui/article/details/81164207

JSR-303 与 hibernate-validator

Spring3支持JSR-303验证框架,JSR-303 是Java EE 6 中的一项子规范,叫做BeanValidation,官方参考实现是hibernate-validator(与Hibernate ORM 没有关系),JSR 303 用于对Java Bean 中的字段的值进行验证。

hibernate-validator实现了JSR-303规范,并扩展了一些注解,提供了一套比较完善、便捷的验证实现方式。

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

spring-boot-starter-web已默认依赖hibernate-validator包,故无需重复添加 spring-boot-starter-validation 依赖。若想单独实现 Bean 验证,则只需单加入 spring-boot-starter-validation 依赖即可。
spring-boot-starter-web依赖关系:

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </dependency>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
        </dependency>
    </dependencies>

spring-boot-starter-validation依赖关系:

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.tomcat.embed</groupId>
            <artifactId>tomcat-embed-el</artifactId>
        </dependency>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
        </dependency>
    </dependencies>

校验bean(参数封装成对象)

POST接口 + @Valid + BindingResult 验证示例:

@Controller
@RequestMapping("/user")
public class UserController {

    /**
     * 创建用户
     * @requestBody可以将请求体中的JSON字符串绑定到相应的bean上
     * BindingResult是验证不通过的结果集合
     */
    @RequestMapping(value = "/create", method = RequestMethod.POST)
    @ResponseBody
    public String postUser(@RequestBody @Valid User user, BindingResult result) {
        if (result.hasErrors()) {
            for (ObjectError error : result.getAllErrors()) {
                System.out.println(error.getDefaultMessage());
            }
            return "error";
        }
        return "success";
    }
}

常用示例

User.java

@Data // Lombok注解,可以使我们不用再在代码里手动加get、set、toString、equals和hashCode等方法
public class User {

    @NotBlank(message = "用户名不能为空")
    private String name;

    @NotBlank(message = "年龄不能为空")
    @Range(min = 0, max = 120, message = "年龄只能从0-120岁")
    private String age;

    // 如果是空,则不校验,如果不为空,则校验
    @Pattern(regexp = "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", message = "出生日期格式不正确")
    private String birthday;

}

示例2

定义Bo,使用@Valid注解为自定义对象进行级联校验:

package com.idss.common.pojo.entity.es;

import javax.validation.Valid;
import javax.validation.constraints.NotBlank;

public class UserBo {

    @NotBlank(message = "操作人id不能为空")
    private String userName;

    @NotBlank(message = "邮箱不能为空")
    private String email;

    @Valid
    private SubordinateUser subordinateUser;
}

使用验证器校验:

import javax.validation.Configuration;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;

public class Test{
    private static final Validator VALIDATOR;

    //获得验证器实例
    static {
        Configuration<?> config = Validation.byDefaultProvider().configure();
        ValidatorFactory factory = config.buildValidatorFactory();
        VALIDATOR = factory.getValidator();
        factory.close();
    }
    //获得验证器实例(自动关闭方式)
    static {
        try (ValidatorFactory factory = Validation.byDefaultProvider().configure().buildValidatorFactory()){
            VALIDATOR = factory.getValidator();
        }
    }

    public static void main(String []args){
        UserBo userBo = new UserBo(userName, email);
        Set<ConstraintViolation<UserBo>> validate = VALIDATOR.validate(userBo);
        if (CollectionUtils.isNotEmpty(validate)) {
            StringBuilder stringBuilder = new StringBuilder();
            validate.forEach(item -> stringBuilder.append(item.getMessage()).append(","));
            throw new RuntimeException(stringBuilder.toString().substring(0, stringBuilder.length() - 1));
        }
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,701评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,649评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,037评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,994评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,018评论 6 395
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,796评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,481评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,370评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,868评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,014评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,153评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,832评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,494评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,039评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,156评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,437评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,131评论 2 356

推荐阅读更多精彩内容