SheetBeanValidator.java

  1. package com.gh.mygreen.xlsmapper.validation.beanvalidation;

  3. import java.lang.reflect.InvocationTargetException;
  4. import java.lang.reflect.Method;
  5. import java.util.Collections;
  6. import java.util.HashMap;
  7. import java.util.HashSet;
  8. import java.util.Map;
  9. import java.util.Objects;
  10. import java.util.Optional;
  11. import java.util.Set;

  13. import javax.validation.ConstraintViolation;
  14. import javax.validation.Path;
  15. import javax.validation.Validation;
  16. import javax.validation.Validator;
  17. import javax.validation.ValidatorFactory;
  18. import javax.validation.metadata.ConstraintDescriptor;

  20. import org.hibernate.validator.internal.engine.path.NodeImpl;
  21. import org.hibernate.validator.internal.engine.path.PathImpl;
  22. import org.slf4j.Logger;
  23. import org.slf4j.LoggerFactory;

  25. import com.gh.mygreen.xlsmapper.fieldaccessor.LabelGetterFactory;
  26. import com.gh.mygreen.xlsmapper.fieldaccessor.PositionGetterFactory;
  27. import com.gh.mygreen.xlsmapper.localization.MessageInterpolator;
  28. import com.gh.mygreen.xlsmapper.localization.ResourceBundleMessageResolver;
  29. import com.gh.mygreen.xlsmapper.util.ArgUtils;
  30. import com.gh.mygreen.xlsmapper.util.CellPosition;
  31. import com.gh.mygreen.xlsmapper.util.Utils;
  32. import com.gh.mygreen.xlsmapper.validation.FieldError;
  33. import com.gh.mygreen.xlsmapper.validation.ObjectValidator;
  34. import com.gh.mygreen.xlsmapper.validation.SheetBindingErrors;
  35. import com.gh.mygreen.xlsmapper.validation.fieldvalidation.FieldFormatter;


  38. /**
  39.  * Bean Validaion JSR-303(ver.1.0)/JSR-349(ver.1.1)/JSR-380(ver.2.0)を利用したValidator.
  40.  * 
  41.  * @version 2.3
  42.  * @author T.TSUCHIE
  43.  *
  44.  */
  45. public class SheetBeanValidator implements ObjectValidator<Object> {
  46.     
  47.     private static final Logger logger = LoggerFactory.getLogger(SheetBeanValidator.class);
  48.     
  49.     /**
  50.      * BeanValidationのアノテーションの属性で、メッセージ中の変数から除外するもの。
  51.      * <p>メッセージの再構築を行う際に必要
  52.      */
  53.     private static final Set<String> EXCLUDE_MESSAGE_ANNOTATION_ATTRIBUTES;
  54.     static {
  55.         Set<String> set = new HashSet<String>(3);
  56.         set.add("message");
  57.         set.add("groups");
  58.         set.add("payload");
  59.         
  60.         EXCLUDE_MESSAGE_ANNOTATION_ATTRIBUTES = Collections.unmodifiableSet(set);
  61.     }
  62.     
  63.     private final Validator targetValidator;
  64.     
  65.     public SheetBeanValidator(final Validator targetValidator) {
  66.         ArgUtils.notNull(targetValidator, "targetValidator");
  67.         this.targetValidator = targetValidator;
  68.     }
  69.     
  70.     public SheetBeanValidator() {
  71.         this.targetValidator = createDefaultValidator();
  72.     }
  73.     
  74.     /**
  75.      * Bean Validaion のデフォルトのインスタンスを作成する。
  76.      * @return Validatorのインスタンス。
  77.      */
  78.     protected Validator createDefaultValidator() {
  79.         
  80.         final ValidatorFactory validatorFactory = Validation.byDefaultProvider().configure()
  81.                 .messageInterpolator(new MessageInterpolatorAdapter(new ResourceBundleMessageResolver(), new MessageInterpolator()))
  82.                 .buildValidatorFactory();
  83.         final Validator validator = validatorFactory.usingContext()
  84.                 .getValidator();
  85.         
  86.         return validator;
  87.     }
  88.     
  89.     /**
  90.      * Bean ValidationのValidatorを取得する。
  91.      * @return Validatorのインスタンス。
  92.      */
  93.     public Validator getTargetValidator() {
  94.         return targetValidator;
  95.     }
  96.     
  97.     /**
  98.      * グループを指定して検証を実行する。
  99.      * @param targetObj 検証対象のオブジェクト。
  100.      * @param errors エラーオブジェクト
  101.      * @param groups BeanValiationのグループのクラス
  102.      */
  103.     @Override
  104.     public void validate(final Object targetObj, final SheetBindingErrors<?> errors, final Class<?>... groups) {
  105.         
  106.         ArgUtils.notNull(targetObj, "targetObj");
  107.         ArgUtils.notNull(errors, "errors");
  108.         
  109.         processConstraintViolation(getTargetValidator().validate(targetObj, groups), errors);
  110.         
  111.     }
  112.     
  113.     /**
  114.      * BeanValidationの検証結果をSheet用のエラーに変換する
  115.      * @param violations BeanValidationの検証結果
  116.      * @param errors シートのエラー
  117.      */
  118.     protected void processConstraintViolation(final Set<ConstraintViolation<Object>> violations,
  119.             final SheetBindingErrors<?> errors) {
  120.         
  121.         for(ConstraintViolation<Object> violation : violations) {
  122.             
  123.             final String fieldName = violation.getPropertyPath().toString();
  124.             final Optional<FieldError> fieldError = errors.getFirstFieldError(fieldName);
  125.             
  126.             if(fieldError.isPresent() && fieldError.get().isConversionFailure()) {
  127.                 // 型変換エラーが既存のエラーにある場合は、処理をスキップする。
  128.                 continue;
  129.             }
  130.             
  131.             final ConstraintDescriptor<?> cd = violation.getConstraintDescriptor();
  132.             
  133.             final String[] errorCodes = determineErrorCode(cd);
  134.             
  135.             final Map<String, Object> errorVars = createVariableForConstraint(cd);
  136.             
  137.             final String nestedPath = errors.buildFieldPath(fieldName);
  138.             if(Utils.isEmpty(nestedPath)) {
  139.                 // オブジェクトエラーの場合
  140.                 errors.createGlobalError(errorCodes)
  141.                     .variables(errorVars)
  142.                     .defaultMessage(violation.getMessageTemplate())
  143.                     .buildAndAddError();
  144.                 
  145.             } else {
  146.                 // フィールドエラーの場合
  147.                 
  148.                 // 親のオブジェクトから、セルの座標を取得する
  149.                 final Object parentObj = violation.getLeafBean();
  150.                 final Path path = violation.getPropertyPath();
  151.                 Optional<CellPosition> cellAddress = Optional.empty();
  152.                 Optional<String> label = Optional.empty();
  153.                 if(Path.class.isAssignableFrom(PathImpl.class)) {
  154.                     final String pathNodeName = getPathNodeName(path);
  155.                     cellAddress = new PositionGetterFactory().create(parentObj.getClass(), pathNodeName)
  156.                             .map(getter -> getter.get(parentObj)).orElse(Optional.empty());
  157.                     
  158.                     label = new LabelGetterFactory().create(parentObj.getClass(), pathNodeName)
  159.                             .map(getter -> getter.get(parentObj)).orElse(Optional.empty());
  160.                     
  161.                 }
  162.                 
  163.                 // フィールドフォーマッタ
  164.                 Class<?> fieldType = errors.getFieldType(nestedPath);
  165.                 if(fieldType != null) {
  166.                     FieldFormatter<?> fieldFormatter = errors.findFieldFormatter(nestedPath, fieldType);
  167.                     if(fieldFormatter != null) {
  168.                         errorVars.putIfAbsent("fieldFormatter", fieldFormatter);
  169.                     }
  170.                 }
  171.                 
  172.                 // 実際の値を取得する
  173.                 errorVars.putIfAbsent("validatedValue", violation.getInvalidValue());
  174.                 
  175.                 errors.createFieldError(fieldName, errorCodes)
  176.                     .variables(errorVars)
  177.                     .address(cellAddress)
  178.                     .label(label)
  179.                     .defaultMessage(violation.getMessageTemplate())
  180.                     .buildAndAddError();
  181.                 
  182.             }
  183.             
  184.         }
  185.         
  186.     }
  187.     
  188.     /**
  189.      * BeanValidationのPathの名称を取得する。
  190.      * <p>Hibernateのバージョンにより、パッケージが異なるのでリフレクションで取得する。
  191.      * 
  192.      * @param path パス
  193.      * @return 名称
  194.      */
  195.     private String getPathNodeName(final Path path) {
  196.         
  197.         try {
  198.             Method getLeafNodeMethod = PathImpl.class.getMethod("getLeafNode");
  199.             Object leafNodeObj = getLeafNodeMethod.invoke(path);
  200.             if(leafNodeObj == null) {
  201.                 return null;
  202.             }
  203.             
  204.             Method getNodeNameMethod = NodeImpl.class.getMethod("getName");
  205.             Object nodeName = getNodeNameMethod.invoke(leafNodeObj);
  206.             return nodeName != null ? nodeName.toString() : null;
  207.             
  208.         } catch (NoSuchMethodException | SecurityException | IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
  209.             throw new RuntimeException("fail PathImple.getLeafNode().getName()", e);
  210.         }
  211.         
  212.     }
  213.     
  214.     /**
  215.      * エラーコードを決定する。
  216.      * <p>※ユーザ指定メッセージの場合はエラーコードは空。</p>
  217.      * 
  218.      * @since 2.3
  219.      * @param descriptor フィールド情報
  220.      * @return エラーコード
  221.      */
  222.     protected String[] determineErrorCode(final ConstraintDescriptor<?> descriptor) {
  223.         
  224.         // バリデーション用アノテーションから属性「message」のでデフォルト値を取得し、変更されているかどう比較する。
  225.         String defaultMessage = null;
  226.         try {
  227.             Method messageMethod = descriptor.getAnnotation().annotationType().getMethod("message");
  228.             messageMethod.setAccessible(true);
  229.             defaultMessage = Objects.toString(messageMethod.getDefaultValue(), null);
  230.         } catch (NoSuchMethodException | SecurityException e) {
  231.             logger.warn("Fail getting annotation's attribute 'message' for " + descriptor.getAnnotation().annotationType().getSimpleName() , e);
  232.         }
  233.         
  234.         if(!descriptor.getMessageTemplate().equals(defaultMessage)) {
  235.             /*
  236.              * アノテーション属性「message」の値がデフォルト値から変更されている場合は、
  237.              * ユーザー指定メッセージとして判断し、エラーコードは空にしてユーザー指定メッセージを優先させる。
  238.              */
  239.             return new String[]{};
  240.             
  241.         } else {
  242.             // アノテーションのクラス名をもとに生成する。
  243.             return new String[]{
  244.                     descriptor.getAnnotation().annotationType().getSimpleName(),
  245.                     descriptor.getAnnotation().annotationType().getCanonicalName(),
  246.                     descriptor.getAnnotation().annotationType().getCanonicalName() + ".message"
  247.             };
  248.         }
  249.     }
  250.     
  251.     /**
  252.      * BeanValidationのアノテーションの値を元に、メッセージ変数を作成する。
  253.      * @param descriptor
  254.      * @return メッセージ変数
  255.      */
  256.     protected Map<String, Object> createVariableForConstraint(final ConstraintDescriptor<?> descriptor) {
  257.         
  258.         final Map<String, Object> vars = new HashMap<String, Object>();
  259.         
  260.         for(Map.Entry<String, Object> entry : descriptor.getAttributes().entrySet()) {
  261.             final String attrName = entry.getKey();
  262.             final Object attrValue = entry.getValue();
  263.             
  264.             // メッセージ変数で必要ないものを除外する
  265.             if(EXCLUDE_MESSAGE_ANNOTATION_ATTRIBUTES.contains(attrName)) {
  266.                 continue;
  267.             }
  268.             
  269.             vars.put(attrName, attrValue);
  270.         }
  271.         
  272.         return vars;
  273.         
  274.     }
  275.     
  276. }
Created with JaCoCo 0.8.5.201910111838