詳解JSR303表單驗證
一、概述
JSR-303 是 Java EE 6 中的一項子規範,叫做 Bean Validation,官方參考實現是hibernate Validator。此實現與 Hibernate ORM 沒有任何關係。 JSR 303 用於對 Java Bean 中的欄位的值進行驗證。spring MVC 3.x 之中也大力支援 JSR-303,可以在控制器中對錶單提交的資料方便地驗證。
JSR 303 用於對java Bean 中的欄位的值進行驗證,使得驗證邏輯從業務程式碼中脫離出來。它是一個執行時的資料驗證框架,在驗證之後驗證的錯誤資訊會被馬上返回。
使用場景:一般用於表單提交頁面。
注：實現方式為通過使用註解進行驗證
二、專案依賴及配置
Maven專案依賴
<!-- 表單驗證 -->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.13.Final</version>
</dependency>
spring-web.xml配置（可參考https://blog.csdn.net/Black1499/article/details/83961684
<!--JSR303 驗證--> <bean id="myValidator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean"> <property name="providerClass" value="org.hibernate.validator.HibernateValidator" /> <property name="validationMessageSource" ref="messageSource" /> </bean>
三、基本校驗規則
1.空檢查
-
@Null 驗證物件是否為null
-
@NotNull 驗證物件是否不為null, 無法查檢長度為0的字串
-
@NotBlank 檢查約束字串是不是Null還有被Trim的長度是否大於0,只對字串,且會去掉前後空格.
-
@NotEmpty 檢查約束元素是否為NULL或者是EMPTY.
2.Booelan檢查
-
@AssertTrue 驗證 Boolean 物件是否為 true
-
@AssertFalse 驗證 Boolean 物件是否為 false
3.長度檢查
-
@Size(min=, max=) 驗證物件(Array,Collection,Map,String)長度是否在給定的範圍之內
-
@Length(min=, max=) Validates that the annotated string is between min and max included.
4.日期檢查
-
@Past 驗證 Date 和 Calendar 物件是否在當前時間之前,驗證成立的話被註釋的元素一定是一個過去的日期
-
@Future 驗證 Date 和 Calendar 物件是否在當前時間之後 ,驗證成立的話被註釋的元素一定是一個將來的日期
-
@Pattern 驗證 String 物件是否符合正則表示式的規則,被註釋的元素符合制定的正則表示式,regexp:正則表示式 flags: 指定 Pattern.Flag 的陣列,表示正則表示式的相關選項。
5.數值檢查
建議使用在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=)
四、快速使用
實體類，直接在欄位上面使用JSR303為我們提供的註解
public class Book {
@Min(0)
private int id;
@NotBlank(message = "asdffasdfasfd")
private String name;
@DateTimeFormat(pattern = "yyyy-MM-dd")//用於格式轉換
@NotNull
@Past
private Date writeDate;
@NotNull(message = "我是存在的！！！！")
private Employee employee;
@DecimalMin(value = "10.00",message = "最低價格")
private float price;
@NotBlank
@Pattern(regexp = "^[0-9]{11}$")
private String phone;
@Email
private String email;
@NotNull
List list;
// ...省略get/set函式
}
MVC後臺Controller
@Controller
public class BookController {
@PostMapping("/addBook")
// 注意這裡一定要使用@valid註解，否則jsr303驗證不起作用
// BindingResult為錯誤資訊，可以檢視原始碼進行理解
public String addBook(@Valid Book book, BindingResult result){
if(result.hasErrors()){
return "bookForm";
}
return "正確的頁面";
}
@GetMapping("/bookForm")
public String bookForm(Model model){
model.addAttribute("book", new Book());
return "bookForm";
}
}
前臺jsp
<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<form:form action="/addBook" method="post" modelAttribute="book">
<%--form:input為接收使用者輸入--%>
<%--form:errors為輸入錯誤時，後臺返回的錯誤資訊（來自注解中的message）--%>
<label>名稱</label>
<form:input path="name" value="${book.name}" />
<form:errors path="name"/><br/>
<label>價格</label>
<form:input path="price" value="${book.price}"/>
<form:errors path="price"/><br/>
<input type="submit"/>
</form:form>
</body>
</html>
下面我們嘗試輸入一些錯誤的資訊，看看頁面會有什麼效果。
正確資訊：
錯誤資訊：
這就是jsr303的使用是不是非常的簡單？
五、自定義jsr303註解
有些時候jsr303為我們提供的註解並不能解決我們的需求，比如我們需要驗證一個11位長度的手機號時，我們會使用這樣的方式
@NotBlank
@Pattern(regexp = "^[0-9]{11}$")
private String phone;
每次我們都要為這個欄位加上兩個註解，還要寫正則表示式，十分累贅，寫一個時無所謂，當實體類過多時，而且都有這個欄位時，就會十分麻煩。這時我們可以自己為這個驗證寫個註解，可以複用。
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {CellPhoneValid.class })// 注意點一
public @interface CellPhone {
//下面三條屬性不能亂改，可能會報錯
// 錯誤時資訊
String message() default "格式不正確，應該是11位";
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
}
// 繼承ConstraintValidator<T,String>介面，注意點二
class CellPhoneValid implements ConstraintValidator<CellPhone,String>{
@Override
public void initialize(CellPhone constraintAnnotation) { //注意點三
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
// 直接在這裡面寫上我們的驗證邏輯即可
return value!=null && Pattern.matches("^[0-9]{11}", value);
}
}
下面我們來使用一下看看有沒有效果
@CellPhone
private String phone;
表單
<form:form action="/addBook" method="post" modelAttribute="book">
<%--form:input為接收使用者輸入--%>
<%--form:errors為輸入錯誤時，後臺返回的錯誤資訊（來自注解中的message）--%>
<label>名稱</label>
<form:input path="name" value="${book.name}" />
<form:errors path="name"/><br/>
<label>價格</label>
<form:input path="price" value="${book.price}"/>
<form:errors path="price"/><br/>
<label>號碼</label>
<form:input path="phone" value="${book.phone}"/>
<form:errors path="phone"/><br/>
<input type="submit"/>
</form:form>
輸入錯誤資訊時
