当前位置: 开发笔记 > 前端 > 正文

SpringBoot实现Excel读取的实例教程

作者：白变小樱啊 | 来源：互联网 | 2022-02-03 13:29

这篇文章主要给大家介绍了关于SpringBoot实现Excel读取的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

前言

这是本人写的一个SpringBoot对Excel读取的方法，实测能用，待提升的地方有很多，有不足之处请多多指点。

Excel2003版（后缀为.xls）最大行数是65536行，最大列数是256列。

Excel2007以上的版本（后缀为.xlsx）最大行数是1048576行，最大列数是16384列。

提供2种方法读取：

1.根据指定的开始和结束行数读取返回结果，结果格式为List>

2.根据指定的开始和结束行数读取返回结果，结果格式为List

请根据实际内存堆可用大小进行读取，太多可进行分段读取（类似分页的原理）

读取Excel所需要的几个类

Excel

1.在pom.xml加上依赖


 
  org.apache.poi
  poi
  4.0.1
 
 
  org.apache.poi
  poi-ooxml
  4.0.1

2.ExcelPOJO实体类

package com.cly.utils.Excel;

/**
 * @author : CLy
 * @ClassName : ExcelPOJO
 * @date : 2020/7/9 17:13
 * 实体类所有成员变量都需要有GET,SET方法
 * 所有成员变量都要加上注解@excelRescoure(value = "&＃63;"),&＃63;为Excel真实列名，必须一一对应
 * @excelRescoure(value = "&＃63;"),&＃63;可为空,需要用到才赋值
 * 成员变量目前只允许String,Double,Interge,Float
 **/

public class ExcelPOJO {
 public String getName() {
 return name;
 }
 public void setName(String name) {
 this.name = name;
 }
 public String getPasswork() {
 return passwork;
 }
 public void setPasswork(String passwork) {
 this.passwork = passwork;
 }
 public String getLook() {
 return look;
 }
 public void setLook(String look) {
 this.look = look;
 }
 
 @excelRescoure(value = "XM")
 private String name;
 @excelRescoure(value = "SFZH")
 private String passwork;
 @excelRescoure()
 private String look;
 
 @Override
 public String toString(){
 return "name:"+this.getName()+",passwork:"+this.getPasswork()+",look:"+this.getLook();
 }
 public ExcelPOJO() {}
}

3.@interface自定义注解(用于实体类读取)

package com.cly.utils.Excel;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author : CLy
 * @ClassName : myRescoure
 * @date : 2020/7/10 9:31
 **/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface excelRescoure {
 String value() default "";//默认为空
}

4.excelRead类（读取Excel数据类）有很多冗余的代码，可抽离出来

package com.cly.utils.Excel;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONArray;
import com.alibaba.fastjson.JSONObject;
import com.sun.org.apache.bcel.internal.generic.NEW;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.formula.functions.T;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.xml.transform.Source;
import java.beans.IntrospectionException;
import java.beans.PropertyDescriptor;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.*;
import java.text.DecimalFormat;
import java.util.*;

/**
 * @author : CLy
 * @ClassName : excelRead
 * @date : 2020/7/9 11:08
 **/
public class excelRead {
 //日志输出
 private static Logger logger = LoggerFactory.getLogger(excelRead.class);
 //定义excel类型
 private static final String XLS = "xls";
 private static final String XLSX = "xlsx";

 /**
 * 根据文件后缀名类型获取对应的工作簿对象
 * @param inputStream 读取文件的输入流
 * @param fileType 文件后缀名类型（xls或xlsx）
 * @return 包含文件数据的工作簿对象
 */
 private static Workbook getWorkbook(InputStream inputStream, String fileType) throws IOException {
 //用自带的方法新建工作薄
 Workbook workbook = WorkbookFactory.create(inputStream);
 //后缀判断有版本转换问题
 //Workbook workbook = null;
 //if (fileType.equalsIgnoreCase(XLS)) {
 // workbook = new HSSFWorkbook(inputStream);
 //} else if (fileType.equalsIgnoreCase(XLSX)) {
 // workbook = new XSSFWorkbook(inputStream);
 //}
 return workbook;
 }


