com.hb0730.commons.spring.ValidatorUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-spring Show documentation
常用的spring操作
There is a newer version: 2.1.2-RELEASE
package com.hb0730.commons.spring;

import com.hb0730.commons.lang.collection.CollectionUtils;
import org.hibernate.validator.internal.engine.path.PathImpl;
import org.springframework.lang.NonNull;
import org.springframework.lang.Nullable;
import org.springframework.validation.FieldError;

import javax.validation.*;
import java.util.*;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * 校验
 *
 * @author bing_huang
 * @since 1.0.0
 */
public class ValidatorUtils {
    private static volatile Validator VALIDATOR;

    /**
     * 获取validator
     *
     * @return {@link Validator}
     */
    public static javax.validation.Validator getValidator() {
        if (VALIDATOR == null) {
            synchronized (ValidatorUtils.class) {
                if (VALIDATOR == null) {
                    VALIDATOR = Validation.buildDefaultValidatorFactory().getValidator();
                }
            }
        }
        return VALIDATOR;
    }

    /**
     * 单一校验
     *
     * @param obj   需校验的bean
     * @param group 分组
     * @throws ConstraintViolationException 异常
     */
    public static void validate(Object obj, Class... group) {
        javax.validation.Validator validator = getValidator();
        Set> constraintViolations = validator.validate(obj, group);
        if (!org.springframework.util.CollectionUtils.isEmpty(constraintViolations)) {
            throw new ConstraintViolationException(constraintViolations);
        }
    }

    /**
     * 批量校验
     *
     * @param objs   iterable
     * @param groups groups
     * @throws ConstraintViolationException 异常
     */
    public static void validateList(@Nullable Iterable objs, @Nullable Class... groups) {
        if (objs == null) {
            return;
        }
        javax.validation.Validator validator = getValidator();

        // wrap index
        AtomicInteger i = new AtomicInteger(0);
        final Set> allViolations = new LinkedHashSet<>();
        objs.forEach(obj -> {
            int index = i.getAndIncrement();
            Set> violations = validator.validate(obj, groups);
            violations.forEach(violation -> {
                Path path = violation.getPropertyPath();
                if (path instanceof PathImpl) {
                    PathImpl pathImpl = (PathImpl) path;
                    pathImpl.makeLeafNodeIterableAndSetIndex(index);
                }
                allViolations.add(violation);
            });
        });
        if (!org.springframework.util.CollectionUtils.isEmpty(allViolations)) {
            throw new ConstraintViolationException(allViolations);
        }
    }

    /**
     * 将字段验证错误转换为标准的map型，key:value = field:message
     *
     * @param constraintViolations constraint violations(contain error information)
     * @return error detail map
     */
    @NonNull
    public static Map mapWithValidError(Set> constraintViolations) {
        if (org.springframework.util.CollectionUtils.isEmpty(constraintViolations)) {
            return Collections.emptyMap();
        }

        Map errMap = new HashMap<>(4);
        // Format the error message
        constraintViolations.forEach(
                constraintViolation ->
                        errMap.put(constraintViolation.getPropertyPath().toString(), constraintViolation.getMessage()));
        return errMap;
    }

    /**
     * 将字段验证错误转换为标准的map型，key:value = field:message
     *
     * @param fieldErrors 字段错误组
     * @return 如果返回null，则表示未出现错误
     */
    public static Map mapWithFieldError(@Nullable List fieldErrors) {
        if (CollectionUtils.isEmpty(fieldErrors)) {
            return Collections.emptyMap();
        }

        Map errMap = new HashMap<>(4);
        fieldErrors.forEach(filedError -> errMap.put(filedError.getField(), filedError.getDefaultMessage()));
        return errMap;
    }
}