java validator_Spring中校验器(Validator)的深入讲解
前言
Spring框架的 validator 组件,是个辅助组件,在进行数据的完整性和有效性非常有用,通过定义一个某个验证器,即可在其它需要的地方,使用即可,非常通用。
应用在执行业务逻辑之前,必须通过校验保证接受到的输入数据是合法正确的,但很多时候同样的校验出现了多次,在不同的层,不同的方法上,导致代码冗余,浪费时间,违反DRY原则。
每一个控制器都要校验
过多的校验参数会导致代码太长
代码的复用率太差,同样的代码如果出现多次,在业务越来越复杂的情况下,维护成本呈指数上升。
可以考虑把校验的代码封装起来,来解决出现的这些问题。
JSR-303
JSR-303是Java为Bean数据合法性校验提供的标准框架,它定义了一套可标注在成员变量,属性方法上的校验注解。
Hibernate Validation提供了这套标准的实现,在我们引入Spring Boot web starter或者Spring boot starter validation的时候,默认会引入Hibernate Validation。
用法实例
说了这么多废话,上代码。
1、引入SpringBoot项目
org.springframework.boot
spring-boot-starter-web
org.hibernate.validator
hibernate-validator
org.projectlombok
lombok
2、编写校验对象
@Data
public class User {
// 名字不允许为空,并且名字的长度在2位到30位之间
// 如果名字的长度校验不通过,那么提示错误信息
@NotNull
@Size(min=2, max=30,message = "请检查名字的长度是否有问题")
private String name;
// 不允许为空,并且年龄的最小值为18
@NotNull
@Min(18)
private Integer age;
}
3、创建控制器
@SpringBootApplication
@RestController
public class UserApplication{
public static void main(String[] args) {
SpringApplication.run(UserApplication.class,args);
}
// 1. 要校验的参数前,加上@Valid注解
// 2. 紧随其后的,跟上一个BindingResult来存储校验信息
@RequestMapping("/test1")
public Object test1(
@Valid User user,
BindingResult bindingResult
) {
//如果检验出了问题,就返回错误信息
// 这里我们返回的是全部的错误信息,实际中可根据bindingResult的方法根据需要返回自定义的信息。
// 通常的解决方案为:JSR-303 + 全局ExceptionHandler
if (bindingResult.hasErrors()){
return bindingResult.getAllErrors();
}
return "OK";
}
}
4、运行应用
稍作演示下运行的结果,可以看出校验框架已经生效了。
校验年龄
校验名称
校验通过
常见的校验注解
@Null 被注释的元素必须为 null
@NotNull 被注释的元素必须不为 null
@AssertTrue 被注释的元素必须为 true
@AssertFalse 被注释的元素必须为 false
@Min(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@Max(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@DecimalMin(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@DecimalMax(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@Size(max=, min=) 被注释的元素的大小必须在指定的范围内
@Digits (integer, fraction) 被注释的元素必须是一个数字,其值必须在可接受的范围内
@Past 被注释的元素必须是一个过去的日期
@Future 被注释的元素必须是一个将来的日期
@Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式
Hibernate Validator提供的校验注解:
@NotBlank(message =) 验证字符串非null,且长度必须大于0
@Email 被注释的元素必须是电子邮箱地址
@Length(min=,max=) 被注释的字符串的大小必须在指定的范围内
@NotEmpty 被注释的字符串的必须非空
@Range(min=,max=,message=) 被注释的元素必须在合适的范围内
自定义校验注解
有时候,第三方库中并没有我们想要的校验类型,好在系统提供了很好的扩展能力,我们可以自定义检验。
比如,我们想校验用户的手机格式,写手机号码校验器
1、编写校验注解
// 我们可以直接拷贝系统内的注解如@Min,复制到我们新的注解中,然后根据需要修改。
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
//注解的实现类。
@Constraint(validatedBy = {IsMobileValidator.class})
public @interface IsMobile {
//校验错误的默认信息
String message() default "手机号码格式有问题";
//是否强制校验
boolean isRequired() default false;
Class>[] groups() default {};
Class extends Payload>[] payload() default {};
}
2、编写具体的实现类
我们知道注解只是一个标记,真正的逻辑还要在特定的类中实现,上一步的注解指定了实现校验功能的类为IsMobileValidator。
// 自定义注解一定要实现ConstraintValidator接口奥,里面的两个参数
// 第一个为 具体要校验的注解
// 第二个为 校验的参数类型
public class IsMobileValidator implements ConstraintValidator {
private boolean required = false;
private static final Pattern mobile_pattern = Pattern.compile("1\\d{10}");
//工具方法,判断是否是手机号
public static boolean isMobile(String src) {
if (StringUtils.isEmpty(src)) {
return false;
}
Matcher m = mobile_pattern.matcher(src);
return m.matches();
}
@Override
public void initialize(IsMobile constraintAnnotation) {
required = constraintAnnotation.isRequired();
}
@Override
public boolean isValid(String phone, ConstraintValidatorContext constraintValidatorContext) {
//是否为手机号的实现
if (required) {
return isMobile(phone);
} else {
if (StringUtils.isEmpty(phone)) {
return true;
} else {
return isMobile(phone);
}
}
}
}
3、测试自定义注解的功能
@Data
public class User {
@NotNull
@Size(min=2, max=30,message = "请检查名字的长度是否有问题")
private String name;
@NotNull
@Min(18)
private Integer age;
//这里是新添加的注解奥
@IsMobile
private String phone;
}
4、测试
通过
手机号有问题
可以看出自定义的注解已经生效了。
我们还可以继续优化的地方,新建一个全局的异常,如果校验失败的话,抛出全局的业务异常,捕获业务异常,然后返回用户友好的提示信息。
额外
也可以通过方法的校验。
1、控制器上添加@Validated注解
2、在控制器的方法上添加校验注解,@Min,@Max等。
@Validated
@RestController
@SpringBootApplication
public class UserApplication{
public static void main(String[] args) {
SpringApplication.run(UserApplication.class,args);
}
@RequestMapping("/test2")
public String test2(
@IsMobile String phone
){
return phone + "ok";
}
@ExceptionHandler(ConstraintViolationException.class)
@ResponseBody
public Object handleConstraintViolationException(ConstraintViolationException cve){
HashSet messageSet = new HashSet();
for (ConstraintViolation constraintViolation : cve.getConstraintViolations()) {
messageSet.add(constraintViolation.getMessage());
}
return messageSet;
}
}
类的校验规则
最后
通过使用校验器,所有的控制器,我们都不用再去做校验啦,代码再回看是不是清爽很多。我们写代码很简答,但是一定要想到如何把代码写的更简单,更清晰,更利于维护,写重复的代码是在浪费自己的时间奥。
以后再碰到参数校验的情况,首先想到的不是直接就去校验,可以查找自己是否写过某一类的验证器,可以直接拿来即用。
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对脚本之家的支持。
java validator_Spring中校验器(Validator)的深入讲解相关推荐
- SpringBoot的参数校验器 - Validator
1.前提 在日常的开发中,服务端对象的校验是非常重要的一个环节,比如注册的时候:校验用户名,密码,身份证,邮箱等信息是否为空,以及格式是否正确. 但是这种在日常的开发中进行校验太繁琐了,代码繁琐而且很 ...
- Bean Validation完结篇:你必须关注的边边角角(约束级联、自定义约束、自定义校验器、国际化失败消息...)【享学Spring】
每篇一句 没有任何技术方案会是一种银弹,任何东西都是有利弊的 前言 一般来说,对于web项目我们都有必要对请求参数进行校验,有的前端使用JavaScript校验,但是为了安全起见后端的校验都是必须的. ...
- 【java集合框架源码剖析系列】java源码剖析之java集合中的折半插入排序算法
注:关于排序算法,博主写过[数据结构排序算法系列]数据结构八大排序算法,基本上把所有的排序算法都详细的讲解过,而之所以单独将java集合中的排序算法拿出来讲解,是因为在阿里巴巴内推面试的时候面试官问过 ...
- 线程java买火车票_Java线程中卖火车票问题的深入讲解
用java代码模拟卖100张火车票问题:四个售票窗口同时售票且不能卖出同一张火车票. 代码如下. package lesson; public class demo1 { public static ...
- SpringBoot中的Validator参数校验器——通过注解的方式控制controler接收参数的规则
前言 在日常的接口开发中,经常要对接口的参数做校验,例如,登录的时候要校验用户名密码是否为空.但是这种日常的接口参数校验太烦锁了,代码繁琐又多. Validator框架就是为了解决开发人员在开发的时候 ...
- SpringBoot中使用Hibernate Validator校验工具类
1.说明 在Spring Boot已经集成Hibernate Validator校验器的情况下, 对于配置了校验注解的请求参数, 框架会自动校验其参数, 但是如果想手动校验一个加了注解的普通对象, 比 ...
- java 护照校验,Java应用中的数据校验
翻译:叩丁狼教育吴嘉俊 [译者注:这篇文章是开源项目CUBA Platform的作者,在这篇文章中,作者阐述了CUBA平台中关于数据校验的设计思想和使用方式,可以作为大家在设计数据校验方面一个比较好的 ...
- Java开发中业务层入参校验详细解析
2019独角兽企业重金招聘Python工程师标准>>> 背景 首先,我们达成以下共识: 一个服务方法,如果入参太多,且基本为非pojo,会给调用方造成不必要的干扰.尽管可以把文档写的 ...
- 在Java SE中使用Hibernate Bean Validator
Bean Validation主页上指出:" Bean Validation是Java规范,-在Java SE中运行,但集成在Java EE(6和7)中." 这篇文章演示了如何在J ...
最新文章
- 分隔符怎么打出来_男孩地铁上打奶奶,踹爷爷:熊孩子都是怎么培养出来的?...
- 【SpringCloud】Ribbon-实例
- 内网更新服务器的搭建(WSUS)
- 是什么能让 APP 快速精准定位到我们的位置?
- UVA12298 Super Poker II(多项式/背包问题)
- [html] 渐进式渲染是什么?
- 学习linux/unix编程方法的建议[转]
- 使用Docker快速搭建FTP服务器
- GANs最新综述论文: 生成式对抗网络及其变种如何有用【附pdf下载】
- 开发常用常用插件介绍
- mysql replace 效率,MySQL replace实用场景 MySQL实现replace函数的几种实用场景
- mac系统如何转换python版本_Mac上如何切换python版本
- 树莓派4B配置远程桌面软件 Teamviewer(解决报错)
- 中国科学院计算机博士范,范习之 博士
- python autoit3自动化测试_autoit-解决非标准B/S自动化测试的一个很好的思路
- html 复制链接功能,h5分享功能[通过复制网页链接分享]
- Professional Microsoft Office SharePoint Designer 2007
- xshell免费版下载教程
- 写给自己:入职两个月的收获与变化
- visual studio2019 切换英文语言版本
热门文章
- CSDN博客中图片上的水印
- OneNote的介绍及安装教程
- 计算机专业与等差数列的联系,等差数列前n项和公式说课稿讲述.ppt
- 基站|WIFI|LBS定位|经纬度|查询|API接口
- 01-座舱IVI关键技术点
- yyyyMMddhhmmss(20140707103709)转换为yyyy-MM-dd HH:mm:ss(2014-07-07 10:37:09)
- dds:subscribe:DataReader
- 猿创征文|活在大二,前端的我勇往直前
- Linux下块驱动(总结)和源码解析
- 如何将二维空间先验注入到ViT中? UMA港理工阿里提出SP-ViT,为视觉Transformer学习2D空间先验知识!...