FieldAccessorFactory.java

  1. package com.gh.mygreen.xlsmapper.fieldaccessor;

  3. import java.lang.annotation.Annotation;
  4. import java.lang.reflect.Field;
  5. import java.lang.reflect.Method;
  6. import java.lang.reflect.ParameterizedType;
  7. import java.util.Collection;
  8. import java.util.Map;
  9. import java.util.Optional;

  11. import org.slf4j.Logger;
  12. import org.slf4j.LoggerFactory;

  14. import com.gh.mygreen.xlsmapper.annotation.XlsArrayCells;
  15. import com.gh.mygreen.xlsmapper.annotation.XlsArrayColumns;
  16. import com.gh.mygreen.xlsmapper.annotation.XlsIterateTables;
  17. import com.gh.mygreen.xlsmapper.annotation.XlsLabelledArrayCells;
  18. import com.gh.mygreen.xlsmapper.annotation.XlsMapColumns;
  19. import com.gh.mygreen.xlsmapper.localization.MessageBuilder;
  20. import com.gh.mygreen.xlsmapper.util.ArgUtils;
  21. import com.gh.mygreen.xlsmapper.util.ClassUtils;
  22. import com.gh.mygreen.xlsmapper.util.Utils;
  23. import com.gh.mygreen.xlsmapper.xml.AnnotationReader;

  25. /**
  26.  * {@link FieldAccessor}のインスタンスを作成するクラス。
  27.  *
  28.  * @version 2.1
  29.  * @since 2.0
  30.  * @author T.TSUCHIE
  31.  *
  32.  */
  33. public class FieldAccessorFactory {

  35.     private static Logger log = LoggerFactory.getLogger(FieldAccessorFactory.class);

  37.     private final AnnotationReader annoReader;

  39.     private PositionSetterFactory positionSetterFactory = new PositionSetterFactory();
  40.     private PositionGetterFactory positionGetterFactory = new PositionGetterFactory();
  41.     private MapPositionSetterFactory mapPositionSetterFactory = new MapPositionSetterFactory();
  42.     private ArrayPositionSetterFactory arrayPositionSetterFactory = new ArrayPositionSetterFactory();

  44.     private LabelSetterFactory labelSetterFactory = new LabelSetterFactory();
  45.     private LabelGetterFactory labelGetterFactory = new LabelGetterFactory();
  46.     private MapLabelSetterFactory mapLabelSetterFactory = new MapLabelSetterFactory();
  47.     private ArrayLabelSetterFactory arrayLabelSetterFactory = new ArrayLabelSetterFactory();
  48.     
  49.     private CommentSetterFactory commentSetterFactory = new CommentSetterFactory();
  50.     private CommentGetterFactory commentGetterFactory = new CommentGetterFactory();
  51.     
  52.     private MapCommentSetterFactory mapCommentSetterFactory = new MapCommentSetterFactory();
  53.     private MapCommentGetterFactory mapCommentGetterFactory = new MapCommentGetterFactory();
  54.     
  55.     private ArrayCommentSetterFactory arrayCommentSetterFactory = new ArrayCommentSetterFactory();
  56.     private ArrayCommentGetterFactory arrayCommentGetterFactory = new ArrayCommentGetterFactory();

  58.     
  59.     /**
  60.      * コンストラクタ
  61.      * @param annoReader XMLで定義したアノテーション情報を提供するクラス。
  62.      * @throws IllegalArgumentException {@literal annoReader == null.}
  63.      */
  64.     public FieldAccessorFactory(final AnnotationReader annoReader) {
  65.         ArgUtils.notNull(annoReader, "annoReader");

  67.         this.annoReader = annoReader;
  68.     }

  70.     /**
  71.      * フィールド情報を元にインスタンスを作成する。
  72.      * @param field フィールド
  73.      * @return フィールド情報を元に組み立てられたインスタンス。
  74.      * @throws IllegalArgumentException {@literal field == null.}
  75.      */
  76.     public FieldAccessor create(final Field field) {

  78.         ArgUtils.notNull(field, "field");

  80.         final FieldAccessor accessor = new FieldAccessor();

  82.         // 共通情報の設定
  83.         accessor.name = field.getName();
  84.         accessor.targetType = field.getType();
  85.         accessor.declaringClass = field.getDeclaringClass();

  87.         // フィールド情報の設定
  88.         setupWithFiled(accessor, field);

  90.         // getter情報の設定
  91.         if(ClassUtils.isPrimitiveBoolean(accessor.getType())) {
  92.             ClassUtils.extractBooleanGetter(accessor.getDeclaringClass(), accessor.getName())
  93.                     .ifPresent(getter -> setupWithGetter(accessor, getter));

  95.         } else {
  96.             ClassUtils.extractGetter(accessor.getDeclaringClass(), accessor.getName(), accessor.getType())
  97.                     .ifPresent(getter -> setupWithGetter(accessor, getter));
  98.         }

  100.         // setter情報の設定
  101.         ClassUtils.extractSetter(accessor.getDeclaringClass(), accessor.getName(), accessor.getType())
  102.                 .ifPresent(setter -> setupWithSetter(accessor, setter));

  104.         // コンポーネントタイプの設定
  105.         if(Collection.class.isAssignableFrom(accessor.getType())) {
  106.             ParameterizedType type = (ParameterizedType) field.getGenericType();
  107.             accessor.componentType = Optional.of((Class<?>) type.getActualTypeArguments()[0]);

  109.         } else if(accessor.getType().isArray()) {
  110.             accessor.componentType = Optional.of(accessor.getType().getComponentType());

  112.         } else if(Map.class.isAssignableFrom(accessor.getType())) {
  113.             ParameterizedType type = (ParameterizedType) field.getGenericType();
  114.             accessor.componentType = Optional.of((Class<?>) type.getActualTypeArguments()[1]);
  115.         }

  117.         // 位置・ラベル情報のアクセッサの設定
  118.         if(accessor.hasAnnotation(XlsMapColumns.class)) {
  119.             // マップ形式の場合
  120.             accessor.mapPositionSetter = mapPositionSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  121.             accessor.mapLabelSetter = mapLabelSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  122.             
  123.             accessor.mapCommentSetter = mapCommentSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  124.             accessor.mapCommentGetter = mapCommentGetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  125.             

  127.         } else if(accessor.hasAnnotation(XlsArrayColumns.class)
  128.                 || accessor.hasAnnotation(XlsArrayCells.class)
  129.                 || accessor.hasAnnotation(XlsLabelledArrayCells.class)
  130.                 || accessor.hasAnnotation(XlsIterateTables.class)){
  131.             // リストや配列形式の場合
  132.             accessor.arrayPositionSetter = arrayPositionSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  133.             accessor.arrayLabelSetter = arrayLabelSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  134.             
  135.             accessor.arrayCommentSetter = arrayCommentSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  136.             accessor.arrayCommentGetter = arrayCommentGetterFactory.create(accessor.getDeclaringClass(), accessor.getName());

  138.             if(accessor.hasAnnotation(XlsArrayColumns.class)
  139.                     || accessor.hasAnnotation(XlsLabelledArrayCells.class)) {
  140.                 // インデックスが付いていないラベルの設定
  141.                 accessor.labelSetter = labelSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  142.             }

  144.         } else {
  145.             // リストやMapではない通常のプロパティの場合
  146.             accessor.positionSetter = positionSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  147.             accessor.positionGetter = positionGetterFactory.create(accessor.getDeclaringClass(), accessor.getName());

  149.             accessor.labelSetter = labelSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  150.             accessor.labelGetter = labelGetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  151.             
  152.             accessor.commentSetter = commentSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  153.             accessor.commentGetter = commentGetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  154.             

  156.         }

  158.         return accessor;
  159.     }

  161.     /**
  162.      * メソッド情報を元にインスタンスを作成する。
  163.      * @param method メソッド情報
  164.      * @return メソッド情報を元に組み立てられたインスタンス。
  165.      * @throws IllegalArgumentException {@literal method == null.}
  166.      * @throws IllegalArgumentException {@literal methodの名称がsetterまたはgetterの書式でない場合。}
  167.      */
  168.     public FieldAccessor create(final Method method) {

  170.         ArgUtils.notNull(method, "method");

  172.         final FieldAccessor accessor = new FieldAccessor();

  174.         final String methodName = method.getName();
  175.         if(ClassUtils.isGetterMethod(method) || ClassUtils.isBooleanGetterMethod(method)) {
  176.             final String propertyName;
  177.             if(methodName.startsWith("get")) {
  178.                 propertyName = Utils.uncapitalize(methodName.substring(3));
  179.             } else {
  180.                 propertyName = Utils.uncapitalize(methodName.substring(2));
  181.             }

  183.             // 共通情報の設定
  184.             accessor.name = propertyName;
  185.             accessor.targetType = method.getReturnType();
  186.             accessor.declaringClass = method.getDeclaringClass();

  188.             // getter情報の設定
  189.             setupWithGetter(accessor, method);

  191.             // フィールド情報の設定
  192.             ClassUtils.extractField(accessor.getDeclaringClass(), accessor.getName(), accessor.getType())
  193.                     .ifPresent(field -> setupWithFiled(accessor, field));

  195.             // setter情報の設定
  196.             ClassUtils.extractSetter(accessor.getDeclaringClass(), accessor.getName(), accessor.getType())
  197.                     .ifPresent(setter -> setupWithSetter(accessor, setter));

  199.             // コンポーネントタイプの設定
  200.             if(Collection.class.isAssignableFrom(accessor.getType())) {
  201.                 ParameterizedType type = (ParameterizedType) method.getGenericReturnType();
  202.                 accessor.componentType = Optional.of((Class<?>) type.getActualTypeArguments()[0]);

  204.             } else if(accessor.getType().isArray()) {
  205.                 accessor.componentType = Optional.of(accessor.getType().getComponentType());

  207.             } else if(Map.class.isAssignableFrom(accessor.getType())) {
  208.                 ParameterizedType type = (ParameterizedType) method.getGenericReturnType();
  209.                 accessor.componentType = Optional.of((Class<?>) type.getActualTypeArguments()[1]);
  210.             }

  212.         } else if(ClassUtils.isSetterMethod(method)) {
  213.             final String propertyName = Utils.uncapitalize(methodName.substring(3));

  215.             // 共通情報の設定
  216.             accessor.name = propertyName;
  217.             accessor.targetType = method.getParameterTypes()[0];
  218.             accessor.declaringClass = method.getDeclaringClass();

  220.             // setter情報の設定
  221.             setupWithSetter(accessor, method);

  223.             // フィールド情報の設定
  224.             ClassUtils.extractField(accessor.getDeclaringClass(), accessor.getName(), accessor.getType())
  225.                     .ifPresent(field -> setupWithFiled(accessor, field));

  227.             // getter情報の設定
  228.             if(ClassUtils.isPrimitiveBoolean(accessor.getType())) {
  229.                 ClassUtils.extractBooleanGetter(accessor.getDeclaringClass(), accessor.getName())
  230.                         .ifPresent(getter -> setupWithGetter(accessor, getter));

  232.             } else {
  233.                 ClassUtils.extractGetter(accessor.getDeclaringClass(), accessor.getName(), accessor.getType())
  234.                         .ifPresent(getter -> setupWithGetter(accessor, getter));
  235.             }

  237.             // コンポーネントタイプの設定
  238.             if(Collection.class.isAssignableFrom(accessor.getType())) {
  239.                 ParameterizedType type = (ParameterizedType) method.getGenericParameterTypes()[0];
  240.                 accessor.componentType = Optional.of((Class<?>) type.getActualTypeArguments()[0]);

  242.             } else if(accessor.getType().isArray()) {
  243.                 accessor.componentType = Optional.of(accessor.getType().getComponentType());

  245.             } else if(Map.class.isAssignableFrom(accessor.getType())) {
  246.                 ParameterizedType type = (ParameterizedType) method.getGenericParameterTypes()[0];
  247.                 accessor.componentType = Optional.of((Class<?>) type.getActualTypeArguments()[1]);
  248.             }

  250.         } else {
  251.             throw new IllegalArgumentException(MessageBuilder.create("method.noAccessor")
  252.                     .varWithClass("className", method.getDeclaringClass())
  253.                     .var("methodName", methodName)
  254.                     .format());
  255.         }

  257.         // 位置・ラベル情報のアクセッサの設定
  258.         if(accessor.hasAnnotation(XlsMapColumns.class)) {
  259.             accessor.mapPositionSetter = mapPositionSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  260.             accessor.mapLabelSetter = mapLabelSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());

  262.         } else if(accessor.hasAnnotation(XlsArrayColumns.class)
  263.                 || accessor.hasAnnotation(XlsArrayCells.class)
  264.                 || accessor.hasAnnotation(XlsLabelledArrayCells.class)
  265.                 || accessor.hasAnnotation(XlsIterateTables.class)){
  266.             // リストや配列形式の場合
  267.             accessor.arrayPositionSetter = arrayPositionSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  268.             accessor.arrayLabelSetter = arrayLabelSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());

  270.             if(accessor.hasAnnotation(XlsArrayColumns.class)
  271.                     || accessor.hasAnnotation(XlsLabelledArrayCells.class)) {
  272.                 // インデックスが付いていないラベルの設定
  273.                 accessor.labelSetter = labelSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  274.             }

  276.         } else {
  277.             // XlsMapColumnsを持たない通常のプロパティの場合
  278.             accessor.positionSetter = positionSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  279.             accessor.positionGetter = positionGetterFactory.create(accessor.getDeclaringClass(), accessor.getName());

  281.             accessor.labelSetter = labelSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  282.             accessor.labelGetter = labelGetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  283.             
  284.             accessor.commentSetter = commentSetterFactory.create(accessor.getDeclaringClass(), accessor.getName());
  285.             accessor.commentGetter = commentGetterFactory.create(accessor.getDeclaringClass(), accessor.getName());

  287.         }


  290.         return accessor;
  291.     }

  293.     private void setupWithFiled(final FieldAccessor accessor, final Field field) {

  295.         accessor.targetField = Optional.of(field);

  297.         final Annotation[] annos = annoReader.getAnnotations(field);
  298.         for(Annotation anno : annos) {
  299.             if(!isSupportedAnnotation(anno)) {
  300.                 continue;
  301.             }

  303.             final Class<? extends Annotation> annoClass = anno.annotationType();

  305.             if(accessor.annotationMap.containsKey(annoClass)) {
  306.                 final String message = MessageBuilder.create("anno.duplicated")
  307.                         .varWithClass("classType", accessor.getDeclaringClass())
  308.                         .var("property", field.getName())
  309.                         .varWithAnno("anno", annoClass)
  310.                         .format();
  311.                 log.warn(message);
  312.             }

  314.             accessor.annotationMap.put(annoClass, anno);
  315.         }


  318.     }

  320.     private void setupWithGetter(final FieldAccessor accessor, final Method method) {

  322.         accessor.targetGetter = Optional.of(method);

  324.         final Annotation[] annos = annoReader.getAnnotations(method);
  325.         for(Annotation anno : annos) {
  326.             if(!isSupportedAnnotation(anno)) {
  327.                 continue;
  328.             }

  330.             final Class<? extends Annotation> annoClass = anno.annotationType();

  332.             if(accessor.annotationMap.containsKey(annoClass)) {
  333.                 final String message = MessageBuilder.create("anno.duplicated")
  334.                         .varWithClass("classType", accessor.getDeclaringClass())
  335.                         .var("property", method.getName() + "()")
  336.                         .varWithAnno("anno", annoClass)
  337.                         .format();
  338.                 log.warn(message);
  339.             }

  341.             accessor.annotationMap.put(annoClass, anno);
  342.         }
  343.     }

  345.     private void setupWithSetter(final FieldAccessor accessor, final Method method) {

  347.         accessor.targetSetter = Optional.of(method);

  349.         final Annotation[] annos = annoReader.getAnnotations(method);
  350.         for(Annotation anno : annos) {
  351.             if(!isSupportedAnnotation(anno)) {
  352.                 continue;
  353.             }

  355.             final Class<? extends Annotation> annoClass = anno.annotationType();

  357.             if(accessor.annotationMap.containsKey(annoClass)) {
  358.                 final String message = MessageBuilder.create("anno.duplicated")
  359.                         .varWithClass("classType", accessor.getDeclaringClass())
  360.                         .var("property", method.getName() + "(...)")
  361.                         .varWithAnno("anno", annoClass)
  362.                         .format();
  363.                 log.warn(message);
  364.             }

  366.             accessor.annotationMap.put(annoClass, anno);
  367.         }
  368.     }

  370.     /**
  371.      * サポートするアノテーションか判定する。
  372.      * <p>確実に重複するJava標準のアノテーションは除外するようにします。</p>
  373.      *
  374.      * @param anno 判定対象のアノテーション
  375.      * @return tureの場合、サポートします。
  376.      */
  377.     private boolean isSupportedAnnotation(final Annotation anno) {

  379.         final String name = anno.annotationType().getName();
  380.         if(name.startsWith("java.lang.annotation.")) {
  381.             return false;
  382.         }

  384.         return true;
  385.     }

  387. }
Created with JaCoCo 0.8.5.201910111838