前言

ApachePOI 是一个开源的 Java 库，用于创建和操作 Microsoft Office 文件，如 Excel、Word 等。它提供了一组 API，允许开发人员创建、读取和修改 Office 文件，而无需依赖 Microsoft Office 应用程序。
一般情况下，POI都是用于操作Excel文件。

引入依赖

1
2
3
4
5
6
7
8
9
10
11
<!-- Apache POI-->
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi</artifactId>
    <version>5.2.3</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml</artifactId>
    <version>5.2.3</version>
</dependency>

测试API举例

关键类和方法：

  • XSSFWorkbook excel = new XSSFWorkbook();: Excel文件
  • XSSFSheet sheet1 = excel.createSheet("Sheet1");: Excel工作表
  • XSSFRow row = sheet1.createRow(行);: Excel行
  • XSSFCell cell = row.createCell(列).setCellValue("值");: Excel单元格

通过POI创建Excel文件并且写入文件内容

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
/**
 * 通过POI创建Excel文件并且写入文件内容
 */
@Test
public void write_test() throws IOException {
    // 在内存中创建一个Excel文件
    XSSFWorkbook excel = new XSSFWorkbook();
    // 创建一个工作簿(Sheet页)
    XSSFSheet sheet1 = excel.createSheet("info");
    // 在sheet页中创建行对象，rownum 编号从0开始,写入的位置是i+1行的位置
    XSSFRow row = sheet1.createRow(1);

    // 创建单元格并且写入文件内容
    row.createCell(1).setCellValue("姓名");
    row.createCell(2).setCellValue("年龄");

    // 创建一个新行,并写入内容
    row = sheet1.createRow(2);
    row.createCell(1).setCellValue("张三");
    row.createCell(2).setCellValue("23");
    // 创建一个新行,并写入内容
    row = sheet1.createRow(3);
    row.createCell(1).setCellValue("李四");
    row.createCell(2).setCellValue("22");

    // 写入文件
    FileOutputStream outputStream = new FileOutputStream("D:\\test.xlsx");
    excel.write(outputStream);
    // 关闭资源
    outputStream.close();
    excel.close();
}

测试结果表格如下
[image.png]

通过POI读取Excel文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
/**
 * 通过POI读取Excel文件
 * @throws IOException
 */
@Test
public void read_test() throws IOException {
    FileInputStream in = new FileInputStream(new File("D:\\test.xlsx"));
    // 读取磁盘上已经存在的Excel文件
    XSSFWorkbook excel = new XSSFWorkbook(in);
    // 读取文件中第一个Sheet页
    XSSFSheet sheet1 = excel.getSheetAt(0);
    // 获取该页最后一行的行号(从0开始)
    int lastRowNum = sheet1.getLastRowNum();

    // 读取并打印每一行的内容
    for (int i = 0; i <= lastRowNum; i++) {
        // 获取该页的第i行对象
        XSSFRow row = sheet1.getRow(i);
        if (row != null) {
            // 获取该行的最后一个单元格编号(从0开始)
            int lastCellNum = row.getLastCellNum();
            for (int j = 0; j < lastCellNum; j++) {
                System.out.print(row.getCell(j) + "\t");
            }
            System.out.println();
        }
    }

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

打印结果如下：

1
2
3
null	姓名	年龄	
null	张三	23	
null	李四	22

业务中的使用场景

  1. 业务场景
    在实际开发中，POI可以用于各种场景，如预先准备好的Excel文件模板。
    将我们业务中的数据按导出需求根据模板生成新的Excel文件
    用户访问接口即可下载导出Excel文件。
  1. 预先准备好的Excel文件模板
    • 一般是存放在项目的资源目录下，如：resources/templates/模板文件.xlsx
      1
      2
      // 获取模板文件：一般是放在项目下的：resources/templates/模板文件.xlsx
      InputStream in = this.getClass().getClassLoader().getResourceAsStream("template/测试模板文件.xlsx");
      文件模板内容如图
      [image.png]

  1. 代码实现

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    @Controller
    public class IndexController {

        @GetMapping("/getExcel")
        public void getExcel(HttpServletResponse response)  {
            //模拟从数据库获取的数据
            List<User> list = List.of(
                    new User("张三","1班",18,"男",99.0),
                    new User("李四","1班",18,"男",99.0),
                    new User("王五","1班",18,"男",99.0),
                    new User("赵六","1班",18,"男",99.0),
                    new User("孙七","1班",18,"男",99.0),
                    new User("周八","1班",18,"男",99.0)
            );

            // 获取模板文件路径：一般是放在项目下的：resources/templates/模板文件.xlsx
            InputStream in = this.getClass().getClassLoader().getResourceAsStream("template/测试模板文件.xlsx");
            try {
                // 读取模板文件,创建一个新的Excel文件
                XSSFWorkbook excel = new XSSFWorkbook(in);
                // 获取第一个sheet页
                XSSFSheet sheet1 = excel.getSheet("Sheet1");

                // 填充数据
                for (int i = 0; i < list.size(); i++){

                    //(第4行开始是填充的位置)
                    // 获取第i+3+1行，并设置值
                    XSSFRow row = sheet1.getRow(i + 3);
                    if(row == null) {
                        row = sheet1.createRow(i + 3);
                    }
                    // 获取第0列，并设置值
                    // 获取或创建单元格并设置值
                    // 设置单元格的值
                    setCellValue(row, 0, list.get(i).getName());
                    setCellValue(row, 1, list.get(i).getClassName());
                    setCellValue(row, 2, String.valueOf(list.get(i).getAge()));
                    setCellValue(row, 3, list.get(i).getSex());
                    setCellValue(row, 4, String.valueOf(list.get(i).getScore()));

                }

                // 通过输出流将Excel文件下载到客户端浏览器
                ServletOutputStream out = response.getOutputStream();
                excel.write(out);

                // 关闭资源
                out.close();
                excel.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

        // 封装获取或创建单元格并设置值的方法
        private void setCellValue(XSSFRow row, int columnIndex, String value) {
            XSSFCell cell = row.getCell(columnIndex);
            if (cell == null) {
                cell = row.createCell(columnIndex);
            }
            cell.setCellValue(value);
        }
    }

  2. 测试结果
    访问接口：http://localhost:8080/getExcel
    测试结果如下：
    [image.png]