POI Excel導入 HttpRequest 讀取Exce文件流方式導入內容 導出Excel實現

目錄

1、使用場景

2、代碼實現

  2.1、Pom.xml導入 jar包

  2.2、HTTPRequest 讀取Excel InputStream方式導入讀取Excel文件內容

2.2、導出數據內容到Excel之中

2.3、如果導入文件需要讀取多個表並且有關聯關係實現

3、成果展現

4、總結

5、參考文章


1、使用場景

        目前大多數人做項目,都會使用Excel文件做導入導出功能。於是本人也觀察了好些項目,無外乎以下兩種實現方式:

  • 把導入的Excel文件上傳至Java應用服務器方式
  • 直接從Http的Request請求之中獲得上傳的Excel文件流的方式直接讀取內容
  • 如果增加數據要求極高情況建議記錄導入數據日誌記錄

  其中使用把Exce文件上傳到服務器方式,有如下優缺點:

 優點:

         因爲文件上傳到服務器,可以查看上傳導入文件內容;並且可以查看具體上傳導入文件的時間(服務器查看)

         導入文件的操作是在文件上傳至服務器後再執行的,意味着保障的Excel文件完整性,避免的導入過程突然斷網風險。

 缺點:

        也是因爲把文件上傳至應用服務器啦,並且導入的操作僅僅執行完畢一次之後;後面的文件將沒有多大意義啦,造成此類文件的佔用空間。也許有人會說在服務器端寫過shell腳本定時清除即可。

直接從Http的Request請求之中獲得上傳的Excel文件流的方式 優缺點比較

         優點:

                 能夠直接使得導入過程從以前兩個步驟,先上傳然後在導入過程;可以直接從HttpRequest請求之中獲得Excel的InputStream文件流直接讀取Excel文件之中的內容進行導入。

                 不用存儲多餘的Excel文件到Java應用服務器上,節省磁盤空間。

         缺點:

                正因爲不用先上傳文件到應用服務器上,可能出現文件如果Excel文件內容較大;讀取文件流過程比較慢。同時有風險如果上傳過程之中突然斷網;可能讀取文件流不完整的情況。

如果增加數據要求極高情況建議記錄導入數據日誌記錄

              如果系統要求針對入庫數據比較嚴格的情況下;建議吧數據導入的相關操作記錄 是誰、什麼時間、導入了哪些數據進入日誌操作記錄以備覈查。

          本文將主要使用直接通過讀取HttpRequest之中Excel文件流的方式實現Excel的文件到導入的實現。

2、代碼實現

  2.1、Pom.xml導入 jar包

<!-- Excel 使用POI操作相關jar start -->
<dependency>
	<groupId>org.apache.poi</groupId>
	<artifactId>poi</artifactId>
	<version>4.1.1</version>
</dependency>
<dependency>
	<groupId>org.apache.poi</groupId>
	<artifactId>poi-ooxml</artifactId>
	<version>4.1.1</version>
</dependency>
<dependency>
	<groupId>org.apache.poi</groupId>
	<artifactId>poi-ooxml-schemas</artifactId>
	<version>4.1.1</version>
</dependency>
<dependency>
	<groupId>org.apache.xmlbeans</groupId>
	<artifactId>xmlbeans</artifactId>
	<version>3.1.0</version>
</dependency>
<dependency>
	<groupId>org.apache.commons</groupId>
	<artifactId>commons-collections4</artifactId>
	<version>4.4</version>
</dependency>
<dependency>
	<groupId>dom4j</groupId>
	<artifactId>dom4j</artifactId>
	<version>1.6.1</version>
</dependency>
<!-- Excel 使用POI操作相關jar end -->
<dependency>
	<groupId>com.alibaba</groupId>
	<artifactId>fastjson</artifactId>
	<version>1.2.62</version>
</dependency>
<dependency>
	<groupId>commons-fileupload</groupId>
	<artifactId>commons-fileupload</artifactId>
	<version>1.4</version>
</dependency>
<dependency>
	<groupId>org.slf4j</groupId>
	<artifactId>slf4j-api</artifactId>
	<version>1.7.28</version>
</dependency>

  2.2、HTTPRequest 讀取Excel InputStream方式導入讀取Excel文件內容

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.multipart.MultipartFile;
import org.springframework.web.multipart.MultipartHttpServletRequest;
import org.springframework.web.multipart.commons.CommonsMultipartResolver;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.Part;
import java.io.IOException;
import java.io.InputStream;
import java.util.Collection;
import java.util.Iterator;

/**
 * @Classname ExcelDirectRequestInputStreamUtil
 * @Description 直接從Request之中獲得導入的Excel文件流內容
 * @Date 2019/11/9 11:46
 * @Created by jianxiapc
 */
