springboot使用hibernate validation对参数校验的实现方法

2023-07-07 15:26:03 323

springboot天生支持使用hibernatevalidation对参数的优雅校验，如果不使用它，只能对参数挨个进行如下方式的手工校验，不仅难看，使用起来还很不方便：

if(StringUtils.isEmpty(userName)){
	thrownewRuntimeException("用户名不能为空");
}

下面将介绍hibernatevalidation的基本使用方法。

一、引入依赖

这里在springboot2.4.1中进行实验，引入以下依赖：


org.springframework.boot
spring-boot-starter-parent
2.4.1





org.springframework.boot
spring-boot-starter-web



org.springframework.boot
spring-boot-starter-test
test


org.projectlombok
lombok
1.18.16


org.hibernate.validator
hibernate-validator
6.1.6.Final

二、基本请求参数校验

如下的一个springmvc的请求调用中有一个id参数（Integer类型），如果不允许它为空，该怎么做

在Controller上加上@Validated注解
在需要校验的字段前面加上@NotNull(message="用户id不能为空")注解
定义全局异常处理类，定制化返回结果

@RestControllerAdvice
@Slf4j
publicclassValidationAdvice{

@ExceptionHandler(Exception.class)
@ResponseBody
publicWrapperResulthandler(Exceptione){
//获取异常信息,获取异常堆栈的完整异常信息
StringWritersw=newStringWriter();
PrintWriterpw=newPrintWriter(sw);
e.printStackTrace(pw);
//日志输出异常详情
log.error(sw.toString());
returnWrapperResult.faild("服务异常，请稍后再试");
}

@ExceptionHandler(ConstraintViolationException.class)
@ResponseBody
publicWrapperResulthandler(ConstraintViolationExceptione){
StringBuffererrorMsg=newStringBuffer();
Set>violations=e.getConstraintViolations();
violations.forEach(x->errorMsg.append(x.getMessage()).append(";"));
returnWrapperResult.faild(errorMsg.toString());
}
}

Controller层代码如下所示：

@RestController
@Slf4j
@RequestMapping("/user")
@Validated
publicclassUserController{

/**
*根据id查询用户信息
*
*@paramid
*@return
*/
@GetMapping
publicWrapperResultfindUser(@NotNull(message="用户id不能为空")
@RequestParam(value="id")
Stringid){
returnWrapperResult.success(newUserModel());
}
}

如果发起请求127.0.0.1:8080/user?id=则会返回结果

{
"status":1,
"data":"用户id不能为空;",
"msg":"FAIL",
"success":false
}

三、对象内参数校验

上面是GET请求，下面介绍POST请求，请求对象内的参数校验。

1.Controller类上加上@Validated注解

@RestController
@Slf4j
@RequestMapping("/user")
**@Validated**
publicclassUserController{
}

2.在POST请求方法参数前面加上@Validated注解

@PostMapping("/mobile-regist")
publicWrapperResultmobileRegit(@Validated@RequestBodyUserModeluserModel){
returnWrapperResult.success(true);
}

3.在上面介绍的ValidationAdvice类中加上对象参数校验异常捕获

//处理校验异常，对于对象类型的数据的校验异常
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseBody
publicWrapperResulthandler(MethodArgumentNotValidExceptione){
StringBuffersb=newStringBuffer();
ListallErrors=e.getBindingResult().getAllErrors();
allErrors.forEach(msg->sb.append(msg.getDefaultMessage()).append(";"));
returnWrapperResult.faild(sb.toString());
}

UserModel类的定义如下：

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain=true)
publicclassUserModel{

@NotEmpty(message="姓名不能为空")
privateStringname;

@NotEmpty(message="手机号不能为空")
//@Mobile(message="手机号格式不正确")
privateStringmobile;

@NotEmpty(message="电子邮箱不能为空")
	@Email(message="电子邮箱格式不正确")
privateStringemail;

privateStringpassword;

privateStringaddress;

@NotNull(message="年龄不能为空")
@Min(value=12,message="允许注册年龄最小为12岁")
@Max(value=24,message="允许年龄最大为24岁")
privateIntegerage;

@NotEmpty(message="联系人不允许为空")
@Size(min=1,max=3,message="联系人长度只允许1到3之间")
privateListcontacts;
}

