springboot 使用校验框架validation校验

深碍√TFBOYSˉ_ 2022-06-13 04:37 315阅读 0赞

转载自：[http://blog.csdn.net/u012373815/article/details/72049796][http_blog.csdn.net_u012373815_article_details_72049796]

b/s系统中对http请求数据的校验多数在客户端进行，这也是出于简单及用户体验性上考虑，但是在一些安全性要求高的系统中服务端校验是不可缺少的。   
Spring3支持JSR-303验证框架，JSR-303 是[Java ][Java]EE 6 中的一项子规范，叫做BeanValidation，官方参考实现是[hibernate][] Validator（与Hibernate ORM 没有关系），JSR 303 用于对[java ][Java]Bean 中的字段的值进行验证。

# validation与 springboot 结合 #

## 1. bean 中添加标签 ##

部分代码：   
标签需要加在属性上，@NotBlank 标签含义文章末尾有解释

public class User {
        private Integer id;
        @NotBlank(message = "{user.name.notBlank}")
        private String name;
        private String username;

## 2. Controller中开启验证 ##

在Controller 中 请求参数上添加@Validated 标签开启验证

@RequestMapping(method = RequestMethod.POST)
        public User create(@RequestBody @Validated User user) { return userService.create(user); }

## 3. resource 下新建错误信息配置文件 ##

在resource 目录下新建提示信息配置文件“ValidationMessages.properties“

注意：名字必须为“ValidationMessages.properties“ 因为SpringBoot自动读取classpath中的ValidationMessages.properties里的错误信息

ValidationMessages.properties 文件的编码为ASCII。数据类型为 key value 。key“user.name.notBlank“为第一步 bean的标签 大括号里面对应message的值

value 为提示信息 ，但是是ASCII 。（内容为“名字不能为空“）

![这里写图片描述][SouthEast]

## 4. 自定义异常处理器，捕获错误信息 ##

当验证不通过时会抛异常出来，异常的message 就是 ValidationMessages.properties 中配置的提示信息。此处定义异常处理器。捕获异常信息（因为验证不通过的项可能是多个所以统一捕获处理），并抛给前端。（此处是前后端分离开发）

public void MethodArgumentNotValidException(Exception ex, HttpServletRequest request, HttpServletResponse response) {
            logger.error( ":" + CommonUtil.getHttpClientInfo(request), ex);
            MethodArgumentNotValidException c = (MethodArgumentNotValidException) ex;
            List<ObjectError> errors =c.getBindingResult().getAllErrors();
            StringBuffer errorMsg=new StringBuffer();
            errors.stream().forEach(x -> errorMsg.append(x.getDefaultMessage()).append(";"));
            pouplateExceptionResponse(response, HttpStatus.INTERNAL_SERVER_ERROR, errorMsg.toString());
        }
    
    
     private void pouplateExceptionResponse(HttpServletResponse response, HttpStatus errorCode, String errorMessage) {
            try {
                response.sendError(errorCode.value(), errorMessage);
            } catch (IOException e) {
                logger.error("failed to populate response error", e);
            }
        }

## 5. 附上部分标签含义 ##

<table> 
 <thead> 
  <tr> 
   <th style="vertical-align:top;">限制</th> 
   <th style="vertical-align:top;">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@Null</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">限制只能为null</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@NotNull</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">限制必须不为null</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@AssertFalse</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">限制必须为false</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@AssertTrue</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">限制必须为true</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@DecimalMax(value)</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">限制必须为一个不大于指定值的数字</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@DecimalMin(value)</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">限制必须为一个不小于指定值的数字</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@Digits(integer,fraction)</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@Future</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">限制必须是一个将来的日期</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@Max(value)</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">限制必须为一个不大于指定值的数字</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@Min(value)</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">限制必须为一个不小于指定值的数字</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@Past</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">限制必须是一个过去的日期</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@Pattern(value)</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">限制必须符合指定的正则表达式</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@Size(max,min)</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">限制字符长度必须在min到max之间</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@Past</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">验证注解的元素值（日期类型）比当前时间早</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@NotEmpty</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@NotBlank</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格</td> 
  </tr> 
  <tr> 
   <td style="border-color:#eeeeee;vertical-align:top;">@Email</td> 
   <td style="border-color:#eeeeee;vertical-align:top;">验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式</td> 
  </tr> 
 </tbody> 
</table>

--------------------

示例

@Pattern(regexp="^[a-zA-Z0-9]+$",message="{account.username.space}")
     @Size(min=3,max=20,message="{account.username.size}")

[http_blog.csdn.net_u012373815_article_details_72049796]: http://blog.csdn.net/u012373815/article/details/72049796
[Java]: http://lib.csdn.net/base/java
[hibernate]: http://lib.csdn.net/base/javaee
[SouthEast]: /images/20220613/6e5101c2bf30494d886f070a1bef0406.png