public class ExcelImportByRequestInputStreamUtil {
    private static Logger logger = LoggerFactory.getLogger(ExcelImportByRequestInputStreamUtil.class);

    /**
     * 獲得上傳文件未單個Excel文件時候 通過MultipartFile參數獲得文件流信息
     * @param request
     * @param response
     * @param file
     * @return
     * @throws IOException
     */
    public static InputStream getInputStreamByMultipartFileParameter(HttpServletRequest request, HttpServletResponse response,MultipartFile file) throws IOException {
        InputStream  excelInputStream = file.getInputStream();
        int length=excelInputStream.available();
        logger.info("length: "+length);
        logger.info("excelInputStream: "+excelInputStream.toString());
        return excelInputStream;
    }

    /**
     * 通過request獲得InputStream獲得文件內容
     * @param request
     * @param response
     * @param frontEndFileInputName
     * @return
     * @throws IOException
     */
    public static InputStream getInputStreamByRequestAndFileInputName(HttpServletRequest request, HttpServletResponse response,String frontEndFileInputName) throws IOException {

        MultipartHttpServletRequest params=((MultipartHttpServletRequest) request);
        MultipartFile fileContent  = ((MultipartHttpServletRequest) request).getFiles(frontEndFileInputName).get(0);
        // fis 既是上傳的文件流
        InputStream  excelInputStream = fileContent.getInputStream();

        int length=excelInputStream.available();
        logger.info("length: "+length);
        logger.info("excelInputStream: "+excelInputStream.toString());

        return excelInputStream;
    }


    /**
     * 通過request之中獲得file的Parts
     *
     * @param request
     * @param response
     * @throws IOException
     * @throws ServletException
     */
    public static InputStream getInputStreamByRequestParts(HttpServletRequest request, HttpServletResponse response,String frontEndFileInputName) throws IOException, ServletException {
        logger.info("request.getContentType(): " + request.getContentType());
        if (!request.getContentType().split(";")[0].equals("multipart/form-data"))
            return null;
        Collection<Part> parts = request.getParts();
        InputStream excelInputStream =null;
        //通過獲得part信息組裝爲InputStream流用讀取文件內容
        int i=0;
        for (Iterator<Part> iterator = parts.iterator(); iterator.hasNext(); ) {
            Part part = iterator.next();
            logger.info("-----類型名稱------->" + part.getName());
            logger.info("-----類型------->" + part.getContentType());
            logger.info("-----提交的類型名稱------->" + part.getSubmittedFileName());
            logger.info("----流-------->" + part.getInputStream());

            logger.info("循環次數=== "+i);
            excelInputStream=part.getInputStream();
            i++;
        }
        return excelInputStream;
    }

    /**
     * 使用 commons-fileupload 上傳Excel文件返回文件流信息
     * @param request
     * @param response
     * @return
     * @throws IOException
     */
    public static InputStream getInputStreamByMultipartHttpServletRequest(HttpServletRequest request, HttpServletResponse response) throws IOException {
        InputStream excelInputStream =null;
        //將當前上下文初始化給  CommonsMutipartResolver (多部分解析器)
        CommonsMultipartResolver multipartResolver = new CommonsMultipartResolver(
                request.getSession().getServletContext());
        // 判斷是否是多數據段提交格式
        if (multipartResolver.isMultipart(request)) {
            MultipartHttpServletRequest multiRequest = (MultipartHttpServletRequest) request;
            Iterator<String> iter = multiRequest.getFileNames();
            logger.info("iter.hasNext(): " + iter.hasNext());
            Integer fileCount = 0;
            while (iter.hasNext()) {
                MultipartFile multipartFile = multiRequest.getFile(iter.next());
                String fileName = multipartFile.getOriginalFilename();
                logger.info("upload filename: " + fileName);
                if (fileName == null || fileName.trim().equals("")) {
                    continue;
                }
                //20170207 針對IE環境下filename是整個文件路徑的情況而做以下處理
                Integer index = fileName.lastIndexOf("\\");
                String newStr = "";
                if (index > -1) {
                    newStr = fileName.substring(index + 1);
                } else {
                    newStr = fileName;
                }
                if (!newStr.equals("")) {
                    fileName = newStr;
                }
                logger.info("new filename: " + fileName);

                if (multipartFile != null) {
                    excelInputStream= multipartFile.getInputStream();
                    long fileSize= multipartFile.getSize();
                    logger.info("fileSize: " + fileSize);
                }
        }

    }
        return excelInputStream;
    }
}

2.2、導出數據內容到Excel之中

import org.apache.poi.ss.usermodel.Font;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.xssf.usermodel.XSSFCellStyle;
import org.apache.poi.xssf.usermodel.XSSFColor;
import org.apache.poi.xssf.usermodel.XSSFSheet;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.apache.poi.xssf.usermodel.extensions.XSSFCellBorder.BorderSide;
import org.spring.springboot.excel.poi.export.model.ExcelModelData;

import javax.servlet.http.HttpServletResponse;
import java.awt.Color;
import java.io.OutputStream;
import java.net.URLEncoder;
import java.util.List;


/**
 * @Classname ExportExcelUtils
 * @Description Excel導出工具集合
 * @Date 2019/11/7 14:41
 * @Created by jianxiapc
 */
public class ExcelWriterExportUtils {
    public static void exportExcel(HttpServletResponse response, String fileName, ExcelModelData data) throws Exception {
        // 告訴瀏覽器用什麼軟件可以打開此文件
        response.setHeader("content-Type", "application/vnd.ms-excel");
        // 下載文件的默認名稱
        response.setHeader("Content-Disposition", "attachment;filename="+URLEncoder.encode(fileName, "utf-8"));
        exportExcel(data, response.getOutputStream());
    }

    public static void exportExcel(ExcelModelData data, OutputStream out) throws Exception {

        XSSFWorkbook wb = new XSSFWorkbook();
        try {
            String sheetName = data.getName();
            if (null == sheetName) {
                sheetName = "Sheet1";
            }
            XSSFSheet sheet = wb.createSheet(sheetName);
            writeExcel(wb, sheet, data);

            wb.write(out);
        } finally {
            wb.close();
        }
    }

    private static void writeExcel(XSSFWorkbook wb, Sheet sheet, ExcelModelData data) {

        int rowIndex = 0;

        rowIndex = writeTitlesToExcel(wb, sheet, data.getHeadTitles());
        writeRowsToExcel(wb, sheet, data.getRows(), rowIndex);
        autoSizeColumns(sheet, data.getHeadTitles().size() + 1);

    }

    private static int writeTitlesToExcel(XSSFWorkbook wb, Sheet sheet, List<String> titles) {
        int rowIndex = 0;
        int colIndex = 0;

        Font titleFont = wb.createFont();
        titleFont.setFontName("simsun");
        titleFont.setBold(true);
        // titleFont.setFontHeightInPoints((short) 14);
        titleFont.setColor(IndexedColors.BLACK.index);

        XSSFCellStyle titleStyle = wb.createCellStyle();
        titleStyle.setAlignment(HorizontalAlignment.CENTER);
        titleStyle.setVerticalAlignment(VerticalAlignment.CENTER);
        titleStyle.setFillForegroundColor(new XSSFColor(new Color(182, 184, 192)));
        titleStyle.setFillPattern(FillPatternType.SOLID_FOREGROUND);
        titleStyle.setFont(titleFont);
        setBorder(titleStyle, BorderStyle.THIN, new XSSFColor(new Color(0, 0, 0)));

        Row titleRow = sheet.createRow(rowIndex);
        // titleRow.setHeightInPoints(25);
        colIndex = 0;

        for (String field : titles) {
            Cell cell = titleRow.createCell(colIndex);
            cell.setCellValue(field);
            cell.setCellStyle(titleStyle);
            colIndex++;
        }

        rowIndex++;
        return rowIndex;
    }

    private static int writeRowsToExcel(XSSFWorkbook wb, Sheet sheet, List<List<Object>> rows, int rowIndex) {
        int colIndex = 0;

        Font dataFont = wb.createFont();
        dataFont.setFontName("simsun");
        // dataFont.setFontHeightInPoints((short) 14);
        dataFont.setColor(IndexedColors.BLACK.index);

        XSSFCellStyle dataStyle = wb.createCellStyle();
        dataStyle.setAlignment(HorizontalAlignment.CENTER);
        dataStyle.setVerticalAlignment(VerticalAlignment.CENTER);
        dataStyle.setFont(dataFont);
        setBorder(dataStyle, BorderStyle.THIN, new XSSFColor(new Color(0, 0, 0)));

        for (List<Object> rowData : rows) {
            Row dataRow = sheet.createRow(rowIndex);
            // dataRow.setHeightInPoints(25);
            colIndex = 0;

            for (Object cellData : rowData) {
                Cell cell = dataRow.createCell(colIndex);
                if (cellData != null) {
                    cell.setCellValue(cellData.toString());
                } else {
                    cell.setCellValue("");
                }

                cell.setCellStyle(dataStyle);
                colIndex++;
            }
            rowIndex++;
        }
        return rowIndex;
    }

    private static void autoSizeColumns(Sheet sheet, int columnNumber) {

        for (int i = 0; i < columnNumber; i++) {
            int orgWidth = sheet.getColumnWidth(i);
            sheet.autoSizeColumn(i, true);
            int newWidth = (int) (sheet.getColumnWidth(i) + 100);
            if (newWidth > orgWidth) {
                sheet.setColumnWidth(i, newWidth);
            } else {
                sheet.setColumnWidth(i, orgWidth);
            }
        }
    }

