spring boot validation参数校验实例分析

本文实例讲述了spring boot validation参数校验。分享给大家供大家参考，具体如下：

对于任何一个应用而言在客户端做的数据有效性验证都不是安全有效的，这时候就要求我们在开发的时候在服务端也对数据的有效性进行验证。 Spring Boot自身对数据在服务端的校验有一个比较好的支持，它能将我们提交到服务端的数据按照我们事先的约定进行数据有效性验证。

1 pom依赖

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

2 校验使用实例

• 配置要验证的请求实体

public class User {
  @Null
  private Long id;
  @NotBlank
  private String name;
  @Email
  private String email;
  // 省略getter和setter
}

• 控制器方法配置

@PostMapping("/addUser")
public String addUser(@Valid @RequestBody User user){
  ...
}

• 校验失败统一处理

校验失败时将抛出MethodArgumentNotValidException异常

/**
 * 全局Exception处理
 *
 * @author liusq
 *
 */
@RestControllerAdvice
public class GlobalExceptionHandler {
  private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);
  @SuppressWarnings("rawtypes")
  @ExceptionHandler(value = Exception.class)
  public ResponseEntity handle(Exception e) {
    if (e instanceof MethodArgumentNotValidException) {
      BindingResult bindingResult = ((MethodArgumentNotValidException) e).getBindingResult();
      if (bindingResult.hasErrors() && bindingResult.hasFieldErrors()) {
        FieldError fieldError = bindingResult.getFieldError();
        BodyValidStatus bodyValidStatus = new BodyValidStatus.Builder().code("0009")
            .message(fieldError.getDefaultMessage())
            .field(fieldError.getField()).build();
        LOGGER.warn(bodyValidStatus.getMessage() + e);
        return new ResponseEntity<>(bodyValidStatus, HttpStatus.OK);
      } else {
        bodyStatus = DataUtil.bodyStatus("0009");
      }
    } else {
      bodyStatus = DataUtil.bodyStatus(Constants.ERROR_CODE);
    }
    LOGGER.error(bodyStatus.getMessage() + e);
    return new ResponseEntity<>(bodyStatus, HttpStatus.OK);
  }
}
public class BodyValidStatus {
  // 错误代码
  private String code;
  // 错误代码解释
  private String message;
  // 错误字段
  private String field;
  public BodyValidStatus() {
  }
  public BodyValidStatus(String code, String message, String field) {
    this.code = code;
    this.message = message;
    this.field = field;
  }
  private BodyValidStatus(Builder builder) {
    setCode(builder.code);
    setMessage(builder.message);
    setField(builder.field);
  }
  public String getCode() {
    return code;
  }
  public void setCode(String code) {
    this.code = code;
  }
  public String getMessage() {
    return message;
  }
  public void setMessage(String message) {
    this.message = message;
  }
  public String getField() {
    return field;
  }
  public void setField(String field) {
    this.field = field;
  }
  @Override
  public String toString() {
    return ToStringBuilder.reflectionToString(this);
  }
  public static final class Builder {
    private String code;
    private String message;
    private String field;
    public Builder() {
    }
    public Builder code(String val) {
      code = val;
      return this;
    }
    public Builder message(String val) {
      message = val;
      return this;
    }
    public Builder field(String val) {
      field = val;
      return this;
    }
    public BodyValidStatus build() {
      return new BodyValidStatus(this);
    }
  }
}

3 验证注解详解

4 自定义验证注解和验证规则

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import javax.validation.Constraint;
import javax.validation.Payload;
import com.xxx.xxx.constraint.impl.MoneyValidator;
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy=MoneyValidator.class)
public @interface Money {
  String message() default"不是金额形式";
  Class<?>[] groups() default {};
  Class<? extends Payload>[] payload() default {};
}
import java.util.regex.Pattern;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import com.xxx.xxx.constraint.Money;
public class MoneyValidator implements ConstraintValidator<Money, Double> {
  private String moneyReg = "^\\d+(\\.\\d{1,2})?$";//表示金额的正则表达式
  private Pattern moneyPattern = Pattern.compile(moneyReg);
  public void initialize(Money money) {
    // TODO Auto-generated method stub
  }
  public boolean isValid(Double value, ConstraintValidatorContext arg1) {
    // TODO Auto-generated method stub
    if (value == null)
      return true;
    return moneyPattern.matcher(value.toString()).matches();
  }
}

更多关于java相关内容感兴趣的读者可查看本站专题：《Spring框架入门与进阶教程》、《Java数据结构与算法教程》、《Java操作DOM节点技巧总结》、《Java文件与目录操作技巧汇总》和《Java缓存操作技巧汇总》

希望本文所述对大家java程序设计有所帮助。