SpringBoot开发秘籍-集成参数校验及高阶技巧

[[400097]]

永川网站制作公司哪家好，找成都创新互联公司！从网页设计、网站建设、微信开发、APP开发、响应式网站等网站项目制作，到程序开发，运营维护。成都创新互联公司2013年开创至今到现在10年的时间，我们拥有了丰富的建站经验和运维经验，来保证我们的工作的顺利进行。专注于网站建设就选成都创新互联公司。

本文转载自微信公众号「JAVA日知录」，作者单一色调。转载本文请联系JAVA日知录公众号。

对于 web服务来说，为防止非法参数对业务造成影响，在 Controller层一定要对参数进行校验!本章我们以SpringBoot项目为例，介绍参数校验的基本用法以及一些高级技巧，希望能对你有所帮助。

简单使用

1.要在Springboot项目中加入参数校验功能首先得加入spring-boot-starter-validation依赖

 
 
 
 
    
  
  
  
  
  1.  
    2.   
  
  
  
  2.  org.springframework.boot 
    3.   
  
  
  
  3.  spring-boot-starter-validation 
    4.   
  
  
  
  4.  
    5.

2.然后给需要校验的字段添加上约束性注解，如我们对实体类参数进行校验

 
 
 
 
    
  
  
  
  
  1. @Data 
    2.   
  
  
  
  2. public class ValidEntity{ 
    3.   
  
  
  
  3.     private int id; 
    4.   
  
  
  
  4.     @NotBlank 
    5.   
  
  
  
  5.     private String appId; 
    6.   
  
  
  
  6.    
    7.   
  
  
  
  7.     @NotBlank 
    8.   
  
  
  
  8.     private String name; 
    9.   
  
  
  
  9.    
    10.   
  
  
  
  10.     @Email 
    11.   
  
  
  
  11.     private String email; 
    12.   
  
  
  
  12. } 
    13.

常见约束注解如下：

注解 功能
@AssertFalse 可以为null,如果不为null的话必须为false
@AssertTrue 可以为null,如果不为null的话必须为true
@DecimalMax 设置不能超过最大值
@DecimalMin 设置不能超过最小值
@Digits 设置必须是数字且数字整数的位数和小数的位数必须在指定范围内
@Future 日期必须在当前日期的未来
@Past 日期必须在当前日期的过去
@Max 最大不得超过此最大值
@Min 最大不得小于此最小值
@NotNull 不能为null，可以是空
@Null 必须为null
@Pattern 必须满足指定的正则表达式
@Size 集合、数组、map等的size()值必须在指定范围内
@Email 必须是email格式
@Length 长度必须在指定范围内
@NotBlank 字符串不能为null,字符串trim()后也不能等于“”
@NotEmpty 不能为null，集合、数组、map等size()不能为0；字符串trim()后可以等于“”
@Range 值必须在指定范围内
@URL 必须是一个URL

注：此表格只是简单的对注解功能的说明，并没有对每一个注解的属性进行说明;可详见源码。

3.在Controller层对需要参数校验的方法加上@Validated注解

参数校验一般分为两类：在Controller使用模型接收数据时， @Validated注解直接放在该模型参数前即可。

 
 
 
 
    
  
  
  
  
  1. @PostMapping(value = "test1") 
    2.   
  
  
  
  2. public String test1(@Validated @RequestBody ValidEntity validEntity){ 
    3.   
  
  
  
  3.  return "test1 valid success"; 
    4.   
  
  
  
  4. } 
    5.   
  
  
  
  5.  
    6.   
  
  
  
  6. @PostMapping(value = "test3") 
    7.   
  
  
  
  7. public String test3(@Validated ValidEntity validEntity){ 
    8.   
  
  
  
  8.  return "test3 valid success"; 
    9.   
  
  
  
  9. } 
    10.

当我们是直接在Controller层中的参数前，使用约束注解时，@Validated要直接放在类上

 
 
 
 
    
  
  
  
  
  1. @PostMapping(value = "test2") 
    2.   
  
  
  
  2. public String test2(@Email String email){ 
    3.   
  
  
  
  3.     return "test2 valid success"; 
    4.   
  
  
  
  4. } 
    5.

此时需要在主类上增加@Validated注解

 
 
 
 
    
  
  
  
  
  1. @Validated 
    2.   
  
  
  
  2. @RestController 
    3.   
  
  
  
  3. @RequestMapping("/demo/valid") 
    4.   
  
  
  
  4. public class ValidController { 
    5.   
  
  
  
  5.  ... 
    6.   
  
  
  
  6. } 
    7.

在参数校验时我们既可以使用@Validated也可以使用@Valid注解，两者功能大部分类似;

主要区别在于：

@Valid属于javax下的，而@Validated属于spring下;