 /**
 * 将单元格内容转换为字符串
 * @param cell
 * @return
 */
 private static String convertCellValueToString(Cell cell) {
 if (cell == null) {
  return null;
 }
 String returnValue = null;
 switch (cell.getCellType()) {
  case NUMERIC: //数字
  Double doubleValue = cell.getNumericCellValue();
  // 格式化科学计数法，取一位整数，如取小数，值如0.0,取小数点后几位就写几个0
  DecimalFormat df = new DecimalFormat("0");
  returnValue = df.format(doubleValue);
  break;
  case STRING: //字符串
  returnValue = cell.getStringCellValue();
  break;
  case BOOLEAN: //布尔
  Boolean booleanValue = cell.getBooleanCellValue();
  returnValue = booleanValue.toString();
  break;
  case BLANK: // 空值
  break;
  case FORMULA: // 公式
  returnValue = cell.getCellFormula();
  break;
  case ERROR: // 故障
  break;
  default:
  break;
 }
 return returnValue;
 }

 /**
 * 处理Excel内容转为List>输出
 * workbook：已连接的工作薄
 * StatrRow：读取的开始行数（默认填0，0开始,传过来是EXcel的行数值默认从1开始，这里已处理减1）
 * EndRow：读取的结束行数（填-1为全部）
 * ExistTop:是否存在头部（如存在则读取数据时会把头部拼接到对应数据，若无则为当前列数）
 */
 private static List> HandleData(Workbook workbook, int StatrRow, int EndRow, boolean ExistTop) {
 //声明返回结果集result
 List> result = new ArrayList<>();
 //声明一个Excel头部函数
 ArrayList top = new ArrayList<>();
 //解析sheet（sheet是Excel脚页）
 /**
 *此处会读取所有脚页的行数据，若只想读取指定页，不要for循环，直接给sheetNum赋值，脚页从0开始（通常情况Excel都只有一页，所以此处未进行进一步处理）
 */
 for (int sheetNum = 0; sheetNum  map = new HashMap<>();
  //获取所有列数据
  for (int y = 0; y  0) {
   if (top.size() >= y) {
    map.put(top.get(y), convertCellValueToString(row.getCell(y)));
   } else {
    map.put(String.valueOf(y + 1), convertCellValueToString(row.getCell(y)));
   }
   } else {
   map.put(String.valueOf(y + 1), convertCellValueToString(row.getCell(y)));
   }
  }
  result.add(map);
  }
 }
 return result;
 }

 /**
 * 方法一
 * 根据行数和列数读取Excel
 * fileName:Excel文件路径
 * StatrRow：读取的开始行数（默认填0）
 * EndRow：读取的结束行数（填-1为全部）
 * ExistTop:是否存在头部（如存在则读取数据时会把头部拼接到对应数据，若无则为当前列数）
 * 返回一个List>
 */
 public static List> ReadExcelByRC(String fileName, int StatrRow, int EndRow, boolean ExistTop) {
 //判断输入的开始值是否少于等于结束值
 if (StatrRow > EndRow && EndRow != -1) {
  logger.warn("输入的开始行值比结束行值大，请重新输入正确的行数");
  List> error = null;
  return error;
 }
 //声明返回的结果集
 List> result = new ArrayList<>();
 //声明一个工作薄
 Workbook workbook = null;
 //声明一个文件输入流
 FileInputStream inputStream = null;
 try {
  // 获取Excel后缀名，判断文件类型
  String fileType = fileName.substring(fileName.lastIndexOf(".") + 1);
  // 获取Excel文件
  File excelFile = new File(fileName);
  if (!excelFile.exists()) {
  logger.warn("指定的Excel文件不存在！");
  return null;
  }
  // 获取Excel工作簿
  inputStream = new FileInputStream(excelFile);
  workbook = getWorkbook(inputStream, fileType);
  //处理Excel内容
  result = HandleData(workbook, StatrRow, EndRow, ExistTop);
 } catch (Exception e) {
  logger.warn("解析Excel失败，文件名：" + fileName + " 错误信息：" + e.getMessage());
 } finally {
  try {
  if (null != workbook) {
   workbook.close();
  }
  if (null != inputStream) {
   inputStream.close();
  }
  } catch (Exception e) {
  logger.warn("关闭数据流出错！错误信息：" + e.getMessage());
  return null;
  }
 }
 return result;
 }


