浅谈spring方法级参数校验(@Validated)

依赖的jar包:

spring相关jar包版本:4.3.1.RELEASE

<dependency>    <groupId>org.hibernate</groupId>    <artifactId>hibernate-validator</artifactId>    <version>5.1.3.Final</version></dependency>

一、配置与注入 MethodValidationPostProcessor

注意:spring容器与springMVC容器需要各配置一个,呵呵,大家还是用springBoot吧

<!--注册方法验证的处理器--><bean class="org.springframework.validation.beanvalidation.MethodValidationPostProcessor"/>

二、需要在验证的类上(最好在接口上)添加注解 @Validated

例子:

@RequestMapping("/add")public void add(@Validated CoverageAddDTO coverageAddDTO, HttpServletResponse response) {  String validateTip = validateParams(coverageAddDTO);  if (StringUtils.isNotBlank(validateTip)) {    ajaxJsonErrorMessage(response, validateTip);    return;  }  BaseBO dealResult = coverService.addProjectInfo(coverageAddDTO);  if (dealResult.getHandleSuccess()) {    ajaxJsonSuccessMessage(response, "新增成功");  } else {    ajaxJsonErrorMessage(response, dealResult.getMessage());  }} class CoverageAddDTO {  /**   * 唯一键,项目唯一标识(一般是项目名称)   */  @NotBlank(message = "重要参数不能为空")  private String sessionId;   /**   * 项目的Git地址   */  @NotBlank(message = "重要参数不能为空")  @Pattern(regexp = "^git@.*\\.git$", message = "Git地址不符合规范(git@....git)")  private String gitUrl;   /**   * Git上分支名称   */  @NotBlank(message = "重要参数不能为空")  private String branchName;

或者

/** * @description: jedis操作redis集群-接口方法类 * @author: wangpeng **/@Validatedpublic interface JedisClient {   /**   * 设置一个字符串类型的值,如果记录存在则覆盖原有value   *   * @param key   值对应的键   * @param value 值   * @return 状态码, 成功则返回OK   */  String set(@NotBlank(message = "key值不能为空") String key, String value, @Min(1) int expireSeconds);

三、捕获 ConstraintViolationException 异常,进行后续提示等处理

@ControllerAdvicepublic class GlobalExceptionHandler {  private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);  /**   * 处理接口数据验证异常   */  @ExceptionHandler(ConstraintViolationException.class)  @ResponseBody  public String handleMethodArgumentNotValidException(ConstraintViolationException ex) {    logger.error("ConstraintViolationException:{}", ex.getMessage());    Iterator<ConstraintViolation<?>>        iterator = ex.getConstraintViolations().iterator();    String message = null;    if (iterator.hasNext()) {      message = iterator.next().getMessage();    }    return encode(message);  }   /**   * 处理接口数据验证异常   */  @ExceptionHandler(BindException.class)  @ResponseBody  public String handleMethodArgumentNotValidException(BindException ex) {    logger.error("BindException:{}", ex.getMessage());    String message = ex.getFieldErrors().get(0).getDefaultMessage();    return encode(message);  }   @ExceptionHandler(Exception.class)   // 捕获所有逃逸的异常  @ResponseBody  public String handleAllUnCatchException(Exception ex) {    logger.error("未知异常:", ex);    String message = ex.getMessage();    return encode(message);  }   // 对返回数据进行截取和编码处理,防止中文乱码和返回数据量过大  private String encode(String errorMsg) {    String rtnMessage = errorMsg;    if (StringUtils.isBlank(errorMsg)) {      rtnMessage = "{\"message\":\"error\",\"status\":\"error\"}";      return rtnMessage;    } else {      if (errorMsg.length() > 100) {        rtnMessage = errorMsg.substring(0, 100);      }      // 特殊字符编码,解决中文乱码问题      try {        rtnMessage = URLEncoder.encode(rtnMessage, "UTF-8");      } catch (UnsupportedEncodingException e) {        logger.error("URLEncoder报错:", e);      }      rtnMessage = "{\"message\":\"" + rtnMessage + "\",\"status\":\"error\"}";      return rtnMessage;    }  }}

四、支持的注解如下:

spring支持jsr303以及hibernate中的校验规则

@AssertFalse 对应参数为false

@AssertTrue 对应参数为true

@DecimalMax(“1”) 对应小数的最大值

@DecimalMin(“1”) 对应小数的最小值

@Digits(integer=1,fraction = 2) 对应数字整数(integer)和小数(fraction)位数

@Future Date只接受将来的时间

@Past Date只接受过去的时间

@Max(100) 数字最大值

@Min(100) 数字最小值

@NotNull 不接受Null值

@Null 只接受Null值

@Pattern(regexp=”^a$”) 正则表达式regexp为表达式

@Size(min=1,max=2) 参数的长度min/max为最小/最大长度

hibernate validation

@CreditCardNumber Luhn算法校验,用于防止用户错误输入,并不真实校验信用卡号

@EAN 欧洲商品标码校验

@Email 邮箱校验

@Length 校验string的长度

@LuhnCheck Luhn算法校验

@NotBlank 字符串非null非空

@NotEmpty 字符串、集合、map非空

@ParameterScriptAssert 使用脚本进行校验支持JSR223脚本

@Range 匹配数字或表示数字的字符串的取值范围

@SafeHtml 校验是否包含恶意脚本

@URL 合法URL

@Validated校验的坑

BindingResult必须紧挨着放在实体的后面,否则跳转后

以上为个人经验,希望能给大家一个参考,也希望大家多多支持。

等待故人的归来。山上的树,大多数是松树比较突出。

浅谈spring方法级参数校验(@Validated)

相关文章:

你感兴趣的文章:

标签云: