【Apache POI导出Excel表格】

一. Apache POI

1. 介绍

Apache POI 是一个处理Miscrosoft Office各种文件格式的开源项目。简单来说就是，我们可以使用 POI 在 Java 程序中对Miscrosoft Office各种文件进行读写操作。
一般情况下，POI 都是用于操作 Excel 文件。

1.1 Apache POI 的应用场景：

• 银行网银系统导出交易明细

• 各种业务系统导出Excel报表

• 批量导入业务数据

2. 入门案例

Apache POI既可以将数据写入Excel文件，也可以读取Excel文件中的数据，接下来分别进行实现。

1）Apache POI的maven坐标：(项目中导入)

<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi</artifactId>
    <version>3.16</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml</artifactId>
    <version>3.16</version>
</dependency>

2）基于POI向Excel文件写入数据

 /**
     * 基于POI向Excel文件写入数据
     *
     * @throws Exception
     */
    public static void write() throws Exception {
        //在内存中创建一个Excel文件对象
        XSSFWorkbook excel = new XSSFWorkbook();
        //创建Sheet页 -- 第一个sheet页叫做hello
        XSSFSheet sheet = excel.createSheet("hello");

        //在Sheet页中创建行，0表示第1行
        XSSFRow row1 = sheet.createRow(0);
        //创建单元格并在单元格中设置值，单元格编号也是从0开始，1表示第2个单元格
        row1.createCell(1).setCellValue("姓名");
        row1.createCell(2).setCellValue("城市");

        XSSFRow row2 = sheet.createRow(1);
        row2.createCell(1).setCellValue("张三");
        row2.createCell(2).setCellValue("北京");

        XSSFRow row3 = sheet.createRow(2);
        row3.createCell(1).setCellValue("李四");
        row3.createCell(2).setCellValue("上海");

        FileOutputStream out = new FileOutputStream(new File("D:\\hello.xlsx"));
        //通过输出流将内存中的Excel文件写入到磁盘上
        excel.write(out);

        //关闭资源
        out.flush();
        out.close();
        excel.close();
    }

   public static void main(String[] args) throws Exception {
        write();
    }

结果：在D盘符下创建了一个名为hello.xlsx的文件。里面内容为：

3）基于POI读取Excel文件

 /**
     * 基于POI读取Excel文件
     *
     * @throws Exception
     */
    public static void read() throws Exception {
        FileInputStream in = new FileInputStream(new File("D:\\hello.xlsx"));
        //通过输入流读取指定的Excel文件
        XSSFWorkbook excel = new XSSFWorkbook(in);
        //获取Excel文件的第1个Sheet页
        XSSFSheet sheet = excel.getSheetAt(0);

        //获取Sheet页中的第一行的行号  -- 注：是从获取到有数据的开始算起
        int firstRowNum = sheet.getFirstRowNum();
        //获取Sheet页中的最后一行的行号     -- 注：是到该行的最后一个数据结尾
        int lastRowNum = sheet.getLastRowNum();


        for (; firstRowNum <= lastRowNum; firstRowNum++) {
            //获取Sheet页中的行
            XSSFRow titleRow = sheet.getRow(firstRowNum);

            //获取该行的第一个列号  -- 注：从该行的有数据的开始算起
            short firstCellNum = titleRow.getFirstCellNum();
            //获取该行的最后一个列号  -- 注：是到该行的最后一个数据结尾
            short lastCellNum = titleRow.getLastCellNum();

            for (; firstCellNum <= lastCellNum; firstCellNum++) {
                //获取该行第一个有数据的单元
                XSSFCell cell = titleRow.getCell(firstCellNum);
                //如果单元格为空，则跳过本次循环，进入下一次循环
                if (cell == null) {
                    continue;
                }
                //获取单元格中的文本内容
                String cellValue = cell.getStringCellValue();

                System.out.print(cellValue + " ");
            }
            System.out.println();
        }

        //关闭资源
        in.close();
        excel.close();
    }
   public static void main(String[] args) throws Exception {
        read();
    }

