java中的Bean Validation

概念:java中的Bean Validation是一個數據驗證的規範。java

說明:Hibernate Validator是Bean Validation的一個具體實現。git

舉例:在springMVC中使用Hibernate Validatorweb

1)maven依賴:
	<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.1.2.Final</version>
	</dependency>

2)JavaBean:

	import javax.validation.constraints.NotNull;
	import org.hibernate.validator.constraints.NotBlank;

	/**
	 * 在須要進行校驗的屬性上添加相應的註解:
	 * 
	 * 1)Bean Validation 提供的 constraint:       
	 * 		[@Null](https://my.oschina.net/u/561366)   	被註釋的元素必須爲 null       
	 *		[@NotNull](https://my.oschina.net/notnull)    被註釋的元素必須不爲 null       
	 *		@AssertTrue     被註釋的元素必須爲 true       
	 *		[@AssertFalse](https://my.oschina.net/u/2430840)    被註釋的元素必須爲 false       
	 *		@Min(value)     被註釋的元素必須是一個數字,其值必須大於等於指定的最小值       
	 *		@Max(value)     被註釋的元素必須是一個數字,其值必須小於等於指定的最大值       
	 *		@DecimalMin(value)  被註釋的元素必須是一個數字,其值必須大於等於指定的最小值       
	 *		@DecimalMax(value)  被註釋的元素必須是一個數字,其值必須小於等於指定的最大值       
	 *		@Size(max=, min=)   被註釋的元素的大小必須在指定的範圍內       
	 *		@Digits (integer, fraction)     被註釋的元素必須是一個數字,其值必須在可接受的範圍內       
	 *		@Past		 被註釋的元素必須是一個過去的日期       
	 *		@Future		 被註釋的元素必須是一個未來的日期       
	 *		@Pattern(regex=,flag=)  被註釋的元素必須符合指定的正則表達式  
	 *		     
	 * 2)Hibernate Validator 特有的 constraint:
	 *		@NotBlank(message =)	驗證字符串非null,且長度必須大於0 
	 *		@NotEmpty				被註釋的字符串或集合的必須非空       
	 *		@Email  				被註釋的元素必須符合email的格式       
	 *		@Length(min=,max=)		被註釋的字符串的大小必須在指定的範圍內             
	 *		@Range(min=,max=,message=)	被註釋的元素必須在合適的範圍內 
	 *		
	 */	
	public class User {
		 
		@NotBlank(message = "name is null!")
		private String name;

		@NotNull(message = "age is null!")
		private Integer age;

		private String email;

		private String address;

		// getter and setter ..
		
	}
	
3)控制器:

	import javax.validation.Valid;
	import org.springframework.validation.BindingResult;
	import org.springframework.validation.ObjectError;
	import org.springframework.web.bind.annotation.RequestMapping;
	import org.springframework.web.bind.annotation.RequestBody;
	import org.springframework.web.bind.annotation.RequestMethod;

	@RestController
	@RequestMapping("/sys")
	public class UserController {

		/**
		 * 1.給須要校驗的參數添加 @Valid註解 
		 * 2.給方法添加一個類型爲 BindingResult的參數,用來封裝 校驗的結果
		 */
		@RequestMapping(value = "/user/add", method = RequestMethod.POST)
		public String addUser(@Valid @RequestBody User req, BindingResult bindingResult) {
			
			if (bindingResult.hasErrors()) {
				List<ObjectError> allErrors = bindingResult.getAllErrors();
				List<String> msgs = new ArrayList<String>();
				for (ObjectError objectError : allErrors) {
					String msg = objectError.getDefaultMessage();
					msgs.add(msg);
				}
				String paramErrorMsg = StringUtils.join(msgs, " & ");
				return paramErrorMsg;
			} else {
				System.out.println("do add user.");
				return "success!";
			}
		}
	}

4)接口測試:

	地址:http://localhost:8081/jxn-web/api/sys/user/add
	
	請求類型:Content-Type: application/json

	參數:
		{"name":"","age":null}		==> 響應內容:age is null! & name is null!
		{"name":"","age":""}		==> 響應內容:age is null! & name is null!
		{"name":"jack","age":"17"}	==> 響應內容:success!

常見錯誤:正則表達式

報錯:javax.validation.UnexpectedTypeException: HV000030: No validator could be found for type: java.lang.Integer.

分析:是因爲@NotBlank修飾了Integer、Long等引用類型的屬性
eg:
	@NotBlank
	private Integer age;
	
修正:應該使用@NotNull來修飾引用類型的屬性。
	@NotNull
	private Integer age;
相關文章
相關標籤/搜索