Bean Validation 校验实践

前言

在应用程序的业务逻辑中,经常会碰到需要校验参数的情况。
经常要判断一个 Model 的字段是否为 Null 之类,或者判断长度等。
那么在代码层面上,就会需要编写很多校验,影响代码的阅读以及维护,而且造成代码的冗余。

应用程序必须通过某种手段来确保输入进来的数据从语义上来讲是正确的。

在通常的情况下,应用程序是分层的,不同的层由不同的开发人员来完成。很多时候同样的数据验证逻辑会出现在不同的层,这样就会导致代码冗余和一些管理的问题,比如说语义的一致性等。为了避免这样的情况发生,最好是将验证逻辑与相应的域模型进行绑定。

为了更好的关注核心的业务逻辑,减少参数校验侵入方法内部,因此有了 JRS-303 提案。

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

Bean Validation 为 JavaBean 验证定义了相应的元数据模型和 API。缺省的元数据是 Java Annotations,通过使用 XML 可以对原有的元数据信息进行覆盖和扩展。在应用程序中,通过使用 Bean Validation 或是你自己定义的 constraint,例如 @NotNull, @Max, @ZipCode, 就可以确保数据模型(JavaBean)的正确性。constraint 可以附加到字段,getter 方法,类或者接口上面。对于一些特定的需求,用户可以很容易的开发定制化的 constraint。Bean Validation 是一个运行时的数据验证框架,在验证之后验证的错误信息会被马上返回。

Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现,除此之外还有一些附加的 constraint。如果想了解更多有关 Hibernate Validator 的信息,请查看 http://www.hibernate.org/subprojects/validator.html

下载 JSR 303 – Bean Validation 规范 http://jcp.org/en/jsr/detail?id=303
目前最新的为 Bean Validation 2.0,是 JSR 380,实现为 Hibernate Validator - 6.0.1.Final

Bean Validation 2.0 中的 constraint

Constraint 详细信息
@Null 被注释的元素必须为 null
@NotNull 被注释的元素必须不为 null
@AssertTrue 被注释的元素必须为 true
@AssertFalse 被注释的元素必须为 false
@Min(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@Max(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@DecimalMin(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@DecimalMax(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@Negative 被注释的元素必须是一个严格的负数,举例,0 被视为无效值,因为不是负数
@NegativeOrZero 被注释的元素必须是一个严格的负数或者 0
@Positive 被注释的元素必须是一个严格的正数,举例,0 被视为无效值,因为不是正数
@PositiveOrZero 被注释的元素必须是一个严格的正数或者 0
@Size(max, min) 被注释的元素的大小必须在指定的范围内
@Digits (integer, fraction) 被注释的元素必须是一个带小数的数,integer 为整数位最大值,fraction 为小数位最大值
@Past 被注释的元素必须是一个过去的日期
@PastOrPresent 被注释的元素必须是一个过去的日期或者现在日期
@Future 被注释的元素必须是一个将来的日期
@FutureOrPresent 被注释的元素必须是一个将来的日期或者现在日期
@Pattern(value) 被注释的元素必须符合指定的正则表达式
@NotEmpty 被注释的元素必须不为 null 或者不为空,可校验字符、集合、Map
@NotBlank 被注释的元素必须不为空字符串
@Email 被注释的元素必须是电子邮箱地址

Hibernate Validator 附加的 constraint

Constraint 详细信息
@Length 被注释的字符串的大小必须在指定的范围内
@Range 被注释的元素必须在合适的范围内

Spring boot 中使用方式

参数校验

@Slf4j
@Validated // 使用 spring 的 Validated 注解标注此 Controller 是需要执行校验的,
@RestController
@RequestMapping("/demo-1")
public class Demo1Controller {

    /**
     * 在参数上做校验,基本类型
     * @param name 名称
     *
     * @return
     */
    @GetMapping("/query-1")
    public HttpStatus query1(@NotBlank(message = "不能为空") String name) {
        log.info("name is {}", name);
        return HttpStatus.OK;
    }

}

运行结果:


POJO 校验

@Slf4j
@RestController
@RequestMapping("/demo-2")
public class Demo2Controller {

    @PostMapping("/save-1")
    public HttpStatus save1(@Validated Person person) {
        return HttpStatus.OK;
    }

}

@Data
public class Person {

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

    private Integer age;

    private String sex;
}

运行结果:


接口层级校验

@Slf4j
@RestController
@RequestMapping("/demo-3")
public class Demo3Controller {

    @Resource
    private DemoService service;

    @PostMapping("/save-1")
    public HttpStatus save1(@RequestBody Person person) {
        log.info("person is {}", person);
        service.save(person);

        return HttpStatus.OK;
    }

}

@Data
public class Person {

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

    private Integer age;

    private String sex;
}

@Validated
public interface DemoService {

    void save(@Valid Person person);
}

运行结果:


分组校验

@Slf4j
@RestController
@RequestMapping("/demo-4")
public class Demo4Controller {

    @PostMapping("/save-1")
    public HttpStatus save1(@Validated(value = {SaveValidation.class, Default.class}) @RequestBody PersonGroup person) {
        log.info("person is {}", person);

        return HttpStatus.OK;
    }

    @PostMapping("/update-1")
    public HttpStatus update1(@Validated(value = {UpdateValidation.class, Default.class}) @RequestBody PersonGroup person) {
        log.info("person is {}", person);

        return HttpStatus.OK;
    }

}

@Data
public class PersonGroup {

    @NotBlank(groups = {SaveValidation.class}, message = "保存时名字不能为空")
    private String saveName;

    @NotBlank(groups = {UpdateValidation.class}, message = "更新时名字不能为空")
    private String updateName;

    private Integer age;

    private String sex;
}

运行结果:


@Validated 隐含默认校验,即默认分组,如果不分场景下校验,可以使用如下方式配置:
分组时:
@Validated(value = {ContainerSaveValidation.class, Default.class})
属性上:
@NotBlank(groups = {SaveValidation.class}, message = "保存时名字不能为空") private String saveName;

参考文章:
https://www.ibm.com/developerworks/cn/java/j-lo-jsr303/index.html
Hibernate Validator 官方文档

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

推荐阅读更多精彩内容