/**==============================================================================================================================**/

 /**
 * 方法二
 * 根据给定的实体类中赋值的注解值读取Excel
 * fileName:Excel文件路径
 * StatrRow：读取的开始行数（默认填0）
 * EndRow：读取的结束行数（填-1为全部）
 * Class：传过来的实体类类型
 * 返回一个List:T为实体类
 */
 public static List ReadExcelByPOJO(String fileName, int StatrRow, int EndRow, Class t) throws InvocationTargetException, IntrospectionException, InstantiationException, IllegalAccessException, NoSuchFieldException {
 //判断输入的开始值是否少于等于结束值
 if (StatrRow > EndRow && EndRow != -1) {
  logger.warn("输入的开始行值比结束行值大，请重新输入正确的行数");
  List error = null;
  return error;
 }
 //声明返回的结果集
 List result = new ArrayList<>();
 //声明一个工作薄
 Workbook workbook = null;
 //声明一个文件输入流
 FileInputStream inputStream = null;
 try {
  // 获取Excel后缀名，判断文件类型
  String fileType = fileName.substring(fileName.lastIndexOf(".") + 1);
  // 获取Excel文件
  File excelFile = new File(fileName);
  if (!excelFile.exists()) {
  logger.warn("指定的Excel文件不存在！");
  return null;
  }
  // 获取Excel工作簿
  inputStream = new FileInputStream(excelFile);
  workbook = getWorkbook(inputStream, fileType);
  //处理Excel内容
  result = HandleDataPOJO(workbook, StatrRow, EndRow, t);
 } catch (Exception e) {
  logger.warn("解析Excel失败，文件名：" + fileName + " 错误信息：" + e.getMessage());
 } finally {
  try {
  if (null != workbook) {
   workbook.close();
  }
  if (null != inputStream) {
   inputStream.close();
  }
  } catch (Exception e) {
  logger.warn("关闭数据流出错！错误信息：" + e.getMessage());
  return null;
  }
 }
 return result;
 }


 /**
 * 处理Excel内容转为List输出
 * workbook：已连接的工作薄
 * StatrRow：读取的开始行数（默认填0，0开始,传过来是EXcel的行数值默认从1开始，这里已处理减1）
 * EndRow：读取的结束行数（填-1为全部）
 * Class：所映射的实体类
 */
 private static  List HandleDataPOJO(Workbook workbook, int StatrRow, int EndRow, Class<&＃63;> t) throws IntrospectionException, NoSuchFieldException, IllegalAccessException, InstantiationException, InvocationTargetException, ClassNotFoundException {
 //声明返回的结果集
 List result = new ArrayList();
 //解析sheet（sheet是Excel脚页）
 for (int sheetNum = 0; sheetNum  top = new ArrayList<>();
  //获取Excel第一行数据
  int firstRowNum = sheet.getFirstRowNum();
  Row firstRow = sheet.getRow(firstRowNum);
  if (null == firstRow) {
  logger.warn("解析Excel失败，在第一行没有读取到任何数据！");
  return null;
  }
  for (int i = 0; i  POJOfields = getPOJOFieldAndValue(t);
  //判断所需要的数据列
  Map exceltoPOJO = new HashMap<>();
  for (int i = 0; i > mapList = new ArrayList<>();
  //遍历行数
  for (int i = StatrRow - 1; i  map : exceltoPOJO.entrySet()) {
   //获取Exceld对应列的数据
   String celldata = convertCellValueToString(row.getCell(Integer.parseInt(map.getKey())));
   //使用发射
   //获取实体类T中指定成员变量的对象
   PropertyDescriptor pd = new PropertyDescriptor((String) map.getValue(), texcel.getClass());
   //获取成员变量的set方法
   Method method = pd.getWriteMethod();
   //判断成员变量的类型
   Field field = texcel.getClass().getDeclaredField((String) map.getValue());
   String object = field.getGenericType().getTypeName();
   if (object.endsWith("String")) {
   //执行set方法
   method.invoke(texcel, celldata);
   }
   if (object.endsWith("Double")) {
   Double middata = Double.valueOf(celldata);
   //执行set方法
   method.invoke(texcel, middata);
   }
   if (object.endsWith("Float")) {
   Float middata = Float.valueOf(celldata);
   //执行set方法
   method.invoke(texcel, middata);
   }
   if (object.endsWith("Integer")) {
   Integer middata = Integer.parseInt(celldata);
   //执行set方法
   method.invoke(texcel, middata);
   }
  }
  result.add(texcel);
  }
 }
 return result;
 }

 /**
 * 获取对应的实体类成员
 * */
 private static Map getPOJOFieldAndValue(Class T) {
 //声明返回结果集
 Map result = new HashMap<>();
 Field[] fields = T.getDeclaredFields();//获取属性名
 if (fields != null) {
  for (Field field : fields) {
  excelRescoure Rescoure = field.getAnnotation(excelRescoure.class);
  if (Rescoure.value() != null && !"".equals(Rescoure.value())) {
   result.put(Rescoure.value(), field.getName());
  }
  }
 } else {
  logger.warn("实体类：" + T + "不存在成员变量");
  return null;
 }
 return result;
 }
}