如果POST请求如下所示

{
"name":"",
"mobile":"12666666666",
"email":"",
"password":"",
"address":"",
"age":null,
"contacts":[

]
}

则会返回如下定制化返回结果：

{
"status":1,
"data":"电子邮箱不能为空;联系人长度只允许1到3之间;年龄不能为空;联系人不允许为空;姓名不能为空;手机号格式不正确;",
"msg":"FAIL",
"success":false
}

四、自定义校验器

像是@NotNull、@Email等注解都是hibernatevalidation内置的注解，我们想开发像是@Email注解一样功能的注解，如何做呢，比如@Mobile，它的使用方法将和@Email一模一样。

首先，先定义一个工具类存放ValidationUtil两个常量值

publicclassValidationUtil{
//手机号校验正则
publicstaticfinalStringMOBILE_REGX="^[1][3-9][0-9]{9}$";

publicstaticfinalStringMOBILE_MSG="手机号格式错误";
}

1.定义注解Mobile

具体代码可以参考@Email的实现，直接将Email名字改成Mobile即可，如下所示：

@Documented
@Target({METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER,TYPE_USE})
@Retention(RUNTIME)
public@interfaceMobile{

Stringmessage()defaultValidationUtil.MOBILE_MSG;

Class[]groups()default{};

Class[]payload()default{};

Stringregexp()defaultValidationUtil.MOBILE_REGX;

Pattern.Flag[]flags()default{};

@Target({METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER,TYPE_USE})
@Retention(RUNTIME)
@Documented
public@interfaceList{
Mobile[]value();
}
}

2.定义MobileValidator实现对参数的校验逻辑

publicclassMobileValidatorimplementsConstraintValidator{

privateStringregexp;

@Override
publicvoidinitialize(MobileconstraintAnnotation){
//获取校验的手机号的格式
this.regexp=constraintAnnotation.regexp();
}

@Override
publicbooleanisValid(Stringvalue,ConstraintValidatorContextcontext){
if(!StringUtils.hasText(value)){
returntrue;
}
returnvalue.matches(regexp);
}
}

3.使用方法和@Email一模一样

不赘述

五、分组校验

假设一个用户注册的场景，用户注册有三种方式

用户名+图形验证码注册
邮箱+邮箱验证码注册
手机号+短信验证码注册

用户注册的时候除了方式不一样，其他用户信息基本相同，后端开了三个接口对应着着三种注册方式，请求体中我们使用一个Model封装了以上所有信息，包含着用户名、邮箱、手机号等信息，这时候不同的接口被调用，model中需要校验的参数就不一样了：

用户名注册的时候邮箱地址和手机号可以为空，但是用户名不能为空；通过邮箱注册的时候，邮箱地址不能为空，但是用户名和手机号可以为空；......

分组校验专门应对这种情况。

1.首先定义三个接口，表示三种组类别

publicinterfaceValidEmail{
}

publicinterfaceValidMobile{
}

publicinterfaceValidUserName{
}

2.在UserModel实体类上指名组类别

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain=true)
publicclassUserModel{

@NotEmpty(message="姓名不能为空",groups={ValidUserName.class})
@UserName(groups={ValidUserName.class})
privateStringname;

@NotEmpty(message="手机号不能为空",groups={ValidMobile.class})
@Mobile(groups={ValidMobile.class})
privateStringmobile;

@NotEmpty(message="电子邮箱不能为空",groups={ValidEmail.class})
@Email(message="电子邮箱格式不正确",groups={ValidEmail.class})
privateStringemail;

privateStringpassword;

privateStringaddress;

@NotNull(message="年龄不能为空")
@Min(value=12,message="允许注册年龄最小为12岁",groups={ValidEmail.class,ValidMobile.class,ValidUserName.class})
@Max(value=24,message="允许年龄最大为24岁",groups={ValidEmail.class,ValidMobile.class,ValidUserName.class})
privateIntegerage;

@NotEmpty(message="联系人不允许为空",groups={ValidEmail.class,ValidMobile.class,ValidUserName.class})
@Size(min=1,max=3,message="联系人长度只允许1到3之间",groups={ValidEmail.class,ValidMobile.class,ValidUserName.class})
privateListcontacts;
}

