SpringBoot参数怎么校验(springboot,开发技术)

使用传统方式的弊端

publicStringaddUser(Useruser){if(user==null||user.getId()==null||user.getAccount()==null||user.getPassword()==null||user.getEmail()==null){return"对象或者对象字段不能为空";}if(StringUtils.isEmpty(user.getAccount())||StringUtils.isEmpty(user.getPassword())||StringUtils.isEmpty(user.getEmail())){return"不能输入空字符串";}if(user.getAccount().length()<6||user.getAccount().length()>11){return"账号长度必须是6-11个字符";}if(user.getPassword().length()<6||user.getPassword().length()>16){return"密码长度必须是6-16个字符";}if(!Pattern.matches("^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$",user.getEmail())){return"邮箱格式不正确";}//参数校验完毕后这里就写上业务逻辑return"success";}

这样做确实没有什么问题,而且排版也工整,但代码太繁琐了,如果有几十个字段要校验,那这个方法里面将会变得非常臃肿,实在不够优雅。下面我们就来讲讲如何使用最优雅的方式来解决。

引入依赖

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId></dependency>

注解说明

注解说明@AssertFalse被注解的元素必须为 false@AssertTrue被注解的元素必须为 true@DecimalMax(value)被注解的元素必须是一个数字，其值必须小于等于指定的最大值@DecimalMin(value)被注解的元素必须是一个数字，其值必须大于等于指定的最小值@Digits (integer, fraction)被注解的元素必须是一个数字，其值必须在可接受的范围内@Null被注解的元素必须为空@NotNull被注解的元素必须不为空@Min(value)被注解的元素必须是一个数字，其值必须大于等于指定的最大值@Max(value)被注解的元素必须是一个数字，其值必须小于等于指定的最大值@Size(max, min)被注解的元素的长度必须在指定的范围内@Past被注解的元素必须是一个过去的日期@Future被注解的元素必须是一个未来的日期@Pattern(value)被注解的元素必须符合指定的正则表达式

下面我们以此来在业务中实现

一、对实体类进行校验

1、entity

@DatapublicclassUser{@NotNull(message="用户id不能为空")privateLongid;@NotNull(message="用户账号不能为空")@Size(min=6,max=11,message="账号长度必须是6-11个字符")privateStringaccount;@NotNull(message="用户密码不能为空")@Size(min=6,max=11,message="密码长度必须是6-16个字符")privateStringpassword;@NotNull(message="用户邮箱不能为空")@Email(message="邮箱格式不正确")privateStringemail;}

2、controller

@RestControllerpublicclassUserController{@PostMapping("/addUser")publicvoidaddUser(@RequestBody@ValidUseruser){ //业务}}

3、编写全局统一异常处理

importorg.springframework.validation.ObjectError;importorg.springframework.web.bind.MethodArgumentNotValidException;importorg.springframework.web.bind.annotation.ExceptionHandler;importorg.springframework.web.bind.annotation.RestControllerAdvice;importjavax.validation.ConstraintViolation;importjavax.validation.ConstraintViolationException;importjava.util.stream.Collectors;/***全局异常处理**@authormaster*/@RestControllerAdvicepublicclassExceptionConfig{/***参数为实体类*@parame*@return*/@ExceptionHandler(value=MethodArgumentNotValidException.class)publicStringhandleValidException(MethodArgumentNotValidExceptione){//从异常对象中拿到ObjectError对象ObjectErrorobjectError=e.getBindingResult().getAllErrors().get(0);//然后提取错误提示信息进行返回returnobjectError.getDefaultMessage();}/***参数为单个参数或多个参数*@parame*@return*/@ExceptionHandler(value=ConstraintViolationException.class)publicStringhandleConstraintViolationException(ConstraintViolationExceptione){//从异常对象中拿到ObjectError对象returne.getConstraintViolations().stream().map(ConstraintViolation::getMessage) .collect(Collectors.toList()).get(0);}}

然后我们使用apipost测试

二、针对单个参数进行校验

importorg.springframework.validation.annotation.Validated;importorg.springframework.web.bind.annotation.GetMapping;importorg.springframework.web.bind.annotation.PostMapping;importorg.springframework.web.bind.annotation.RestController;importjavax.validation.constraints.NotNull;@RestController@ValidatedpublicclassTestController{@GetMapping("/test")publicvoidtest(@NotNull(message="id不能为空")Integerid){}}

然后我们使用apipost测试

三、分组校验

场景:在新增时我们需要id为空,但修改时我们又需要id不为空,总不可能搞两个类吧,这时候分组校验的用处就来了

1、entity

importlombok.Data;importjavax.validation.constraints.Email;importjavax.validation.constraints.NotNull;importjavax.validation.constraints.Size;@DatapublicclassUser{publicinterfaceInsert{}publicinterfaceUpdate{}@NotNull(message="用户id不能为空",groups=Update.class)@Null(message="用户id必须为空",groups=Integer.class)privateLongid;privateStringaccount;privateStringpassword;privateStringemail;}

2、controller

@PostMapping("/add")publicvoidadd(@RequestBody@Validated(User.Insert.class)Useruser){}

添加时就用User.Insert.class,修改时就用User.Update.class

四、自定义分组校验

场景:当type为1时,需要参数a不为空,当type为2时,需要参数b不为空。

1、entity

importcom.example.demo.provider.CustomSequenceProvider;importlombok.Data;importorg.hibernate.validator.group.GroupSequenceProvider;importjavax.validation.constraints.NotEmpty;importjavax.validation.constraints.Pattern;@Data@GroupSequenceProvider(value=CustomSequenceProvider.class)publicclassCustomGroup{/***类型*/@Pattern(regexp="[A|B]",message="类型不必须为A|B")privateStringtype;/***参数A*/@NotEmpty(message="参数A不能为空",groups={WhenTypeIsA.class})privateStringparamA;/***参数B*/@NotEmpty(message="参数B不能为空",groups={WhenTypeIsB.class})privateStringparamB;/***分组A*/publicinterfaceWhenTypeIsA{}/***分组B*/publicinterfaceWhenTypeIsB{}}

2、CustomSequenceProvider

importcom.example.demo.controller.CustomGroup;importorg.hibernate.validator.spi.group.DefaultGroupSequenceProvider;importjava.util.ArrayList;importjava.util.List;publicclassCustomSequenceProviderimplementsDefaultGroupSequenceProvider<CustomGroup>{@OverridepublicList<Class<?>>getValidationGroups(CustomGroupform){List<Class<?>>defaultGroupSequence=newArrayList<>();defaultGroupSequence.add(CustomGroup.class);if(form!=null&&"A".equals(form.getType())){defaultGroupSequence.add(CustomGroup.WhenTypeIsA.class);}if(form!=null&&"B".equals(form.getType())){defaultGroupSequence.add(CustomGroup.WhenTypeIsB.class);}returndefaultGroupSequence;}}

3、controller

@PostMapping("/add")publicvoidadd(@RequestBody@ValidatedCustomGroupuser){}

五、自定义校验

虽然官方提供的校验注解已经满足很多情况了,但还是无法满足我们业务的所有需求,比如校验手机号码,下面我就以校验手机号码来做一个示例。

1、定义校验注解

@Target({ElementType.FIELD})@Retention(RetentionPolicy.RUNTIME)@Constraint(validatedBy=PhoneValidator.class)public@interfacePhone{Stringmessage()default"手机号码格式有误";Class<?>[]groups()default{};Class<?extendsPayload>[]payload()default{};}

注:groups和payload是必须要写的,Constraint是使用哪个类来进行校验。

2、实现注解

importjavax.validation.ConstraintValidator;importjavax.validation.ConstraintValidatorContext;importjava.util.regex.Pattern;/***@authormaster*/publicclassPhoneValidatorimplementsConstraintValidator<Phone,Object>{@OverridepublicbooleanisValid(Objecttelephone,ConstraintValidatorContextconstraintValidatorContext){Stringpattern="^1[3|4|5|6|7|8|9]\\d{9}$";returnPattern.matches(pattern,telephone.toString());}}

最后直接用到参数前面或者实体类变量上面即可。

六、嵌套校验

当某个对象中还包含了对象需要进行校验,这个时候我们需要用嵌套校验。

@DatapublicclassTestAA{@NotEmpty(message="id不能为空")privateStringid;@NotNull@ValidprivateJobjob;@DatapublicclassJob{@NotEmpty(message="content不能为空")privateStringcontent;}}

七、快速失败

Spring Validation默认会校验完所有字段，然后才抛出异常。可以通过配置，开启Fali Fast模式，一旦校验失败就立即返回。

importorg.hibernate.validator.HibernateValidator;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;importjavax.validation.Validation;importjavax.validation.Validator;importjavax.validation.ValidatorFactory;@ConfigurationpublicclassFailFastConfig{@BeanpublicValidatorvalidator(){ValidatorFactoryvalidatorFactory=Validation.byProvider(HibernateValidator.class).configure()//快速失败模式.failFast(true).buildValidatorFactory();returnvalidatorFactory.getValidator();}}

注意事项

SpringBoot 2.3.x 移除了validation依赖需要手动引入依赖。

 </div> <div class="zixun-tj-product adv-bottom"></div> </div> </div> <div class="prve-next-news">