spring mvc 中使用validator
添加依賴：
需要兩個JAR包：hibernate-validator.jar 和validation-api.jar
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<optional>true</optional>
<exclusions>
<exclusion>
<groupId>org.jboss.logging</groupId>
<artifactId>jboss-logging</artifactId>
</exclusion>
<exclusion>
<groupId>com.fasterxml</groupId>
<artifactId>classmate</artifactId>
</exclusion>
</exclusions>
</dependency>
定義bean對象
public class SwaggerUser implements Serializable{
private static final long serialVersionUID = 1L;
@NotBlank
private String name;
@Min(value=1)
@Max(value=150)
private int age;
@NotNull(message="用戶ID不能為空")
private Long id;
//省略geter/seter方法
}
三種驗證方式
第一種只使用@Validated 或者 @Valid
/**
* 1.只使用@Validated 或者 @Valid 注解時，當驗證不通過會返回400，并且拋出"org.springframework.validation.BindException"異常<br>
* 這種交互不利于前端獲取校驗信息,可以配合BindingResult對校驗結果進行封裝之后再返回給前端。
* @param user
* @return
* @author zhaowg3
* @Date 2017年4月19日
*/
@RequestMapping(value="useValidated", method=RequestMethod.POST)
public ResponseEntity<?> useValidated(@RequestBody @Valid SwaggerUser user) {
return ResponseEntity.ok(null);
}
當驗證不通過會返回400，并且拋出"org.springframework.web.bind.MethodArgumentNotValidException"異常，如果是使用spring boot，拋出的異常回統一交給org.springframework.boot.autoconfigure.web.BasicErrorController處理，返回spring boot固定的錯誤格式。
如果想要修改spring boot固定的錯誤格式，例如當報500，404，400等錯誤時，返回自定義的錯誤信息，可以自定義通用錯誤處理器代替spring boot自己的BasicErrorController.
第二種使用@Validated 或者 @Valid 同時配合使用BindingResult
/**
* 2.使用@Validated 或者 @Valid 同時配合使用BindingResult，對校驗結果進行封裝之后再返回給前端，方便交互
* @param user
* @param bindingResult
* @return
* @author zhaowg3
* @Date 2017年4月19日
*/
@RequestMapping(value="useValidatedAndBindingResult", method=RequestMethod.POST)
public ResponseEntity<?> useValidated(@RequestBody(required=false) @Valid SwaggerUser user,BindingResult bindingResult) {
if(bindingResult.hasErrors()){
//自定義錯誤返回格式
List<String> errorMsg = new ArrayList<>();
//獲取第一個校驗失敗的錯誤下信息
//bindingResult.getFieldError();
//獲取校驗失敗的所有字段的錯誤信息
List<FieldError> fieldErrors = bindingResult.getFieldErrors();
for (FieldError fieldError : fieldErrors) {
errorMsg.add(fieldError.getField()+" "+fieldError.getObjectName()+" "+fieldError.getDefaultMessage());
}
return ResponseEntity.ok(errorMsg);
}
return ResponseEntity.ok(null);
}
這樣驗證失敗的信息將會放到BindingResult中，然后自己從中獲取錯誤信息，自定義錯誤格式。
注意：每一個@Valid后面必須跟一個BindingResult，驗證失敗的放到緊跟他的BindingResult中
第三種將validation邏輯封裝成工具類。
1.獲取Validator
/**
* 兩種方式獲取Validator：<br>
* 1.使用Autowired<br>
* 2.使用<code>
* private static Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
* </code>
*/
@Autowired
protected Validator validator;
2.創建BeanValidators工具類
/**
* JSR303 Validator(Hibernate Validator)工具類.
*
* ConstraintViolation中包含propertyPath, message 和invalidValue等信息.
* 提供了各種convert方法，適合不同的i18n需求:
* 1. List<String>, String內容為message
* 2. List<String>, String內容為propertyPath + separator + message
* 3. Map<propertyPath, message>
*
* 詳情見wiki: https://github.com/springside/springside4/wiki/HibernateValidator
* @author calvin
* @version 2013-01-15
*/
public class BeanValidators {
// private static Validator validator = Validation.buildDefaultValidatorFactory()
// .getValidator();
/**
* 調用JSR303的validate方法, 驗證失敗時拋出ConstraintViolationException.
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
public static void validateWithException(Validator validator, Object object, Class<?>... groups)
throws ConstraintViolationException {
Set constraintViolations = validator.validate(object, groups);
if (!constraintViolations.isEmpty()) {
throw new ConstraintViolationException(constraintViolations);
}
}
/**
* 輔助方法, 轉換ConstraintViolationException中的Set<ConstraintViolations>中為List<message>.
*/
public static List<String> extractMessage(ConstraintViolationException e) {
return extractMessage(e.getConstraintViolations());
}
/**
* 輔助方法, 轉換Set<ConstraintViolation>為List<message>
*/
@SuppressWarnings("rawtypes")
public static List<String> extractMessage(Set<? extends ConstraintViolation> constraintViolations) {
List<String> errorMessages = Lists.newArrayList();
for (ConstraintViolation violation : constraintViolations) {
errorMessages.add(violation.getMessage());
}
return errorMessages;
}
/**
* 輔助方法, 轉換ConstraintViolationException中的Set<ConstraintViolations>為Map<property, message>.
*/
public static Map<String, String> extractPropertyAndMessage(ConstraintViolationException e) {
return extractPropertyAndMessage(e.getConstraintViolations());
}
/**
* 輔助方法, 轉換Set<ConstraintViolation>為Map<property, message>.
*/
@SuppressWarnings("rawtypes")
public static Map<String, String> extractPropertyAndMessage(Set<? extends ConstraintViolation> constraintViolations) {
Map<String, String> errorMessages = Maps.newHashMap();
for (ConstraintViolation violation : constraintViolations) {
errorMessages.put(violation.getPropertyPath().toString(), violation.getMessage());
}
return errorMessages;
}
/**
* 輔助方法, 轉換ConstraintViolationException中的Set<ConstraintViolations>為List<propertyPath message>.
*/
public static List<String> extractPropertyAndMessageAsList(ConstraintViolationException e) {
return extractPropertyAndMessageAsList(e.getConstraintViolations(), " ");
}
/**
* 輔助方法, 轉換Set<ConstraintViolations>為List<propertyPath message>.
*/
@SuppressWarnings("rawtypes")
public static List<String> extractPropertyAndMessageAsList(Set<? extends ConstraintViolation> constraintViolations) {
return extractPropertyAndMessageAsList(constraintViolations, " ");
}
/**
* 輔助方法, 轉換ConstraintViolationException中的Set<ConstraintViolations>為List<propertyPath +separator+ message>.
*/
public static List<String> extractPropertyAndMessageAsList(ConstraintViolationException e, String separator) {
return extractPropertyAndMessageAsList(e.getConstraintViolations(), separator);
}
/**
* 輔助方法, 轉換Set<ConstraintViolation>為List<propertyPath +separator+ message>.
*/
@SuppressWarnings("rawtypes")
public static List<String> extractPropertyAndMessageAsList(Set<? extends ConstraintViolation> constraintViolations,
String separator) {
List<String> errorMessages = Lists.newArrayList();
for (ConstraintViolation violation : constraintViolations) {
errorMessages.add(violation.getPropertyPath() + separator + violation.getMessage());
}
return errorMessages;
}
}
3.在Controller中使用
/**
* 3.將validation邏輯封裝成工具類，使用工具類對dto進行校驗，然后根據校驗結果做響應的處理
* @param user
* @return
* @author zhaowg3
* @Date 2017年4月19日
*/
@RequestMapping(value="/useValidator", method=RequestMethod.POST)
public ResponseEntity<?> useValidator(@RequestBody SwaggerUser user) {
ValidationResult validationResult = beanValidatorFail(user);
if(validationResult.isHasError()){
return ResponseEntity.ok(validationResult.getErrorMsg());
}
return ResponseEntity.ok(null);
}
/**
* 服務端參數有效性驗證是否失敗
* @param object 驗證的實體對象
* @param groups 驗證組
* @return 驗證成功：返回false；驗證失敗：返回true并將錯誤信息添加到 errMsgs 中
*/
private <T> ValidationResult beanValidatorFail(T object, Class<?>... groups) {
//ValidationResult為自己封裝的對象
ValidationResult validationResult = new ValidationResult();
try{
BeanValidators.validateWithException(validator, object, groups);
}catch(ConstraintViolationException ex){
List<String> errMsgs = BeanValidators.extractPropertyAndMessageAsList(ex, ": ");
validationResult.setHasError(true);
validationResult.setErrorMsg(errMsgs);
}
return validationResult;
}