    private static void setBorder(XSSFCellStyle style, BorderStyle border, XSSFColor color) {
        style.setBorderTop(border);
        style.setBorderLeft(border);
        style.setBorderRight(border);
        style.setBorderBottom(border);
        style.setBorderColor(BorderSide.TOP, color);
        style.setBorderColor(BorderSide.LEFT, color);
        style.setBorderColor(BorderSide.RIGHT, color);
        style.setBorderColor(BorderSide.BOTTOM, color);
    }
}

2.3、如果導入文件需要讀取多個表並且有關聯關係實現

          如果我們實際開發之中可能會針對讀取的Excel文件內容;同時涉及到過個Excel的Sheet表格;並且每個表格之間有導入的前後關係。於是會使用讀取Excel文件之中Sheet表格循環讀取,具體代碼如下所示:

    /**
     * 通過讀取Excel的文件路徑 讀取 .xls or .xlsx 都行
     * @param excelFileDirPath
     * @param titleRow
     * @return
     */
    public static List<Map<String,Object>> readExcelFileContentToList(String excelFileDirPath,String titleRow[]) throws IOException, InvalidFormatException {
        //通過工廠模式創建Excel  Workbook from an Excel file (.xls or .xlsx)
        Workbook workbook = WorkbookFactory.create(new File(excelFileDirPath));
        logger.info(" Excel Workbook 包含有 " + workbook.getNumberOfSheets() + " 張 Sheets : ");

        List<Map<String,Object>>  readExcelFileRowsContentList=new ArrayList<Map<String,Object>>();
         /*
           =============================================================
           迭代在workbook之中的所有的sheets (多種方式)
           =============================================================
        */
        //1、 獲得一個sheetIterator 和 iterate 覆蓋它
        Iterator<Sheet> sheetIterator = workbook.sheetIterator();
        logger.info("使用 Iterator 返回 Sheets ");
        while (sheetIterator.hasNext()) {
            Sheet sheet = sheetIterator.next();
            logger.info("=> " + sheet.getSheetName());
        }
        /**
        //2、 使用 for-each loop 返回 workbook之中的 sheet
        logger.info("使用 for-each loop 返回 Sheets ");
        for(Sheet sheet: workbook) {
            logger.info("=> " + sheet.getSheetName());
        }

        // 3、使用 Java 8 forEach wih lambda
        logger.info("使用 Java 8 forEach with lambda 返回 Sheets ");
        workbook.forEach(sheet -> {
            logger.info("=> " + sheet.getSheetName());
        });
         */
         /*
           ==================================================================
            遍歷工作表(Sheet)中的所有行(rows)和列(columns) (Multiple ways)
           ==================================================================
        */
        // 獲得 索引爲0 的 Sheet
        Sheet sheet = workbook.getSheetAt(0);

        // 創建一個數據格式器 目的是爲 格式化 獲得每cell的值爲字符串
        DataFormatter dataFormatter = new DataFormatter();

        // 1、 你能夠 obtain a rowIterator and columnIterator and iterate over them
        logger.info(" 使用 Iterator Iterating over Rows and Columns ");
        Iterator<Row> rowIterator = sheet.rowIterator();
        boolean isFirstRow=true;//是否是第一行
        while (rowIterator.hasNext()) {
            Row row = rowIterator.next();
            Map<String,Object> rowMap= new HashMap<String,Object>();
            // Now let's iterate over the columns of the current row
            Iterator<Cell> cellIterator = row.cellIterator();
            int titleIndex=0;
            if(!isFirstRow){
                while (cellIterator.hasNext()) {
                    Cell cell = cellIterator.next();
                    String cellValue = dataFormatter.formatCellValue(cell);
                    rowMap.put(titleRow[titleIndex],cellValue);
                    logger.info(titleRow[titleIndex]+" ===>"+cellValue);
                    titleIndex++;
                }
                logger.info("row content: "+rowMap.toString());
                readExcelFileRowsContentList.add(rowMap);
            }
            isFirstRow=false;
        }

3、成果展現

3.1、使用HTTPRequest 的讀取InputStream文件樓方式獲得文件內容

3.2、導出Excel功能

4、總結

        本文探討了脫離傳統模式,直接從HTTPRequest請求之中 讀取到Excel的 InputStream文件流方式直接實現導入的功能。

同時本文將分析源碼如何讀取Excel文件之中多張表之中內容實現方式。

      源碼地址:https://github.com/jianxia612/springboot-excel-import-export-fileupload.git

5、參考文章

    HttpRequest獲取文件流,HttpResponse輸出文件流

文件上傳 servlet 從HttpServletRequest.getInputStream()中獲得消息內容

       此文章的代碼相當豐富

         https://github.com/callicoder/java-read-write-excel-file-using-apache-poi

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章