com.yqjr.framework.component.validator.BeanValidators Maven / Gradle / Ivy

/**
 * Copyright (c) 2005-2012 springside.org.cn
 */
package com.yqjr.framework.component.validator;

import java.util.ArrayList;
import java.util.HashMap;
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. MappropertyPath,
 * message
 * 
 * 详情见wiki: https://github.com/springside/springside4/wiki/HibernateValidator
 * 
 * @author calvin
 * @version 2013-01-15
 */
public class BeanValidators {

	/**
	 * 调用JSR303的validate方法, 验证失败时抛出ConstraintViolationException.
	 * 
	 * @param validator Validator
	 * @param object Object
	 * @param groups Class
	 */
	@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
	 * @param e 异常消息
	 * @return List
	 */
	public static List extractMessage(ConstraintViolationException e) {
		return extractMessage(e.getConstraintViolations());
	}

	/**
	 * 辅助方法, 转换Set ConstraintViolation 为List message
	 * @param constraintViolations Set
	 * @return List
	 */
	@SuppressWarnings("rawtypes")
	public static List extractMessage(Set constraintViolations) {
		List errorMessages = new ArrayList();
		for (ConstraintViolation violation : constraintViolations) {
			errorMessages.add(violation.getMessage());
		}
		return errorMessages;
	}

	/**
	 * 辅助方法, 转换ConstraintViolationException中的Set
	 *  ConstraintViolations 为Mapproperty, message.
	 * @param e ConstraintViolationException
	 * @return List
	 */
	public static Map extractPropertyAndMessage(ConstraintViolationException e) {
		return extractPropertyAndMessage(e.getConstraintViolations());
	}

	/**
	 * 辅助方法, 转换Set ConstraintViolation 为Map property, message .
	 * @return Map
	 */
	@SuppressWarnings("rawtypes")
	public static Map extractPropertyAndMessage(
			Set constraintViolations) {
		Map errorMessages = new HashMap();
		for (ConstraintViolation violation : constraintViolations) {
			errorMessages.put(violation.getPropertyPath().toString(), violation.getMessage());
		}
		return errorMessages;
	}

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

	/**
	 * 辅助方法, 转换Set ConstraintViolations 为List propertyPath message .
	 * @param constraintViolations Set
	 * @return List
	 */
	@SuppressWarnings("rawtypes")
	public static List extractPropertyAndMessageAsList(
			Set constraintViolations) {
		return extractPropertyAndMessageAsList(constraintViolations, " ");
	}

	/**
	 * 辅助方法, 转换ConstraintViolationException中的Set
	 * ConstraintViolations 为List propertyPath +separator+ message .
	 * @param e ConstraintViolationException
	 * @param separator String
	 * @return List
	 */
	public static List extractPropertyAndMessageAsList(ConstraintViolationException e, String separator) {
		return extractPropertyAndMessageAsList(e.getConstraintViolations(), separator);
	}

	/**
	 * 辅助方法, 转换Set ConstraintViolation 为List propertyPath +separator+ message .
	 * @param constraintViolations Set
	 * @param separator String
	 * @return List
	 */
	@SuppressWarnings("rawtypes")
	public static List extractPropertyAndMessageAsList(Set constraintViolations,
			String separator) {
		List errorMessages = new ArrayList();
		for (ConstraintViolation violation : constraintViolations) {
			errorMessages.add(violation.getPropertyPath() + separator + violation.getMessage());
		}
		return errorMessages;
	}
}