3.Controller方法上指名验证组别

/**
*手机号注册
*
*@paramuserModel
*@return
*/
@PostMapping("/mobile-regist")
publicWrapperResultmobileRegit(@Validated(ValidMobile.class)@RequestBodyUserModeluserModel){
returnWrapperResult.success(true);
}

这时候进行如下请求：

POSThttp://127.0.0.1:8080/user/mobile-regist

{
"mobile":"12666666666",
"password":"",
"address":"",
"age":null,
"contacts":[

]

}

则会返回结果：

{
"status":1,
"data":"联系人长度只允许1到3之间;手机号格式错误;联系人不允许为空;",
"msg":"FAIL",
"success":false
}

该请求中并没有传递email和username字段，而且结果中也未校验出这两个字段，符合预期结果。

六、手动校验

此处的手动校验并非是使用if/else进行简单的手动校验，而是使用Validation自带的校验工具对使用了@NotNull等注解的实体对象进行属性校验。

首先先获取Valiation对象：

privatestaticfinalValidatorvalidator=Validation.buildDefaultValidatorFactory().getValidator();

1.全属性校验

/**
*验证某个对象所有字段
*
*@paramobj
*@param
*@return
*/
publicstaticValidationResultvalidateEntity(Tobj){
ValidationResultresult=newValidationResult();
Set>set=validator.validate(obj,Default.class);
if(!CollectionUtils.isEmpty(set)){
result.setHasErrors(true);
MaperrorMsg=newHashMap<>();
for(ConstraintViolationcv:set){
errorMsg.put(cv.getPropertyPath().toString(),cv.getMessage());
}
result.setErrorMsg(errorMsg);
}
returnresult;
}

2.某个字段的单独校验

/**
*验证某个对象某个字段
*
*@paramobj
*@parampropertyName
*@param
*@return
*/
publicstaticValidationResultvalidateProperty(Tobj,StringpropertyName){
ValidationResultresult=newValidationResult();
Set>set=validator.validateProperty(obj,propertyName,Default.class);
if(!CollectionUtils.isEmpty(set)){
result.setHasErrors(true);
MaperrorMsg=newHashMap<>();
for(ConstraintViolationcv:set){
errorMsg.put(propertyName,cv.getMessage());
}
result.setErrorMsg(errorMsg);
}
returnresult;
}

ValidationResult的定义如下：

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain=true)
publicclassValidationResult{
privateBooleanhasErrors;
privateMaperrorMsg;
}

七、文件上传校验

1.tomcat容器下文件上传校验

在springboot+tomcat架构下的文件上传校验，假如已经有了如下的配置：

spring:
servlet:
multipart:
max-file-size:1MB
max-request-size:1MB

这表示只允许上传小于1MB大小的文件，如果不指定异常处理器，默认会报前端400，在ValidationAdvice类中添加如下代码可以自定义返回结果：

//文件上传文件大小超出限制
@ExceptionHandler(MaxUploadSizeExceededException.class)
@ResponseBody
publicWrapperResult>fileSizeException(MaxUploadSizeExceededExceptionexception){
log.error("文件太大，上传失败",exception);
returnWrapperResult.faild("只允许上传不大于"+exception.getMaxUploadSize()+"的文件");
}

2.其它容器

在Jetty容器中1中的方法可能会失效，未验证；在undertow容器中是一定会失效，已经验证。undertow容器毕竟和spring-boot没有完全打磨好，不建议现阶段使用。

八、附录

1.所有校验规则注解说明