5.测试类

package com.cly.utils.Excel;

import java.util.*;


/**
 * @author : CLy
 * @ClassName : Readtest
 * @date : 2020/7/9 16:31
 **/
public class Readtest {
public static void main(String[] args) throws Exception {
 /** 方法一
 * fileName:Excel文件路径
 * StatrRow：读取的开始行数（默认填0）
 * EndRow：读取的结束行数（填-1为全部）
 * ExistTop:是否存在头部（如存在则读取数据时会把头部拼接到对应数据作为KEY，若无则KEY为当前列数）
 */
 List> result =excelRead.ReadExcelByRC("D:.xls",2,10,false);
 System.out.println(result.size());
 System.out.println(result);

 /**
 * 方法二
 * ReadExcelByPOJO(String fileName, int StatrRow, int EndRow, Class t)
 * fileName:Excel文件路径
 * StatrRow：读取的开始行数（默认填0）
 * EndRow：读取的结束行数（填-1为全部）
 * Class：传过来的实体类类型
 */
 List result2 = excelRead.ReadExcelByPOJO("D:.xls",2,10,ExcelPOJO.class);
 System.out.println(result2.size());
 System.out.println(result2);
 }
}

6.运行结果和说明

exce表格数据

方法一的运行结果

1.ture:key为列名

2.false:key为第几列列数

方法二的运行结果

实体类的所有成员变量一定要加上自定义注释@excelRescoure，不然会报错

还有很多不足的地方，请多多指点，希望能给你带来帮助。

SpringBoot实现内存数据导出成Excel在另一篇文章文章地址：https://www.jb51.net/article/202767.htm

总结

到此这篇关于SpringBoot实现Excel读取的文章就介绍到这了,更多相关SpringBoot实现Excel读取内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！

推荐阅读

json
解析猫鼬 findOne 方法返回 null 的原因

本文探讨了在通过 API 端点调用时，使用猫鼬（Mongoose）的 findOne 方法总是返回 null 的问题，并提供了详细的解决方案和建议。 ... [详细]

蜡笔小新 2024-12-25 17:40:33
build
网络链路质量监控：Smokeping部署与配置

本文详细介绍了如何在Linux系统上安装和配置Smokeping，以实现对网络链路质量的实时监控。通过详细的步骤和必要的依赖包安装，确保用户能够顺利完成部署并优化其网络性能监控。 ... [详细]

蜡笔小新 2024-12-27 19:31:05
json
RESTful API 与传统接口的主要区别

