com.github.dreamroute.excel.helper.ExcelHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of excel-helper Show documentation
excel export base on apache poi 3.17
There is a newer version: 2.0.4-RELEASE
package com.github.dreamroute.excel.helper;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import com.github.dreamroute.excel.helper.util.BaseResponse;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;

import com.github.dreamroute.excel.helper.exception.ExcelHelperException;
import com.github.dreamroute.excel.helper.util.DataAssistant;
import com.github.dreamroute.excel.helper.util.ExcelType;
import com.github.dreamroute.excel.helper.util.ExcelUtil;

/**
 * the root operation class, you'll use it to create or export excel files/{@link Workbook}
 * 
 * @author [email protected]
 * @since JDK 1.7
 *
 */
public class ExcelHelper {

    private ExcelHelper() {}

    /**
     * 
     * export as {@link Workbook}.
     * 
     * if you do not want to export by ExcelHelper, you can only create a workbook, then operate the workbook by yourself.
     * 
     * @param type {@link ExcelType}
     * @param sheets your bussiness data.
     * @return return {@link Workbook}
     */
    public static Workbook exportWorkbook(ExcelType type, Collection... sheets) {
        return ExcelUtil.create(type, sheets);
    }

    /**
     * export as a file.
     * 
     * @param type {@link ExcelType}
     * @param sheets your bussiness data.
     * @param path file path
     */
    public static void exportFile(ExcelType type, Collection sheets, String path) {
        exportFile(type, sheets, new File(path));
    }

    /**
     * export as a file.
     * 
     * @param type {@link ExcelType}
     * @param sheets sheets your bussiness data.
     * @param newFile which file you'll write to.
     */
    public static void exportFile(ExcelType type, Collection sheets, File newFile) {
        try (OutputStream out = new FileOutputStream(newFile)) {
            exportWorkbook(type, sheets).write(out);
        } catch (Exception e) {
            throw new ExcelHelperException("write to file faild." + e, e);
        }
    }

    /**
     * export to byte array.
     * 
     * @param type {@link ExcelType}
     * @param sheets sheets sheets your bussiness data.
     * @return return a byte array with data.
     */
    public static byte[] exportByteArray(ExcelType type, Collection sheets) {
        ByteArrayOutputStream out = new ByteArrayOutputStream();
        try {
            exportWorkbook(type, sheets).write(out);
        } catch (IOException e) {
            throw new ExcelHelperException("write to file faild." + e, e);
        }
        return out.toByteArray();
    }

    /**
     * import from path.
     * 
     * @param type {@link ExcelType}
     * @param path the file path
     * @param cls target Class
     * @return return a {@link BaseResponse}
     */
    public static  BaseResponse importFromPath(ExcelType type, String path, Class cls) {
        File importFile = new File(path);
        if (!importFile.exists()) {
            throw new ExcelHelperException("the file " + path + " does not exist.");
        }
        return importFromFile(type, importFile, cls);
    }

    /**
     * import from file.
     * 
     * @param type {@link ExcelType}
     * @param importFile the file path
     * @param cls target Class
     * @return return a {@link BaseResponse}
     */
    public static  BaseResponse importFromFile(ExcelType type, File importFile, Class cls) {
        if (!importFile.exists()) {
            throw new ExcelHelperException("the file " + importFile.getName() + " does not exist.");
        }
        InputStream in = null;
        try {
            in = new FileInputStream(importFile);
        } catch (FileNotFoundException e) {
            throw new ExcelHelperException(e);
        }
        return importFromInputStream(type, in, cls);
    }

    /**
     * import from ByteArray
     * 
     * @param type {@link ExcelType}
     * @param byteArr byte array to import.
     * @param cls target Class
     * @return return a {@link BaseResponse}
     */
    public static  BaseResponse importFromByteArray(ExcelType type, byte[] byteArr, Class cls) {
        if (ArrayUtils.isEmpty(byteArr)) {
            return new BaseResponse<>(-1,"空数据",null);
        }
        InputStream in = new ByteArrayInputStream(byteArr);
        return importFromInputStream(type, in, cls);
    }

    /**
     * import from {@link InputStream}
     * 
     * @param type {@link ExcelType}
     * @param inputStream {@link InputStream}
     * @param cls target Class
     * @return return a {@link BaseResponse}
     */
    public static  BaseResponse importFromInputStream(ExcelType type, InputStream inputStream, Class cls) {
        BaseResponse data ;
        try (Workbook workbook = type == ExcelType.XLS ? new HSSFWorkbook(inputStream) : new XSSFWorkbook(inputStream)) {
            Sheet sheet = workbook.getSheetAt(0);
            data = DataAssistant.createDataFromSheet(sheet, cls);
        } catch (IOException e) {
            throw new ExcelHelperException(e);
        }
        return data;
    }

}