结果：控制台输出内容为：

4）完整代码演示

package com.sky;

import org.apache.poi.xssf.usermodel.XSSFCell;
import org.apache.poi.xssf.usermodel.XSSFRow;
import org.apache.poi.xssf.usermodel.XSSFSheet;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;


import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;

public class POITest {
    /**
     * 基于POI向Excel文件写入数据
     *
     * @throws Exception
     */
    public static void write() throws Exception {
        //在内存中创建一个Excel文件对象
        XSSFWorkbook excel = new XSSFWorkbook();
        //创建Sheet页
        XSSFSheet sheet = excel.createSheet("itcast");

        //在Sheet页中创建行，0表示第1行
        XSSFRow row1 = sheet.createRow(0);
        //创建单元格并在单元格中设置值，单元格编号也是从0开始，1表示第2个单元格
        row1.createCell(1).setCellValue("姓名");
        row1.createCell(2).setCellValue("城市");

        XSSFRow row2 = sheet.createRow(1);
        row2.createCell(1).setCellValue("张三");
        row2.createCell(2).setCellValue("北京");

        XSSFRow row3 = sheet.createRow(2);
        row3.createCell(1).setCellValue("李四");
        row3.createCell(2).setCellValue("上海");

        FileOutputStream out = new FileOutputStream(new File("D:\\itcast.xlsx"));
        //通过输出流将内存中的Excel文件写入到磁盘上
        excel.write(out);

        //关闭资源
        out.flush();
        out.close();
        excel.close();
    }

    /**
     * 基于POI读取Excel文件
     *
     * @throws Exception
     */
    public static void read() throws Exception {
        FileInputStream in = new FileInputStream(new File("D:\\itcast.xlsx"));
        //通过输入流读取指定的Excel文件
        XSSFWorkbook excel = new XSSFWorkbook(in);
        //获取Excel文件的第1个Sheet页
        XSSFSheet sheet = excel.getSheetAt(0);

        //获取Sheet页中的第一行的行号  -- 注：是从获取到有数据的开始算起
        int firstRowNum = sheet.getFirstRowNum();
        //获取Sheet页中的最后一行的行号     -- 注：是到该行的最后一个数据结尾
        int lastRowNum = sheet.getLastRowNum();


        for (; firstRowNum <= lastRowNum; firstRowNum++) {
            //获取Sheet页中的行
            XSSFRow titleRow = sheet.getRow(firstRowNum);

            //获取该行的第一个列号  -- 注：从该行的有数据的开始算起
            short firstCellNum = titleRow.getFirstCellNum();
            //获取该行的最后一个列号  -- 注：是到该行的最后一个数据结尾
            short lastCellNum = titleRow.getLastCellNum();

            for (; firstCellNum <= lastCellNum; firstCellNum++) {
                //获取该行第一个有数据的单元
                XSSFCell cell = titleRow.getCell(firstCellNum);
                //如果单元格为空，则跳过本次循环，进入下一次循环
                if (cell == null) {
                    continue;
                }
                //获取单元格中的文本内容
                String cellValue = cell.getStringCellValue();

                System.out.print(cellValue + " ");
            }
            System.out.println();
        }

        //关闭资源
        in.close();
        excel.close();
    }

    public static void main(String[] args) throws Exception {
        write();
        read();
    }
}

3. 苍穹外卖-----导出运营数据Excel报表完整业务逻辑

3.1 需求分析和设计

3.1.1 产品原型

在数据统计页面，有一个数据导出的按钮，点击该按钮时，其实就会下载一个文件。这个文件实际上是一个Excel形式的文件，文件中主要包含最近30日运营相关的数据。表格的形式已经固定，主要由概览数据和明细数据两部分组成。真正导出这个报表之后，相对应的数字就会填充在表格中，就可以进行存档。