本文探讨了 RESTful API 和传统接口之间的关键差异，解释了为什么 RESTful API 在设计和实现上具有独特的优势。 ... [详细]

蜡笔小新 2024-12-27 15:33:42
json
Ionic 5 APK打包与QRScanner插件优化：常见问题及解决方案

本文总结了在使用Ionic 5进行Android平台APK打包时遇到的问题，特别是针对QRScanner插件的改造。通过详细分析和提供具体的解决方法，帮助开发者顺利打包并优化应用性能。 ... [详细]

蜡笔小新 2024-12-27 12:10:17
json
Composer Registry Manager：PHP的源切换管理工具

本文介绍了一个用于Composer的源切换管理工具——Composer Registry Manager。该项目旨在简化Composer包源的管理和切换，避免与常见的CRM系统混淆，并提供了详细的安装和使用指南。 ... [详细]

蜡笔小新 2024-12-25 19:34:14
json
Git 分布式版本控制系统：远程仓库的深入探讨

本文详细介绍了Git分布式版本控制系统中远程仓库的概念和操作方法。通过具体案例，帮助读者更好地理解和掌握如何高效管理代码库。 ... [详细]

蜡笔小新 2024-12-25 18:30:21
json
使用npm脚本同时启动多个监听服务的技巧

本文介绍了如何利用npm脚本和concurrently工具，实现本地开发环境中多个监听服务的同时启动，包括HTTP服务、自动刷新、Sass和ES6支持。 ... [详细]

蜡笔小新 2024-12-25 18:10:18
json
VSCode 自定义代码片段配置：实现类似IDEA的快捷代码段（如sout或psvm）

本文详细介绍如何在VSCode中配置自定义代码片段，使其具备与IDEA相似的代码生成快捷键功能。通过具体的Java和HTML代码片段示例，展示配置步骤及效果。 ... [详细]

蜡笔小新 2024-12-25 17:10:13
json
优化页面加载性能

在网页开发中，页面加载速度是一个关键的用户体验因素。为了提升加载效率，避免在PageLoad事件中进行大量数据绑定操作，可以采用异步加载和特定控件来优化页面加载过程。 ... [详细]

蜡笔小新 2024-12-25 16:57:49
json
深入解析JMeter中的JSON提取器及其应用

本文详细介绍了如何在JMeter中使用JSON提取器来获取和处理API响应中的数据。特别是在需要将一个接口返回的数据作为下一个接口的输入时，JSON提取器是一个非常有用的工具。 ... [详细]

蜡笔小新 2024-12-25 16:34:37
ajax
使用Python urllib模块实现POST请求并爬取百度翻译结果

本文详细解析了如何使用Python的urllib模块发起POST请求，并通过实例展示如何爬取百度翻译的翻译结果。 ... [详细]

蜡笔小新 2024-12-24 18:49:24
json
UC浏览器分享图片显示问题及解决方案

本文探讨了在UC浏览器中调用分享面板后，图片无法正常显示的问题，并提供了详细的解决方法和代码示例。 ... [详细]

蜡笔小新 2024-12-24 17:24:36
json
PostgreSQL中插入JSON数据的最佳实践

本文介绍如何在PostgreSQL数据库中正确插入和处理JSON数据类型，确保数据完整性和避免常见错误。 ... [详细]

蜡笔小新 2024-12-24 16:41:47
json
理解在 Ember.js 中加载 JSON 的最佳实践

作为一名 Ember.js 新手，了解如何在路由和模型中正确加载 JSON 数据是至关重要的。本文将探讨两者之间的差异，并提供实用的建议。 ... [详细]

蜡笔小新 2024-12-24 16:26:33
json
选择适合生产环境的Docker存储驱动

本文旨在探讨如何在生产环境中选择合适的Docker存储驱动，并详细介绍不同Linux发行版下的配置方法。通过参考官方文档和兼容性矩阵，提供实用的操作指南。 ... [详细]

蜡笔小新 2024-12-24 11:16:45

白变小樱啊

这个家伙很懒，什么也没留下！

Tags | 热门标签

RankList | 热门文章