XlsSaver.java

  1. package com.gh.mygreen.xlsmapper;

  3. import java.io.IOException;
  4. import java.io.InputStream;
  5. import java.io.OutputStream;
  6. import java.lang.annotation.Annotation;
  7. import java.lang.reflect.Field;
  8. import java.lang.reflect.Method;
  9. import java.util.ArrayList;
  10. import java.util.Collections;
  11. import java.util.List;

  13. import org.apache.poi.ss.usermodel.Sheet;
  14. import org.apache.poi.ss.usermodel.Workbook;
  15. import org.apache.poi.ss.usermodel.WorkbookFactory;
  16. import org.slf4j.Logger;
  17. import org.slf4j.LoggerFactory;

  19. import com.gh.mygreen.xlsmapper.annotation.XlsFieldProcessor;
  20. import com.gh.mygreen.xlsmapper.annotation.XlsListener;
  21. import com.gh.mygreen.xlsmapper.annotation.XlsPostSave;
  22. import com.gh.mygreen.xlsmapper.annotation.XlsPreSave;
  23. import com.gh.mygreen.xlsmapper.annotation.XlsSheet;
  24. import com.gh.mygreen.xlsmapper.fieldaccessor.FieldAccessor;
  25. import com.gh.mygreen.xlsmapper.fieldaccessor.FieldAccessorFactory;
  26. import com.gh.mygreen.xlsmapper.fieldaccessor.FieldAccessorProxy;
  27. import com.gh.mygreen.xlsmapper.fieldaccessor.FieldAccessorProxyComparator;
  28. import com.gh.mygreen.xlsmapper.fieldprocessor.FieldProcessor;
  29. import com.gh.mygreen.xlsmapper.fieldprocessor.ProcessCase;
  30. import com.gh.mygreen.xlsmapper.localization.MessageBuilder;
  31. import com.gh.mygreen.xlsmapper.util.ArgUtils;
  32. import com.gh.mygreen.xlsmapper.util.ClassUtils;
  33. import com.gh.mygreen.xlsmapper.util.Utils;
  34. import com.gh.mygreen.xlsmapper.validation.MultipleSheetBindingErrors;
  35. import com.gh.mygreen.xlsmapper.validation.SheetBindingErrors;
  36. import com.gh.mygreen.xlsmapper.xml.AnnotationReader;


  39. /**
  40.  * JavaBeanをExcelのシートにマッピングし出力するクラス。
  41.  *
  42.  * @version 2.0
  43.  * @author T.TSUCHIE
  44.  *
  45.  */
  46. public class XlsSaver {

  48.     private static final Logger logger = LoggerFactory.getLogger(XlsSaver.class);

  50.     private Configuration configuration;

  52.     /**
  53.      * 独自のシステム情報を設定するコンストラクタ
  54.      * @param configuration システム情報
  55.      */
  56.     public XlsSaver(Configuration configuration) {
  57.         this.configuration = configuration;
  58.     }

  60.     /**
  61.      * デフォルトのコンストラクタ
  62.      */
  63.     public XlsSaver() {
  64.         this(new Configuration());
  65.     }

  67.     /**
  68.      * JavaのオブジェクトをExeclファイルに出力する。
  69.      * <p>出力するファイルは、引数で指定した雛形となるテンプレート用のExcelファイルをもとに出力する。</p>
  70.      *
  71.      * @param templateXlsIn 雛形となるExcelファイルの入力
  72.      * @param xlsOut 出力先のストリーム
  73.      * @param beanObj 書き込むBeanオブジェクト
  74.      * @throws IllegalArgumentException {@literal templateXlsIn == null or xlsOut == null or beanObj == null}
  75.      * @throws XlsMapperException マッピングに失敗した場合
  76.      * @throws IOException テンプレｰトのファイルの読み込みやファイルの出力に失敗した場合
  77.      */
  78.     public void save(final InputStream templateXlsIn, final OutputStream xlsOut, final Object beanObj)
  79.             throws XlsMapperException, IOException {

  81.         saveDetail(templateXlsIn, xlsOut, beanObj);
  82.     }

  84.     /**
  85.      * JavaのオブジェクトをExeclファイルに出力する。
  86.      * <p>出力するファイルは、引数で指定した雛形となるテンプレート用のExcelファイルをもとに出力する。</p>
  87.      *
  88.      * @param <P> マッピング対象のクラスタイプ
  89.      * @param templateXlsIn 雛形となるExcelファイルの入力
  90.      * @param xlsOut 出力先のストリーム
  91.      * @param beanObj 書き込むBeanオブジェクト
  92.      * @return マッピング結果。
  93.      *         {@link Configuration#isIgnoreSheetNotFound()}の値がtrueで、シートが見つからない場合、nullを返します。
  94.      * @throws IllegalArgumentException {@literal templateXlsIn == null or xlsOut == null or beanObj == null}
  95.      * @throws XlsMapperException マッピングに失敗した場合
  96.      * @throws IOException テンプレｰトのファイルの読み込みやファイルの出力に失敗した場合
  97.      */
  98.     public <P> SheetBindingErrors<P> saveDetail(final InputStream templateXlsIn, final OutputStream xlsOut, final P beanObj)
  99.             throws XlsMapperException, IOException {

  101.         ArgUtils.notNull(templateXlsIn, "templateXlsIn");
  102.         ArgUtils.notNull(xlsOut, "xlsOut");
  103.         ArgUtils.notNull(beanObj, "beanObj");


  106.         final AnnotationReader annoReader = new AnnotationReader(configuration.getAnnotationMapping().orElse(null));

  108.         try(Workbook book = WorkbookFactory.create(templateXlsIn)) {

  110.             final Class<?> clazz = beanObj.getClass();
  111.             final XlsSheet sheetAnno = clazz.getAnnotation(XlsSheet.class);
  112.             if(sheetAnno == null) {
  113.                 throw new AnnotationInvalidException(sheetAnno, MessageBuilder.create("anno.notFound")
  114.                         .varWithClass("property", clazz)
  115.                         .varWithAnno("anno", XlsSheet.class)
  116.                         .format());
  117.     
  118.             }
  119.     
  120.             final SheetBindingErrors<P> bindingResult;
  121.             try {
  122.                 final Sheet[] xlsSheet = configuration.getSheetFinder().findForSaving(book, sheetAnno, annoReader, beanObj);
  123.                 bindingResult = saveSheet(xlsSheet[0], beanObj, annoReader);
  124.     
  125.             } catch(SheetNotFoundException e) {
  126.                 if(configuration.isIgnoreSheetNotFound()){
  127.                     logger.warn(MessageBuilder.create("log.skipNotFoundSheet").format(), e);
  128.                     return null;
  129.     
  130.                 } else {
  131.                     throw e;
  132.                 }
  133.             }
  134.     
  135.             if(configuration.isFormulaRecalcurationOnSave()) {
  136.                 book.setForceFormulaRecalculation(true);
  137.             }
  138.     
  139.             book.write(xlsOut);
  140.     
  141.             return bindingResult;
  142.             
  143.         }

  145.     }

  147.     /**
  148.      * 複数のオブジェクトをそれぞれのシートへ保存する。
  149.      * @param templateXlsIn 雛形となるExcelファイルの入力
  150.      * @param xlsOut xlsOut 出力先のストリーム
  151.      * @param beanObjs 書き込むオブジェクトの配列。
  152.      * @throws IllegalArgumentException {@literal templateXlsIn == null or xlsOut == null or beanObjs == null}
  153.      * @throws XlsMapperException マッピングに失敗した場合
  154.      * @throws IOException テンプレｰトのファイルの読み込みやファイルの出力に失敗した場合
  155.      */
  156.     public void saveMultiple(final InputStream templateXlsIn, final OutputStream xlsOut, final Object[] beanObjs)
  157.             throws XlsMapperException, IOException {

  159.         saveMultipleDetail(templateXlsIn, xlsOut, beanObjs);
  160.     }

  162.     /**
  163.      * 複数のオブジェクトをそれぞれのシートへ保存する。
  164.      * @param templateXlsIn 雛形となるExcelファイルの入力
  165.      * @param xlsOut xlsOut 出力先のストリーム
  166.      * @param beanObjs 書き込むオブジェクトの配列。
  167.      * @return マッピング結果。
  168.      *         {@link Configuration#isIgnoreSheetNotFound()}の値がtrueで、シートが見つからない場合、結果に含まれません。
  169.      * @throws IllegalArgumentException {@literal templateXlsIn == null or xlsOut == null or beanObjs == null}
  170.      * @throws XlsMapperException マッピングに失敗した場合
  171.      * @throws IOException テンプレｰトのファイルの読み込みやファイルの出力に失敗した場合
  172.      */
  173.     public MultipleSheetBindingErrors<Object> saveMultipleDetail(final InputStream templateXlsIn, final OutputStream xlsOut, final Object[] beanObjs)
  174.             throws XlsMapperException, IOException {

  176.         ArgUtils.notNull(templateXlsIn, "templateXlsIn");
  177.         ArgUtils.notNull(xlsOut, "xlsOut");
  178.         ArgUtils.notEmpty(beanObjs, "beanObjs");

  180.         final AnnotationReader annoReader = new AnnotationReader(configuration.getAnnotationMapping().orElse(null));

  182.         final MultipleSheetBindingErrors<Object> multipleResult = new MultipleSheetBindingErrors<>();

  184.         try(Workbook book = WorkbookFactory.create(templateXlsIn)) {

  186.             for(int i=0; i < beanObjs.length; i++) {
  187.                 final Object beanObj = beanObjs[i];
  188.                 final Class<?> clazz = beanObj.getClass();
  189.     
  190.                 final XlsSheet sheetAnno = annoReader.getAnnotation(clazz, XlsSheet.class);
  191.                 if(sheetAnno == null) {
  192.                     throw new AnnotationInvalidException(sheetAnno, MessageBuilder.create("anno.notFound")
  193.                             .varWithClass("property", clazz)
  194.                             .varWithAnno("anno", XlsSheet.class)
  195.                             .format());
  196.                 }
  197.     
  198.                 try {
  199.                     final Sheet[] xlsSheet = configuration.getSheetFinder().findForSaving(book, sheetAnno, annoReader, beanObj);
  200.                     multipleResult.addBindingErrors(saveSheet(xlsSheet[0], beanObj, annoReader));
  201.     
  202.                 } catch(SheetNotFoundException e) {
  203.                     if(configuration.isIgnoreSheetNotFound()){
  204.                         logger.warn(MessageBuilder.create("log.skipNotFoundSheet").format(), e);
  205.                         continue;
  206.                     } else {
  207.                         throw e;
  208.                     }
  209.                 }
  210.             }
  211.     
  212.             if(configuration.isFormulaRecalcurationOnSave()) {
  213.                 book.setForceFormulaRecalculation(true);
  214.             }
  215.     
  216.             book.write(xlsOut);
  217.     
  218.             return multipleResult;
  219.             
  220.         }

  222.     }

  224.     /**
  225.      * 任意のクラスのオブジェクトを、Excelシートにマッピングする。
  226.      * @param sheet
  227.      * @param beanObj
  228.      * @param configuration
  229.      * @param work
  230.      * @throws XlsMapperException
  231.      */
  232.     private <P> SheetBindingErrors<P> saveSheet(final Sheet sheet, final P beanObj, final AnnotationReader annoReader)
  233.             throws XlsMapperException {

  235.         final Class<?> clazz = beanObj.getClass();

  237.         final SheetBindingErrors<P> errors =  configuration.getBindingErrorsFactory().create(beanObj);
  238.         errors.setSheetName(sheet.getSheetName());
  239.         errors.setSheetIndex(sheet.getWorkbook().getSheetIndex(sheet));

  241.         final SavingWorkObject work = new SavingWorkObject();
  242.         work.setAnnoReader(annoReader);
  243.         work.setErrors(errors);

  245.         // セルのキャッシュ情報の初期化
  246.         configuration.getCellFormatter().init(false);

  248.         final FieldAccessorFactory adpterFactory = new FieldAccessorFactory(annoReader);

  250.         // リスナークラスの@PreSave用メソッドの実行
  251.         final XlsListener listenerAnno = annoReader.getAnnotation(beanObj.getClass(), XlsListener.class);
  252.         if(listenerAnno != null) {
  253.             for(Class<?> listenerClass : listenerAnno.value()) {
  254.                 final Object listenerObj = configuration.createBean(listenerClass);

  256.                 for(Method method : listenerObj.getClass().getMethods()) {
  257.                     if(annoReader.hasAnnotation(method, XlsPreSave.class)) {
  258.                         Utils.invokeNeedProcessMethod(listenerObj, method, beanObj, sheet, configuration, work.getErrors(), ProcessCase.Save);
  259.                     }
  260.                 }
  261.             }

  263.         }

  265.         // @PreSave用のメソッドの取得と実行
  266.         for(Method method : clazz.getMethods()) {

  268.             final XlsPreSave preProcessAnno = annoReader.getAnnotation(method, XlsPreSave.class);
  269.             if(preProcessAnno != null) {
  270.                 Utils.invokeNeedProcessMethod(beanObj, method, beanObj, sheet, configuration, work.getErrors(), ProcessCase.Save);
  271.             }
  272.         }

  274.         final List<FieldAccessorProxy> accessorProxies = new ArrayList<>();

  276.         // public メソッドの処理
  277.         for(Method method : clazz.getMethods()) {
  278.             method.setAccessible(true);

  280.             for(Annotation anno : annoReader.getAnnotations(method)) {

  282.                 final XlsFieldProcessor annoFieldProcessor = anno.annotationType().getAnnotation(XlsFieldProcessor.class);
  283.                 if(ClassUtils.isAccessorMethod(method) && annoFieldProcessor != null) {

  285.                     // 登録済みのFieldProcessorの取得
  286.                     FieldProcessor<?> processor = configuration.getFieldProcessorRegistry().getProcessor(anno.annotationType());

  288.                     // アノテーションに指定されているFieldProcessorの場合
  289.                     if(processor == null && annoFieldProcessor.value().length > 0) {
  290.                         processor = configuration.createBean(annoFieldProcessor.value()[0]);

  292.                     }

  294.                     if(processor != null) {
  295.                         final FieldAccessor accessor = adpterFactory.create(method);

  297.                         final FieldAccessorProxy accessorProxy = new FieldAccessorProxy(anno, processor, accessor);
  298.                         if(!accessorProxies.contains(accessorProxy)) {
  299.                             accessorProxies.add(accessorProxy);
  300.                         }

  302.                     } else {
  303.                         // FieldProcessorが見つからない場合
  304.                         throw new AnnotationInvalidException(anno, MessageBuilder.create("anno.XlsFieldProcessor.notResolve")
  305.                                 .varWithAnno("anno", anno.annotationType())
  306.                                 .format());
  307.                     }

  309.                 }

  311.                 if(anno instanceof XlsPostSave) {
  312.                     work.addNeedPostProcess(new NeedProcess(beanObj, beanObj, method));
  313.                 }
  314.             }
  315.         }

  317.         // フィールドの処理
  318.         for(Field field : clazz.getDeclaredFields()) {

  320.             field.setAccessible(true);
  321.             final FieldAccessor accessor = adpterFactory.create(field);

  323.             for(Annotation anno : annoReader.getAnnotations(field)) {

  325.                 final XlsFieldProcessor annoFieldProcessor = anno.annotationType().getAnnotation(XlsFieldProcessor.class);
  326.                 if(annoFieldProcessor != null) {
  327.                     // 登録済みのFieldProcessorの取得
  328.                     FieldProcessor<?> processor = configuration.getFieldProcessorRegistry().getProcessor(anno.annotationType());

  330.                     // アノテーションに指定されているFieldProcessorの場合
  331.                     if(processor == null && annoFieldProcessor.value().length > 0) {
  332.                         processor = configuration.createBean(annoFieldProcessor.value()[0]);
  333.                     }

  335.                     if(processor != null) {
  336.                         final FieldAccessorProxy accessorProxy = new FieldAccessorProxy(anno, processor, accessor);
  337.                         if(!accessorProxies.contains(accessorProxy)) {
  338.                             accessorProxies.add(accessorProxy);
  339.                         }

  341.                     } else {
  342.                         // FieldProcessorが見つからない場合
  343.                         throw new AnnotationInvalidException(anno, MessageBuilder.create("anno.XlsFieldProcessor.notResolve")
  344.                                 .varWithAnno("anno", anno.annotationType())
  345.                                 .format());
  346.                     }

  348.                 }
  349.             }

  351.         }

  353.         // 順番を並び替えて保存処理を実行する
  354.         Collections.sort(accessorProxies, new FieldAccessorProxyComparator());
  355.         for(FieldAccessorProxy accessorProxy : accessorProxies) {
  356.             accessorProxy.saveProcess(sheet, beanObj, configuration, work);
  357.         }

  359.         // リスナークラスの@PostSaveの取得
  360.         if(listenerAnno != null) {
  361.             for(Class<?> listenerClass : listenerAnno.value()) {
  362.                 final Object listenerObj = configuration.createBean(listenerClass);
  363.                 for(Method method : listenerObj.getClass().getMethods()) {
  364.                     if(annoReader.hasAnnotation(method, XlsPostSave.class)) {
  365.                         work.addNeedPostProcess(new NeedProcess(beanObj, listenerObj, method));
  366.                     }
  367.                 }
  368.             }

  370.         }

  372.         //@PostSaveが付与されているメソッドの実行
  373.         for(NeedProcess need : work.getNeedPostProcesses()) {
  374.             Utils.invokeNeedProcessMethod(need.getProcess(), need.getMethod(), need.getTarget(), sheet, configuration, work.getErrors(), ProcessCase.Save);
  375.         }

  377.         return errors;

  379.     }

  381.     /**
  382.      * システム情報を取得します。
  383.      * @return 現在のシステム情報
  384.      */
  385.     public Configuration getConfiguration() {
  386.         return configuration;
  387.     }

  389.     /**
  390.      * システム情報を設定します。
  391.      * @param configuration システム情報
  392.      */
  393.     public void setConfiguration(Configuration configuration) {
  394.         this.configuration = configuration;
  395.     }

  397. }
Created with JaCoCo 0.8.5.201910111838