@Valid支持嵌套校验、而@Validated不支持，@Validated支持分组，而@Valid不支持。

统一异常处理

如果参数校验未通过Spring会抛出三种类型的异常

1.当对@RequestBody需要的参数进行校验时会出现org.springframework.web.bind.MethodArgumentNotValidException

当直接校验具体参数时会出现javax.validation.ConstraintViolationException，也属于ValidationException异常

当直接校验对象时会出现org.springframework.validation.BindException

在SpringBoot中统一拦截处理只需要在配置类上添加 @RestControllerAdvice注解，然后在具体方法中通过 @ExceptionHandler指定需要处理的异常，具体代码如下：

 
 
 
 
    
  
  
  
  
  1. @RestControllerAdvice 
    2.   
  
  
  
  2. @Slf4j 
    3.   
  
  
  
  3. public class GlobalExceptionHandler { 
    4.   
  
  
  
  4.     public static final String ERROR_MSG = "系统异常，请联系管理员。"; 
    5.   
  
  
  
  5.  
    6.   
  
  
  
  6.     @ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class}) 
    7.   
  
  
  
  7.     public ResponseEntity> handleValidatedException(Exception e) { 
    8.   
  
  
  
  8.         Result resp = null; 
    9.   
  
  
  
  9.  
    10.   
  
  
  
  10.         if (e instanceof MethodArgumentNotValidException) { 
    11.   
  
  
  
  11.             // BeanValidation exception 
    12.   
  
  
  
  12.             MethodArgumentNotValidException ex = (MethodArgumentNotValidException) e; 
    13.   
  
  
  
  13.             resp = new Result<>(Integer.toString(HttpStatus.BAD_REQUEST.value()), 
    14.   
  
  
  
  14.                     ex.getBindingResult().getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.joining(", ")) 
    15.   
  
  
  
  15.                     , getStackTrace(ex)); 
    16.   
  
  
  
  16.         } else if (e instanceof ConstraintViolationException) { 
    17.   
  
  
  
  17.             // BeanValidation GET simple param 
    18.   
  
  
  
  18.             ConstraintViolationException ex = (ConstraintViolationException) e; 
    19.   
  
  
  
  19.             resp = new Result<>(Integer.toString(HttpStatus.BAD_REQUEST.value()), 
    20.   
  
  
  
  20.                     ex.getConstraintViolations().stream().map(ConstraintViolation::getMessage).collect(Collectors.joining(", ")) 
    21.   
  
  
  
  21.                     , getStackTrace(ex)); 
    22.   
  
  
  
  22.         } else if (e instanceof BindException) { 
    23.   
  
  
  
  23.             // BeanValidation GET object param 
    24.   
  
  
  
  24.             BindException ex = (BindException) e; 
    25.   
  
  
  
  25.             resp = new Result<>(Integer.toString(HttpStatus.BAD_REQUEST.value()), 
    26.   
  
  
  
  26.                     ex.getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.joining(", ")) 
    27.   
  
  
  
  27.                     , getStackTrace(ex)); 
    28.   
  
  
  
  28.         } 
    29.   
  
  
  
  29.  
    30.   
  
  
  
  30.         return new ResponseEntity<>(resp,HttpStatus.BAD_REQUEST); 
    31.   
  
  
  
  31.     } 
    32.   
  
  
  
  32.  
    33.   
  
  
  
  33.  
    34.   
  
  
  
  34.     private String getStackTrace(Exception e) { 
    35.   
  
  
  
  35.         //打印日志开关，可通过配置读取 
    36.   
  
  
  
  36.         boolean printStrackTrace = false; 
    37.   
  
  
  
  37.         if(printStrackTrace){ 
    38.   
  
  
  
  38.             StringWriter sw = new StringWriter(); 
    39.   
  
  
  
  39.             e.printStackTrace(new PrintWriter(sw)); 
    40.   
  
  
  
  40.             return sw.toString(); 
    41.   
  
  
  
  41.         }else{ 
    42.   
  
  
  
  42.             return ERROR_MSG; 
    43.   
  
  
  
  43.         } 
    44.   
  
  
  
  44.  
    45.   
  
  
  
  45.     } 
    46.   
  
  
  
  46.  
    47.   
  
  
  
  47. } 
    48.

最终实现效果如下：

参数分组

有下面一个实体类，我们需要对其进行参数校验。

 
 
 
 
    
  
  
  
  
  1. @Data 
    2.   
  
  
  
  2. public class ValidEntity { 
    3.   
  
  
  
  3.     private int id; 
    4.   
  
  
  
  4.  
    5.   
  
  
  
  5.     @NotBlank 
    6.   
  
  
  
  6.     private String appId; 
    7.   
  
  
  
  7.  
    8.   
  
  
  
  8.     @NotBlank 
    9.   
  
  
  
  9.     private String name; 
    10.   
  
  
  
  10.  
    11.   
  
  
  
  11.     @Email 
    12.   
  
  
  
  12.     private String email; 
    13.   
  
  
  
  13. } 
    14.

