SpringBoot使用Apache POI库读取Excel文件的操作详解

 更新时间:2025年01月06日 08:26:31   作者:Andya  
在日常开发中,我们经常需要处理Excel文件中的数据,无论是从数据库导入数据、处理数据报表,还是批量生成数据,都可能会遇到需要读取和操作Excel文件的场景,本文将详细介绍如何使用Java中的Apache POI库来读取Excel文件,需要的朋友可以参考下

项目背景

假设我们需要开发一个功能,读取一个Excel文件中的数据并进行处理。通常,这样的需求会出现在以下场景中:

  • 数据迁移:将Excel表格的数据导入数据库。
  • 数据分析:对Excel中的数据进行汇总、统计分析。
  • 批量处理:从Excel文件中读取配置信息或参数进行批量处理。 在本篇文章中,我们将展示如何使用Java读取Excel文件,获取其中的数据,并展示如何将这些数据转化为业务对象以便后续处理。

依赖导入

首先,你需要在项目中添加Apache POI的依赖。这里使用的是Apache POI 3.x版本,你可以在pom.xml中加入如下依赖:

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

这个依赖包包括了读取xlsx格式的支持,如果需要支持更老的xls格式,可以再加上poi模块。

读取Excel模板的实现

接下来,我们来看一个简单的示例代码,展示如何读取Excel文件的内容,并对数据进行处理。我们将以一个示例Excel表格为例,假设表格的内容如下:

姓名年龄性别
张三25
李四30
王五28

代码实现

import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.extern.slf4j.Slf4j;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.springframework.stereotype.Service;

import java.io.FileInputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

/**
 * 读取Excel文件并进行数据处理的服务类
 */
@Service
@Slf4j
public class ReadExcelServiceImpl {

    public Boolean readExcel() {
        try {
            String pathStr = "/path/to/your/excel/file.xlsx";
            // excel文件路径
            FileInputStream fis = new FileInputStream(pathStr);
            // 创建一个工作簿对象
            Workbook workbook = new XSSFWorkbook(fis);
            // 获取第一个工作表
            Sheet sheet = workbook.getSheetAt(0);
            // 获取总行数
            int lastRowNum = sheet.getLastRowNum();
            
            // 存放Excel读取的数据列表
            List<ExcelDemoInfoDTO> demoInfoList = new ArrayList<>();

            // 读取数据。循环遍历行,从第二行开始,假设第一行是标题行
            for (int i = 1; i <= lastRowNum; i++) {
                log.info("Reading row {}", i);

                Row row = sheet.getRow(i);
                if (row != null) {
                    try {
                        // 获取单元格的值
                        String cell0 = getCellValue(row.getCell(0)); // 姓名
                        String cell1 = getCellValue(row.getCell(1)); // 年龄
                        String cell2 = getCellValue(row.getCell(2)); // 性别

                        // 创建数据对象并设置字段
                        ExcelDemoInfoDTO demoInfoDTO = new ExcelDemoInfoDTO();
                        demoInfoDTO.setName(cell0);
                        demoInfoDTO.setAge(Integer.parseInt(cell1));
                        demoInfoDTO.setGender(cell2);

                        // 将数据对象加入到列表
                        demoInfoList.add(demoInfoDTO);

                    } catch (Exception e) {
                        log.error("Error reading row {}", i, e);
                    }
                }
            }

            // 使用Jackson将读取的数据转换为JSON字符串
            ObjectMapper mapper = new ObjectMapper();
            String json = mapper.writeValueAsString(demoInfoList);
            System.out.println(json);

            // 关闭资源
            workbook.close();
            fis.close();

        } catch (IOException e) {
            e.printStackTrace();
            return false;
        }
        return true;
    }

    /**
     * 获取单元格的值,处理不同类型的单元格
     *
     * @param cell 单元格对象
     * @return 单元格的字符串值
     */
    private static String getCellValue(Cell cell) {
        if (cell == null) {
            return "";
        }

        switch (cell.getCellType()) {
            case STRING:
                return cell.getStringCellValue();
            case NUMERIC:
                return String.valueOf((int) cell.getNumericCellValue());
            default:
                return "";
        }
    }
}

