com.github.ibole.infrastructure.common.utils.BeanValidators Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of infrastructure-all Show documentation
The all in one project of ibole infrastructure
The newest version!
package com.github.ibole.infrastructure.common.utils;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;

import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import javax.validation.Validator;

/**
 * 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>
 * 
 */
public class BeanValidators {

  /**
   * 调用JSR303的validate方法, 验证失败时抛出ConstraintViolationException.
   * 
   * @param validator the validator
   * @param object the object to validate
   * @param groups the group or list of groups targeted for validation
   * @exception ConstraintViolationException exception if constraint violations are not empty
   */
  @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>.
   * 
   * @param e the constraint violation exception
   * @return the error message list
   */
  public static List extractMessage(ConstraintViolationException e) {
    return extractMessage(e.getConstraintViolations());
  }

  /**
   * 辅助方法, 转换Set<ConstraintViolation>为List<message>
   * 
   * @param constraintViolations the set of constraint violation
   * @return the error message list
   */
  @SuppressWarnings("rawtypes")
  public static List extractMessage(Set constraintViolations) {
    List errorMessages = Lists.newArrayList();
    for (ConstraintViolation violation : constraintViolations) {
      errorMessages.add(violation.getMessage());
    }
    return errorMessages;
  }

  /**
   * 辅助方法, 转换ConstraintViolationException中的Set<ConstraintViolations>为Map<property,
   * \message>.
   * 
   * @param e the constraint violation exception
   * @return the error message Map
   */
  public static Map extractPropertyAndMessage(ConstraintViolationException e) {
    return extractPropertyAndMessage(e.getConstraintViolations());
  }

  /**
   * 辅助方法, 转换Set<ConstraintViolation>为Map<property, message>.
   * 
   * @param constraintViolations the set of constraint violation
   * @return the error message Map
   */
  @SuppressWarnings("rawtypes")
  public static Map extractPropertyAndMessage(
      Set constraintViolations) {
    Map errorMessages = Maps.newHashMap();
    for (ConstraintViolation violation : constraintViolations) {
      errorMessages.put(violation.getPropertyPath().toString(), violation.getMessage());
    }
    return errorMessages;
  }

  /**
   * 辅助方法, 转换ConstraintViolationException中的Set<ConstraintViolations>为List<propertyPath
   * message>.
   * 
   * @param e the constraint violation exception
   * @return the error message list
   */
  public static List extractPropertyAndMessageAsList(ConstraintViolationException e) {
    return extractPropertyAndMessageAsList(e.getConstraintViolations(), " ");
  }

  /**
   * 辅助方法, 转换Set<ConstraintViolations>为List<propertyPath message>.
   * 
   * @param constraintViolations the set of constraint violation
   * @return the error message list
   */
  @SuppressWarnings("rawtypes")
  public static List extractPropertyAndMessageAsList(
      Set constraintViolations) {
    return extractPropertyAndMessageAsList(constraintViolations, " ");
  }

  /**
   * 辅助方法, 转换ConstraintViolationException中的Set<ConstraintViolations>为List<propertyPath
   * +separator+ message>.
   * 
   * @param e the constraint violation exception
   * @param separator the separator to concatenate char
   * @return the error message list
   */
  public static List extractPropertyAndMessageAsList(ConstraintViolationException e,
      String separator) {
    return extractPropertyAndMessageAsList(e.getConstraintViolations(), separator);
  }

  /**
   * 辅助方法, 转换Set<ConstraintViolation>为List<propertyPath +separator+ message>.
   * 
   * @param constraintViolations the set of constraint violation
   * @param separator the separator to concatenate char
   * @return the error message list
   */
  @SuppressWarnings("rawtypes")
  public static List extractPropertyAndMessageAsList(
      Set constraintViolations, String separator) {
    List errorMessages = Lists.newArrayList();
    for (ConstraintViolation violation : constraintViolations) {
      errorMessages.add(violation.getPropertyPath() + separator + violation.getMessage());
    }
    return errorMessages;
  }
}