使用bindingResult與實體類注解實現注解校驗
一、引入validatorjar包,並在需要校驗的實體類字段上增加校驗注解
需要引入hibernate中的 org.hibernate.validator,在springboot2.x中,使用 javax.validation 然后在需要校驗的實體類字段上增加校驗注解如下:
@Entity
@Table(name="sys_goods")
public class GoodsInfo extends BaseModel {
@Id
@GeneratedValue
private long goodsNo;
@NotBlank
private String goodsName;
@NotBlank
private String manufacturer; //生產廠家
@NotBlank
private String specifications; //包裝規格
@NotNull
private BigDecimal price; //價格
@NotBlank
private boolean beactive; //是否活動
public long getGoodsNo() {
return goodsNo;
}
public void setGoodsNo(long goodsNo) {
this.goodsNo = goodsNo;
}
public String getGoodsName() {
return goodsName;
}
public void setGoodsName(String goodsName) {
this.goodsName = goodsName;
}
public String getManufacturer() {
return manufacturer;
}
public void setManufacturer(String manufacturer) {
this.manufacturer = manufacturer;
}
public String getSpecifications() {
return specifications;
}
public void setSpecifications(String specifications) {
this.specifications = specifications;
}
public BigDecimal getPrice() {
return price;
}
public void setPrice(BigDecimal price) {
this.price = price;
}
public boolean isBeactive() {
return beactive;
}
public void setBeactive(boolean beactive) {
this.beactive = beactive;
}
}
附上常見校驗注解:
@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=) 驗證字符串的長度是否在給定的范圍之內,包含兩端
日期檢查
@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=)
二、在需要進行校驗的controller中增加校驗相關代碼
使用示例如下:
@PostMapping("/dbinfo")
public @ResponseBody ResponseEntity<BaseResponse<DbInfo>> save(@Validated @RequestBody DbInfo newDbInfo, BindingResult bindingResult)
{
ResponseEntity<BaseResponse<DbInfo>> response=null;
BaseResponse<DbInfo> baseResponse=null;
if(bindingResult.hasErrors())
{
StringBuilder sb=new StringBuilder();
for (FieldError fieldError : bindingResult.getFieldErrors()) {
sb.append(fieldError.getDefaultMessage());
sb.append(" ");
}
//提示錯誤信息
baseResponse=new BaseResponse<>();
baseResponse.setCode(400);
baseResponse.setMessage(sb.toString());
response=new ResponseEntity<BaseResponse<DbInfo>>(baseResponse, HttpStatus.BAD_REQUEST);
}
else
{
// 進行保存
DbInfo savedResult = dbInfoRepository.save(newDbInfo);
baseResponse=new BaseResponse<>();
baseResponse.setData(savedResult);
baseResponse.setCode(200);
baseResponse.setMessage("保存成功");
response=new ResponseEntity<BaseResponse<DbInfo>>(baseResponse, HttpStatus.OK);
}
return response;
}