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

2024-04-02 19:55

短信预约 -IT技能 免费直播动态提醒

依赖的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;
 
  
  @NotBlank(message = "重要参数不能为空")
  @Pattern(regexp = "^git@.*\\.git$", message = "Git地址不符合规范（git@....git）")
  private String gitUrl;
 
  
  @NotBlank(message = "重要参数不能为空")
  private String branchName;

或者



@Validated
public interface JedisClient {
 
  
  String set(@NotBlank(message = "key值不能为空") String key, String value, @Min(1) int expireSeconds);

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


@ControllerAdvice
public 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;
    }
  }
}