在 SpringBoot项目开发中，有一个观念是不要信任前端传入的参数，由于你不知道用户是怎么操作咱们接口的，所以在后端也需求对参数进行校验，这篇文章主要讲讲咱们项目中最常运用的验证方案。
一、引进相应的依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
spring-boot-starter-validation实质是运用的Hibernate Validator，它并没有自己的完成。
二、Validation的基本校验注解
空查看
@Null 验证目标是否为null
@NotNull 验证目标是否不为null, 无法查检长度为0的字符串
@NotBlank 查看束缚字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 查看束缚元素是否为NULL或许是EMPTY.
Booelan查看
@AssertTrue 验证 Boolean 目标是否为 true
@AssertFalse 验证 Boolean 目标是否为 false
长度查看
@Size(min=, max=) 验证目标（Array,Collection,Map,String）长度是否在给定的范围之内
@Length(min=, max=) 验证注解的元素值长度在min和max区间内
日期查看
@Past 验证 Date 和 Calendar 目标是否在当时时刻之前
@Future 验证 Date 和 Calendar 目标是否在当时时刻之后
@Pattern 验证 String 目标是否契合正则表达式的规矩
数值查看，主张运用在Stirng,Integer类型，不主张运用在int类型上，由于表单值为“”时无法转换为int，但能够转换为Stirng为"",Integer为null
@Min 验证 Number 和 String 目标是否大等于指定的值
@Max 验证 Number 和 String 目标是否小等于指定的值
@DecimalMax 被标示的值有必要不大于束缚中指定的最大值. 这个束缚的参数是一个通过BigDecimal界说的最大值的字符串表示.小数存在精度
@DecimalMin 被标示的值有必要不小于束缚中指定的最小值. 这个束缚的参数是一个通过BigDecimal界说的最小值的字符串表示.小数存在精度
@Digits 验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=) 验证字符串是否是契合指定格局的数字，interger指定整数精度，fraction指定小数精度。
@Range(min=, max=) 验证注解的元素值在最小值和最大值之间
@Range(min=10000,max=50000,message="range.bean.wage")
@Valid 写在办法参数前，递归的对该目标进行校验, 假如相关目标是个集合或许数组,那么对其间的元素进行递归校验,假如是一个map,则对其间的值部分进行校验.(是否进行递归验证)
@CreditCardNumber信用卡验证
@Email 验证是否是邮件地址，假如为null,不进行验证，算通过验证。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)
三、增加参数校验
在咱们对应的DTO上并在controller的上增加校验。
- 在
DTO的特点上增加校验
import com.fasterxml.jackson.annotation.JsonIgnore;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.Email;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import java.util.UUID;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class registryUserDto {
@NotBlank(message = "用户名不能为空")
private String username;
@NotBlank(message = "暗码不能为空")
@Length(min = 6, max = 20, message = "暗码长度在6-20之间")
private String password;
@Min(value = 0, message = "年纪最小为0")
@Max(value = 200, message = "年纪最大为200")
private Integer age;
@NotBlank(message = "邮箱不能为空")
@Email(message = "邮箱格局不正确")
private String email;
@JsonIgnore
private String salt = UUID.randomUUID().toString().replaceAll("-", "");
private Boolean admin;
}
通过在参数上增加各种校验注解完成校验
- 在
controller对应的DTO增加@Valid或许@Validated
@PostMapping("/registry")
public ResponseResult registryUser(@RequestBody @Valid registryUserDto registryUserDto) {
return ResponseResult.okResult(registryUserDto);
}
这样增加后就能够对其间的参数完成校验了，当校验失利时接口就会返回500反常和相应的反常信息。
关于复杂String校验咱们能够运用正则来校验，如下所示：
@Pattern(regexp = "^1(3|4|5|7|8)\d{9}$",message = "手机号码格局过错")
@NotBlank(message = "手机号码不能为空")
private String phone;
另外关于单个参数的校验，没有用DTO目标来接收的参数也能够校验，先在controller类上增加@Validated，再在对应的参数前加校验注解，如下所示：
@RestController
@RequestMapping("/user")
@Validated
public class UserController {
@PostMapping("/registry")
public ResponseResult registryUser(@NotBlank(message = "name不能为空") String name) {
return ResponseResult.okResult(name);
}
}
四、自界说校验注解
关于一些常见的或复杂的校验需求咱们需求自界说校验注解，完成如下：
- 新建自界说注解
annotation.validator.Status:
import com.jk.validator.StatusValidator;
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {StatusValidator.class})
public @interface Status {
String[] statusType() default {};
String message() default "状态传递有误";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
- 完成相应的校验
import com.jk.annotation.validator.Status;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Arrays;
import java.util.List;
public class StatusValidator implements ConstraintValidator<Status, Integer> {
private List<String> typeStatus ;
@Override
public void initialize(Status constraintAnnotation) {
typeStatus = Arrays.asList(constraintAnnotation.statusType());
ConstraintValidator.super.initialize(constraintAnnotation);
}
@Override
public boolean isValid(Integer value, ConstraintValidatorContext constraintValidatorContext) {
if(value !=null){
if(!typeStatus.contains(String.valueOf(value))){
return false;
}
}
return true;
}
}
- 自界说注解的运用
@Status(statusType = {"1", "2"})
private Integer status;
五、校验失利统一反常处理
咱们能够看到咱们上面校验失利的呼应msg十分不友爱，有许多前端不需求知道的音讯。
咱们基于全局统一反常处理来增加校验失利的处理，不太清楚统一反常处理的能够看我另一篇文章SpringBoot 中统一呼应格局及统一反常处理，你应该这样做
在统一反常处理中增加BindException的处理
exception.GlobalExceptionHandler:
import com.jk.enums.AppHttpCodeEnum;
import com.jk.exception.SystemException;
import com.jk.domain.vo.ResponseResult;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
@ExceptionHandler(SystemException.class)
public ResponseResult systemExceptionHandler(SystemException e) {
log.error("呈现了反常! {}", e);
return ResponseResult.errorResult(e.getCode(), e.getMsg());
}
@ExceptionHandler(Exception.class)
public ResponseResult exceptionHandler(Exception e) {
log.error("呈现了反常! {}", e);
return ResponseResult.errorResult(AppHttpCodeEnum.SYSTEM_ERROR.getCode(), e.getMessage());
}
/* 增加校验参数反常处理 */
@ExceptionHandler(BindException.class)
public ResponseResult bindExceptionHandler(BindException e) {
log.error("呈现了反常! {}", e);
return ResponseResult.errorResult(AppHttpCodeEnum.SYSTEM_ERROR, e.getBindingResult().getAllErrors().get(0).getDefaultMessage());
}
}
校验失利时前端接收的到的呼应如下：
能够看到反常信息十分友爱，也十分便利前端弹出音讯框提示！
这样就在SpringBoot的项目中增加了参数校验及统一反常处理，其实全体十分简略，也希望咱们在项目中用起来！
