使用SpringBoot validator让数据更真实

数据验证是作为一个企业级项目架构上设计的最基础的模块,前辈们曾说过:界面上传递到后天的数据没有百分之百值得相信的!为什么这么说呢?往往我们在编写程序的时候都会感觉后台的验证无关紧要,这样就会给别人空子钻。我可以模拟前台发送的请求到后台地址,那么我如果发送一些涉及系统安全的代码到后台,后果一发不可收拾。接下来我们就来讲解下SpringBoot项目内如何对参数进行校验!

本章目标

在SpringBoot项目内完成参数后台数据校验。

构建项目

我们直接使用IntelliJ IDEA工具来构建一个SpringBoot项目,预先导入Web依赖,项目结构如下图1所示:

图1

SpringBoot的Web组件内部集成了hibernate-validator,所以我们这里并不需要额外的为验证再导入其他的包,接下来我们先来看看SpringBoot为我们提供了哪些验证。

内置验证

SpringBoot因为采用了hibernate-validator,所以我们直接使用hibernate-validator就可以进行数据校验,内置验证如下图2所示:

图2

使用验证

我们接下来创建一个实体叫做DemoEntity,实体内添加几个测试字段并对每个字段都做出验证处理,代码如下图3所示:

图3

我在DemoEntity创建了三个字段,分别对这三个字段进行了有效性验证。

字段name:非空校验、长度必须在2~10位之间。

字段age:最小是1岁。

字段mail:非空校验、邮箱格式。

下面我们创建一个名叫IndexController的控制器并通过页面传递参数的形式来校验数据,控制器代码如下图4所示:

图4

上图4可以看到我在控制器中注入了一个MessageSource的接口对象,这个对象是用于格式化错误消息的。根据传入的错误字段对象(FieldError)结合hibernate-validator验证的内置错误消息文件进行输出错误消息,hibernate-validator的错误消息支持国际化,所以我们获取错误消息的时候需要传入Locale对象获取本地的国际化类型。hibernate-validator错误消息文件在对应源码包内可以找到,内容如下图5所示:

图5

下面我们来测试下我们的验证是否有效。

运行测试

我们使用SpringBootApplication的形式启动项目,启动成功后访问地址:127.0.0.1:8080/validator,界面输出内容如下图6所示:

图6

可以看到SpringBoot内的验证起作用了,我们访问地址的时候并没有传入任何的参数,所有的错误消息都一并输出了,那我们尝试传入name、age有效数据,mail数据填写错误邮箱地址,效果如下图7所示:

图7

可以看到验证框架准确无误的输出了对应字段的错误消息,那我们接下尝试输入一个正确的地址呢?如下图8所示:

图8

数据都已经输出正确,界面输出了正确提示,SpringBoot内部提供的验证可以满足我们大多数的验证,但是如果你系统内需要一些自定义的验证,我们该如何处理?

自定义验证

自定义验证需要我们提供两个文件内容,一个是注解、另外一个是对应注解继承ConstraintValidator的实现类,下面我们假如有这么个情景,我们在DemoEntity内添加一个字段flag,需要验证flag字段内容仅为1,2,3。

自定义验证注解

我们先来创建一个注解,注解内部需要对应验证注解的验证实现类,所以创建后会报错。FlagValidator自定义验证注解内容如下图9所示:

图9

可以看到上图9内有个@Constraint注解,里面传入了一个validatedBy的字段,这个就是我们自定义注解的实现类的类型,实现类代码如下图10所示:

图10

自定义验证实现类里面有两个方法,分别是初始化验证消息、执行验证。

初始化验证消息方法内你可以得到配置的注解内容,而验证方法则是你的验证业务逻辑。

测试自定义验证

我们先来修改DemoEntity实体类,加入flag字段并且配置@FlagValidator自定义注解,如下图11所示:

图11

接下来我们重启下项目,访问地址时在之前的基础上添加一个flag=0,如下图12所示:

图12

我们自定义的注解已经生效了,我们传入一个正确的值,再次访问地址,界面输出内容如下图13所示:

图13

验证通过,自定义注解已经生效没毛病。

总结

以上内容就是本章的全部讲述,本章主要讲解了SpringBoot项目内如何对前台传入的值进行验证,如何自定义注解。

源码地址

SpringBoot码云地址:https://gitee.com/hengboy/spring-boot-chapter

SpringBoot GitHub地址:https://github.com/hengyuboy/spring-boot-chapter

源码章节:Chapter17

开源信息

安全系列

QueryDSL系列文章

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20180803G08YI000?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 yunjia_community@tencent.com 删除。

扫码关注云+社区

领取腾讯云代金券