但是实际业务是在编辑的时候 appId才是必填，在新增的时候 name必填，这时候可以用groups分组功能来实现：同一个模型在不同场景下，动态区分校验模型中的不同字段。

使用方式

首先我们定义一个分组接口ValidGroup，再在分组接口总定义出多个不同的操作类型，Create，Update，Query，Delete

 
 
 
 
    
  
  
  
  
  1. public interface ValidGroup extends Default{ 
    2.   
  
  
  
  2.    
    3.   
  
  
  
  3.     interface Crud extends ValidGroup{ 
    4.   
  
  
  
  4.        
    5.   
  
  
  
  5.         interface Create extends Crud{ 
    6.   
  
  
  
  6.  
    7.   
  
  
  
  7.         } 
    8.   
  
  
  
  8.      
    9.   
  
  
  
  9.         interface Update extends Crud{ 
    10.   
  
  
  
  10.  
    11.   
  
  
  
  11.         } 
    12.   
  
  
  
  12.        
    13.   
  
  
  
  13.         interface Query extends Crud{ 
    14.   
  
  
  
  14.  
    15.   
  
  
  
  15.         } 
    16.   
  
  
  
  16.    
    17.   
  
  
  
  17.         interface Delete extends Crud{ 
    18.   
  
  
  
  18.  
    19.   
  
  
  
  19.         } 
    20.   
  
  
  
  20.     } 
    21.   
  
  
  
  21. } 
    22.

这里的 ValidGroup继承了Default，当然也可以不继承，具体区别我们后面再说。

在模型中给校验参数分配分组

 
 
 
 
    
  
  
  
  
  1. @Data 
    2.   
  
  
  
  2. @ApiModel(value="ValidEntity") 
    3.   
  
  
  
  3. public class ValidEntity { 
    4.   
  
  
  
  4.     private int id; 
    5.   
  
  
  
  5.  
    6.   
  
  
  
  6.     @NotBlank(groups = ValidGroup.Crud.Update.class) 
    7.   
  
  
  
  7.     private String appId; 
    8.   
  
  
  
  8.  
    9.   
  
  
  
  9.     @NotBlank(groups = ValidGroup.Crud.Create.class) 
    10.   
  
  
  
  10.     private String name; 
    11.   
  
  
  
  11.  
    12.   
  
  
  
  12.     @Email 
    13.   
  
  
  
  13.     private String email; 
    14.   
  
  
  
  14. } 
    15.

tips：这里@Email注解未指定分组，默认会属于Default分组，appId和name指定了分组就不会再属于Default分组了。

在参数校验时通过value属性指定分组

这里通过 @Validated(value = ValidGroup.Crud.Update.class)指定了具体的分组，上面提到的是否继承Default的区别在于：

如果继承了Default，@Validated标注的注解也会校验未指定分组或者Default分组的参数，比如email

如果不继承Default则不会校验未指定分组的参数，需要加上@Validated(value = {ValidGroup.Crud.Update.class, Default.class}才会校验

快速失败(Fali Fast)

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

 
 
 
 
    
  
  
  
  
  1. @Configuration 
    2.   
  
  
  
  2. public class ValidatedConfig { 
    3.   
  
  
  
  3.  
    4.   
  
  
  
  4.     @Bean 
    5.   
  
  
  
  5.     public Validator validator() { 
    6.   
  
  
  
  6.         ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class) 
    7.   
  
  
  
  7.                 .configure() 
    8.   
  
  
  
  8.                 // 快速失败模式 
    9.   
  
  
  
  9.                 .failFast(true) 
    10.   
  
  
  
  10.                 .buildValidatorFactory(); 
    11.   
  
  
  
  11.         return validatorFactory.getValidator(); 
    12.   
  
  
  
  12.     } 
    13.   
  
  
  
  13. } 
    14.

以上，希望对你有所帮助!

 

网站名称：SpringBoot开发秘籍-集成参数校验及高阶技巧
本文路径：http://www.shufengxianlan.com/qtweb/news49/484099.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

猜你还喜欢下面的内容

云服务器知识

同城分类信息

成都app开发公司　　 　成都商城网站制作　　 　网站推广　　 　成都谷歌推广　　 　广安园林绿化公司　　 　重庆水土双线托管　　 　软文推广公司　　 　郫县封阳台　　 　解决方案　　 　B2C电商系统　　 　网站建设　　 　宜宾冠赛网站　　 　云南护栏打桩机　　 　吉安网站建设　　 　物流公司网站建设方案　　 　一元广告　　 　成都微信公众号开发　　 　温江网站建设　　 　成都微信小程序开发　　 　成都网站制作公司