SpringMVC(八)使用@Valid註解實現後臺表單校驗
阿新 • • 發佈：2018-11-11
目錄
依賴jar
<dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <version>1.1.0.Final</version> </dependency> <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> <version>5.2.1.Final</version> </dependency>
@valid，java的jsr303聲明瞭這類介面，hibernate-validator對介面進行實現
配置spring對@valid註解的支援
< mvc:annotation-driven/> JSR303定義的校驗型別
空檢查 @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=)
需要注意的是，NotEmpty,NotNull,NotBlank的區別
@NotEmpty 用在集合上
@NotNull用在基本型別上
@NotBlank用在String上
如何使用
建立一個pojo類
對於類中需要校驗的欄位，加上需要的校驗註解
public class Book implements Serializable { /** * 編號 */ private Integer id; /** * 書名 */ @NotEmpty(message = "書名不能為空") private String name; /** * 作者 */ @NotEmpty(message = "作者不能為空") private String writer; /** * 簡介 */ @NotEmpty(message = "簡介不能為空") private String introduction; public Integer getId() { return id; } public void setId(Integer id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public String getWriter() { return writer; } public void setWriter(String writer) { this.writer = writer; } public String getIntroduction() { return introduction; } public void setIntroduction(String introduction) { this.introduction = introduction; } }
controller中觸發引數校驗
只需要在提交的校驗pojo前面加上@Valid註解,BindingResult的hasError方法檢查是否欄位校驗失敗
public static boolean validate(BindingResult result, Model model) {
boolean validateResult = false;
if (result.hasErrors()) {
validateResult = true;
if (model != null) {
FieldError error = result.getFieldErrors().get(0);// 為了避免大量的校驗在前端堆積,影響使用者體驗，只返回一個錯誤提示
logger.debug("validate error: " + error.getDefaultMessage());
model.addAttribute("msg", error.getDefaultMessage());
}
}
return validateResult;
}
@RequestMapping("/update")
public String updateBook(@Valid Book book,BindingResult bindingResult,Model model){
if(BookController.validate(bindingResult,model)){
model.addAttribute("action","update");
return "bookDetail";
}
service.updateBook(book);
return "redirect:/book";
}錯誤資訊的展示，前段使用thymeleaf模板的話,可以使用th:error輸出錯誤資訊。
硬編碼校驗
如果註解@Valid失效情況，可以使用下面方式進行校驗
/**
* 返回空，表示校驗成功，否則校驗失敗
* @param object
* @param <T>
* @return
*/
private <T> String validateParam(T object){
Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
Set<ConstraintViolation<T>> set = validator.validate(object);
if(set!=null&&set.size()>0){
StringBuilder sb = new StringBuilder();
for (ConstraintViolation<T> ct: set
) {
if(ct.getMessage()!=null&&ct.getMessage().trim().length()>0){
sb.append("field:"+ct.getPropertyPath()+",error message:"+ct.getMessage());
}
}
return sb.toString();
}
return null;
}使用AOP的方式實現校驗
對需要引數校驗的方法，織入增強，減少程式碼
@Aspect
@Component
public class CustomerValidatorAOP {
@Before("execution(* com.example.chapter_1_web.controller.*.update*(..))")
public void validatorBook(JoinPoint point) {
//返回目標方法的引數
Object[] objects = point.getArgs();
//獲取目標方法簽名
MethodSignature methodSignature = (MethodSignature) point.getSignature();
Method method = methodSignature.getMethod();
//獲取方法註解
Annotation[] annotationList = method.getAnnotations();
//引數註解
Annotation[][] argAnnotations = method.getParameterAnnotations();
//引數名稱
String[] argNames = methodSignature.getParameterNames();
Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
for(int i = 0;i<objects.length;i++){
//如果引數有BingResult，獲取錯誤資訊
if(objects[i] instanceof BindingResult){
BindingResult result = (BindingResult) objects[i];
if(result.hasErrors()){
FieldError error = result.getFieldError();
//獲取錯誤資訊
String errorMsg = error.getDefaultMessage();
ServletRequestAttributes req = (ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
HttpServletResponse rsp = req.getResponse();
//如果是返回的是json資料就可以將資料寫回,省略。。
}
}
}
}
}參考部落格:
https://blog.csdn.net/DuShiWoDeCuo/article/details/79080237
https://my.oschina.net/itblog/blog/211693
http://exceptioneye.iteye.com/blog/1305040