注解	说明
@Null	被注解的元素必须为空
@NotNull	被注解的元素必须不为空
@AssertTrue	被注解的元素必须为true
@AssertFlase	被注解的元素必须为false
@Min(value)	被注解的元素必须是数字，且必须大于指定的最小值
@Max(value)	被注解的元素必须是数字，且必须小于指定的最大值
@DecimalMin(value)	被注解的元素必须是数字，且必须大于指定的最小值
@DecaimalMax(value)	被注解的元素必须是数字，且必须小于指定的最大值
@Size(max=,min=)	被注解元素的大小必须在指定的范围内
@Digit(integer,fraction)	被注解元素必须是数字，且其值必须在可接受的范围内
@Past	被注解元素必须是一个过去的日期
@Futrue	被注解元素必须是一个将来的日期
@Pattern(regex=,flag=)	被注解元素必须符合指定的正则表达式
@NotBlank	验证非空，且长度必须大于0
@Email	被注解的元素必须是电子邮件地址
@Length(max=,min=)	被注解的字符串大小必须在指定的范围内
@NotEmpty	被注解的字符串必须非空
@Range(max=,min=)	被注解的元素必须在指定范围内

2.校验规则注解例子

//空和非空检查:@Null、@NotNull、@NotBlank、@NotEmpty
@Null(message="验证是否为null")
privateIntegerisNull;

@NotNull(message="验证是否不为null,但无法查检长度为0的空字符串")
privateIntegerid;

@NotBlank(message="检查字符串是不是为null，以及去除空格后长度是否大于0")
privateStringname;

@NotEmpty(message="检查是否为NULL或者是EMPTY")
privateListstringList;

//Boolean值检查:@AssertTrue、@AssertFalse
@AssertTrue(message="验证Boolean参数是否为true")
privateBooleanisTrue;

@AssertFalse(message="验证Boolean参数是否为false")
privateBooleanisFalse;

//长度检查:@Size、@Length
@Size(min=1,max=2,message="验证（Array,Collection,Map,String）长度是否在给定范围内")
privateListintegerList;

@Length(min=8,max=30,message="验证字符串长度是否在给定范围内")
privateStringaddress;

//日期检查:@Future、@FutureOrPresent、@Past、@PastOrPresent
@Future(message="验证日期是否在当前时间之后")
privateDatefutureDate;

@FutureOrPresent(message="验证日期是否为当前时间或之后")
privateDatefutureOrPresentDate;

@Past(message="验证日期是否在当前时间之前")
privateDatepastDate;

@PastOrPresent(message="验证日期是否为当前时间或之前")
privateDatepastOrPresentDate;

//其它检查:@Email、@CreditCardNumber、@URL、@Pattern、
@ScriptAssert、@UniqueElements
@Email(message="校验是否为正确的邮箱格式")
privateStringemail;

@CreditCardNumber(message="校验是否为正确的信用卡号")
privateStringcreditCardNumber;

@URL(protocol="http",host="127.0.0.1",port=8080,message="校验是否为正确的URL地址")
privateStringurl;

@Pattern(regexp="^1[3|4|5|7|8][0-9]{9}$",message="正则校验是否为正确的手机号")
privateStringphone;

//对关联对象元素进行递归校验检查
@Valid
@UniqueElements(message="校验集合中的元素是否唯一")
privateListcalendarEvent;

@Data
@ScriptAssert(lang="javascript",script="_this.startDate.before(_this.endDate)",message="通过脚本表达式校验参数")
privateclassCalendarEvent{
privateDatestartDate;
privateDateendDate;
}

//数值检查:@Min、@Max、@Range、@DecimalMin、@DecimalMax、@Digits
@Min(value=0,message="验证数值是否大于等于指定值")
@Max(value=100,message="验证数值是否小于等于指定值")
@Range(min=0,max=100,message="验证数值是否在指定值区间范围内")
privateIntegerscore;

@DecimalMin(value="10.01",inclusive=false,message="验证数值是否大于等于指定值")
@DecimalMax(value="199.99",message="验证数值是否小于等于指定值")
@Digits(integer=3,fraction=2,message="限制整数位最多为3，小数位最多为2")
privateBigDecimalmoney;

九、源代码地址

https://gitee.com/kdyzm/validation-spring-boot-demo

到此这篇关于spring-boot使用hibernatevalidation对参数进行优雅的校验的文章就介绍到这了,更多相关spring-boot校验参数内容请搜索毛票票以前的文章或继续浏览下面的相关文章希望大家以后多多支持毛票票！