Spring Boot 資料校驗@Valid+統一異常處理
1.先在你需要校驗的實體類上面加上所需要的註解
為了測試,我自己就簡單寫了。@NotNull 和 @NotBlank 不能為空
@Entity @Table(name = "User") @Data public class User implements Serializable { @Id @NotNull(message = "id不能為空") @GeneratedValue(strategy = GenerationType.IDENTITY) private Integer id; @NonNull @NotBlank(message = "姓名不能為空") @Column(name = "name") private String name; public User() { } public User(Integer id,String name) { this.id=id; this.name = name; } }
下面是我從別的部落格收集的所有引數校驗註解的使用規則方法
空檢查
@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=) Validates that the annotated string is between min and max included.
日期檢查
@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=) Checks whether the annotated value lies between (inclusive) the specified minimum and maximum. @Range(min=10000,max=50000,message=“range.bean.wage”) private BigDecimal wage;
@Valid 遞迴的對關聯物件進行校驗, 如果關聯物件是個集合或者陣列,那麼對其中的元素進行遞迴校驗,如果是一個map,則對其中的值部分進行校驗.(是否進行遞迴驗證)
@CreditCardNumber信用卡驗證
@Email 驗證是否是郵件地址,如果為null,不進行驗證,算通過驗證。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)
2.在controller層加入@Valid註解
ServiceResult是我自己建立的異常返回類
新增使用者資訊的方法
@PostMapping("/saveUser")
public ServiceResult addUsers(@Valid @RequestBody User user){
return ServiceResult.success(userRepository.save(user));
}
3.建立統一處理異常的類
@RestControllerAdvice
@ExceptionHandler(寫你想要攔截的異常型別)
這兩個註解必須要
第一個方法是校驗異常的統一處理
第二個是防止引數型別不一致的處理
當然你也可以在裡面處理其他異常。
@RestControllerAdvice
public class BadRequestExceptionHandler {
private static final Logger logger = LoggerFactory.getLogger(BadRequestExceptionHandler.class);
/**
* 校驗錯誤攔截處理
*
* @param exception 錯誤資訊集合
* @return 錯誤資訊
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
public ServiceResult validationBodyException(MethodArgumentNotValidException exception){
BindingResult result = exception.getBindingResult();
if (result.hasErrors()) {
List<ObjectError> errors = result.getAllErrors();
errors.forEach(p ->{
FieldError fieldError = (FieldError) p;
logger.error("Data check failure : object{"+fieldError.getObjectName()+"},field{"+fieldError.getField()+
"},errorMessage{"+fieldError.getDefaultMessage()+"}");
});
}
return ServiceResult.error("請填寫正確資訊");
}
/**
* 引數型別轉換錯誤
*
* @param exception 錯誤
* @return 錯誤資訊
*/
@ExceptionHandler(HttpMessageConversionException.class)
public ServiceResult parameterTypeException(HttpMessageConversionException exception){
logger.error(exception.getCause().getLocalizedMessage());
return ServiceResult.error("型別轉換錯誤");
}
}
本人還是java小白,如果有什麼不對的請在下方留言。
相關連線:
個人qq: 1165892587