有些时候我们在项目中，会对增加/修改进行字段的校验，比如年龄一定的在一个合理的范围内。比如不能超过1000岁。不能是-1岁。
名字也会在合理的范围内，如果都是中国人的话先不说不能有字母了，起码不会超过20个字。
还有别的乱七八糟的，比如邮箱一定是邮箱格式的。身份证号是18位，手机号1开头，11位数等等等等。这些实现很简单。
如果不规范的可能直接前端校验后端不管了。这种常规下好像不会出问题，但是其实很不推荐。万一有人绕开这个前端直接调接口啥的呢。
稍微不规范一点的就是后端写大量代码，一个属性一个属性去判断。反正这样倒也能增加代码行数。指不定一个十几个字段的表单，能写个上百行校验的代码。但是可读性极差，而且其实虽然是无脑if，但是也挺费时间的。
其实这种表单校验是有现成的工具的。
导入依赖
其实这里有两种方式导入依赖。我们如果是使用Spring boot搭建项目的话，一定会引入web模块(如果和前端没交互也不存在表单校验啦)。而2.0.5.RELEASE版本的web包已经有了这个功能(感兴趣的同学可以自己去看你所在的web版本有没有这个表单校验的依赖。)。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<version>2.0.5.RELEASE</version>
</dependency>
当然了如果你的项目没有使用web模块的这个版本，也可以单独去引入表单校验的依赖包：
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.12.Final</version>
<scope>compile</scope>
</dependency>
其实web2.0.5版本也是引入了这个依赖包的。如下图：
boot-starter-web2.0.5RELEASE依赖
hibernate-validator依赖
实际上我们导包的时候就能看出来，这个注解就是
javax.validation里的。
@Valid注解
使用
其实这个的使用方法就是在实体类上加校验。
注意这里两个依赖包里都有校验的注解。感兴趣的可以看一下。而且使用方法也略有不同。我这里简单把注解截图，差不多都可以见名知意的：
校验注解
校验注解
其实这些校验有一些是重复的。然后比如size是校验list的长度。Length是校验字符串的长度，min/max校验数值的大小，字符串长度啥的(校验长度要用在length注解里)，非空校验啥的。这里就不一一说了。我先附上个demo展示下如何使用：
使用demo
因为这个都是我为了展示效果写的校验，所以直接以截图的形式来展示了。大家可以注意我使用这么多注解是来自于两个包。然后message是不通过时候的提示。也可以不给写。
而这个校验的结果有一个专门的BindingResult对象来接收的。
我先展示下使用效果：
controller层代码
这里我直接返回所有的error信息了。实际上大家可以酌情返回或者处理后展示。有一说一这个可读性还是挺差的。
访问参数
返回值是这样的:
[
{
"codes": [
"Max.userEntity.age",
"Max.age",
"Max.java.lang.Integer",
"Max"
],
"arguments": [
{
"codes": [
"userEntity.age",
"age"
],
"arguments": null,
"defaultMessage": "age",
"code": "age"
},
100
],
"defaultMessage": "年龄不能超过100",
"objectName": "userEntity",
"field": "age",
"rejectedValue": 102,
"bindingFailure": false,
"code": "Max"
},
{
"codes": [
"Range.userEntity.level",
"Range.level",
"Range.java.lang.Integer",
"Range"
],
"arguments": [
{
"codes": [
"userEntity.level",
"level"
],
"arguments": null,
"defaultMessage": "level",
"code": "level"
},
5,
1
],
"defaultMessage": "等级要在1和5之间",
"objectName": "userEntity",
"field": "level",
"rejectedValue": 7,
"bindingFailure": false,
"code": "Range"
},
{
"codes": [
"Email.userEntity.email",
"Email.email",
"Email.java.lang.String",
"Email"
],
"arguments": [
{
"codes": [
"userEntity.email",
"email"
],
"arguments": null,
"defaultMessage": "email",
"code": "email"
},
[],
{
"defaultMessage": ".*",
"arguments": null,
"codes": [
".*"
]
}
],
"defaultMessage": "不是一个合法的电子邮件地址",
"objectName": "userEntity",
"field": "email",
"rejectedValue": "1112",
"bindingFailure": false,
"code": "Email"
},
{
"codes": [
"AssertTrue.userEntity.flag",
"AssertTrue.flag",
"AssertTrue.java.lang.Boolean",
"AssertTrue"
],
"arguments": [
{
"codes": [
"userEntity.flag",
"flag"
],
"arguments": null,
"defaultMessage": "flag",
"code": "flag"
}
],
"defaultMessage": "用户不存在",
"objectName": "userEntity",
"field": "flag",
"rejectedValue": false,
"bindingFailure": false,
"code": "AssertTrue"
}
]
因为我完美的做到了每一项都错了，所以大家别误会是返回的总的信息。这里的其实都是错误信息。大家可以处理后返回，比如把所有的defaultMessage汇总返回。或者每次只返回第一项然后一次一次让用户修改啥的都行。
这个工具的用法就这样，其实真的很简单，但是如果没有的话自己写校验还是挺麻烦的。再复杂一点的比如手机号身份证号也可以用正则来校验。感觉能满足大多数的校验需求了。
本篇笔记就记到这里，如果稍微帮到你了记得点个喜欢点个关注。也祝大家工作顺顺利利，每天get一个小技巧~
网友评论