代码解析

  • 打开Excel文件 使用FileInputStream打开指定路径的Excel文件,然后通过XSSFWorkbook将其加载为工作簿(Workbook)。
  • 读取Excel工作表 通过workbook.getSheetAt(0)获取第一个工作表(Sheet)。你可以根据需要更改getSheetAt中的索引值来获取其他工作表。
  • 遍历行和列 使用sheet.getRow(i)获取每一行的数据。我们从第二行开始读取(i=1),因为第一行通常是标题行。
  • 获取单元格内容 通过row.getCell(i)获取每一列的内容,并使用getCellValue方法根据单元格的类型(字符串、数字等)获取对应的值。
  • 封装数据 将每行的数据封装为一个业务对象(ExcelDemoInfoDTO),并将其加入到一个列表中。
  • 转换为JSON格式 使用Jackson库将读取的数据转化为JSON格式,以便后续的处理或传输。
  • 资源关闭 使用完毕后,关闭workbook和FileInputStream以释放资源。

ExcelDemoInfoDTO 数据传输对象

为了更好地封装数据,我们创建一个简单的DTO(数据传输对象)类ExcelDemoInfoDTO:

public class ExcelDemoInfoDTO {
    private String name;
    private int age;
    private String gender;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getGender() {
        return gender;
    }

    public void setGender(String gender) {
        this.gender = gender;
    }
}

总结

在本次实践中,我们介绍了如何使用Apache POI库在Java中读取Excel文件,获取其中的数据,并将这些数据封装为业务对象。通过这种方式,我们可以灵活地读取各种格式的Excel数据,并进行后续的业务处理。对于更复杂的Excel文件,我们还可以进一步扩展代码来处理更多类型的单元格、跨工作表读取等情况。

以上就是SpringBoot使用Apache POI库读取Excel文件的操作详解的详细内容,更多关于SpringBoot Apache POI库读取Excel的资料请关注脚本之家其它相关文章!

相关文章

  • springboot 使用logback启动报警报错的解决

    springboot 使用logback启动报警报错的解决

    这篇文章主要介绍了springboot 使用logback启动报警报错的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • Java Autowired注解深入分析

    Java Autowired注解深入分析

    @Autowired注解是Spring中非常重要且常见的,接下来就简要的介绍一下它的用法。@Autowired默认是通过set方法,按照类型自动装配JavaBean,set方法可省略不写,它主要是修饰在成员变量上
    2023-01-01
  • Spring Boot中@Import三种使用方式实例详解

    Spring Boot中@Import三种使用方式实例详解

    这篇文章主要介绍了Spring Boot中@Import三种使用方式,主要有引入普通类,引入importSelector的实现类及引入importBeanDefinitionRegister的实现类,结合实例代码给大家讲解的非常详细,需要的朋友可以参考下
    2022-11-11
  • mybatis返回map结果集@MapKey使用的场景分析

    mybatis返回map结果集@MapKey使用的场景分析

    这篇文章主要介绍了mybatis返回map结果集@MapKey使用的场景分析,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-01-01
  • 浅谈java中String与StringBuffer的不同

    浅谈java中String与StringBuffer的不同

    String在栈中,StringBuffer在堆中!所以String是不可变的,数据是共享的。StringBuffer都是独占的,是可变的(因为每次都是创建新的对象!)
    2015-11-11
  • Java多线程实例

    Java多线程实例

    本文给大家介绍java多线程实例,对java多线程知识感兴趣的朋友参考下吧
    2015-11-11
  • Java简单实现调用命令行并获取执行结果示例

    Java简单实现调用命令行并获取执行结果示例

    这篇文章主要介绍了Java简单实现调用命令行并获取执行结果,结合实例形式分析了Java调用ping命令并获取执行结果相关操作技巧,需要的朋友可以参考下
    2018-08-08
  • 使用Get方式提交数据到Tomcat服务器的方法

    使用Get方式提交数据到Tomcat服务器的方法

    这篇文章将介绍向服务器发送数据,并且服务器将数据的处理结果返回给客户端,本文给大家介绍使用Get方式向服务器发送数据,感兴趣的朋友一起学习吧
    2016-04-04
  • Spring与Mybatis基于注解整合Redis的方法

    Spring与Mybatis基于注解整合Redis的方法

    这篇文章主要介绍了Spring与Mybatis基于注解整合Redis的方法,本文通过实例给大家介绍的非常详细,具有参考借鉴价值,需要的朋友可以参考下
    2016-09-09
  • java通过复选框控件数组实现添加多个复选框控件示例分享

    java通过复选框控件数组实现添加多个复选框控件示例分享

    编写程序,通过复选框控件数组事先选择用户爱好信息的复选框,在该程序中,要求界面中的复选框数量可以根据指定复选框名称的字符串数组的长度来自动调节
    2014-02-02

最新评论