原型图：

导出的Excel报表格式：

业务规则：

• 导出Excel形式的报表文件
• 导出最近30天的运营数据

3.1.2 接口设计

通过上述原型图设计对应的接口。

注意：

• 当前接口没有传递参数，因为导出的是最近30天的运营数据，后端计算即可，所以不需要任何参数

• 当前接口没有返回数据，因为报表导出功能本质上是文件下载，服务端会通过输出流将Excel文件下载到客户端浏览器

3.2 代码开发

3.2.1 实现步骤

1). 设计Excel模板文件

2). 查询近30天的运营数据

3). 将查询到的运营数据写入模板文件

4). 通过输出流将Excel文件下载到客户端浏览器

3.2.2 Controller层

根据接口定义，在ReportController中创建export方法：

	/**
     * 导出运营数据报表
     * @param response
     */
    @GetMapping("/export")
    @ApiOperation("导出运营数据报表")
    public void export(HttpServletResponse response){
        reportService.exportBusinessData(response);
    }

3.2.3 Service层接口

在ReportService接口中声明导出运营数据报表的方法：

	/**
     * 导出近30天的运营数据报表
     * @param response
     **/
    void exportBusinessData(HttpServletResponse response);

3.2.4 Service层实现类

在ReportServiceImpl实现类中实现导出运营数据报表的方法:

提前将资料中的运营数据报表模板.xlsx拷贝到项目的resources/template目录中

    /**导出近30天的运营数据报表
     * @param response
     **/
    public void exportBusinessData(HttpServletResponse response) {
        LocalDate begin = LocalDate.now().minusDays(30);
        LocalDate end = LocalDate.now().minusDays(1);
        //查询概览运营数据，提供给Excel模板文件
        BusinessDataVO businessData = workspaceService.getBusinessData(LocalDateTime.of(begin,LocalTime.MIN), LocalDateTime.of(end, LocalTime.MAX));
        InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream("template/运营数据报表模板.xlsx");
        try {
            //基于提供好的模板文件创建一个新的Excel表格对象
            XSSFWorkbook excel = new XSSFWorkbook(inputStream);
            //获得Excel文件中的一个Sheet页
            XSSFSheet sheet = excel.getSheet("Sheet1");

            sheet.getRow(1).getCell(1).setCellValue(begin + "至" + end);
            //获得第4行
            XSSFRow row = sheet.getRow(3);
            //获取单元格
            row.getCell(2).setCellValue(businessData.getTurnover());
            row.getCell(4).setCellValue(businessData.getOrderCompletionRate());
            row.getCell(6).setCellValue(businessData.getNewUsers());
            row = sheet.getRow(4);
            row.getCell(2).setCellValue(businessData.getValidOrderCount());
            row.getCell(4).setCellValue(businessData.getUnitPrice());
            for (int i = 0; i < 30; i++) {
                LocalDate date = begin.plusDays(i);
               //准备明细数据
                businessData = workspaceService.getBusinessData(LocalDateTime.of(date,LocalTime.MIN), LocalDateTime.of(date, LocalTime.MAX));
                row = sheet.getRow(7 + i);
                row.getCell(1).setCellValue(date.toString());
                row.getCell(2).setCellValue(businessData.getTurnover());
                row.getCell(3).setCellValue(businessData.getValidOrderCount());
                row.getCell(4).setCellValue(businessData.getOrderCompletionRate());
                row.getCell(5).setCellValue(businessData.getUnitPrice());
                row.getCell(6).setCellValue(businessData.getNewUsers());
            }
            //通过输出流将文件下载到客户端浏览器中
            ServletOutputStream out = response.getOutputStream();
            excel.write(out);
            //关闭资源
            out.flush();
            out.close();
            excel.close();

        }catch (IOException e){
            e.printStackTrace();
        }
    }

3.3 功能测试

直接使用前后端联调测试。

进入数据统计

点击数据导出：Excel报表下载成功