作者:我就是在刷粪_944 | 来源:互联网 | 2023-10-16 17:48
写在之前
Excel文档是日常办公中非常普遍的一种数据记录模式。在业务场景中,往往有“导入Excel到某某系统中”的需求,所以这里记录一种使用poi 5.0系列的jar包解析为Java实体类的方法。
由于对Excel工作簿的理解有限,写代码水平有限;本例子更多的是经验记录和练习,参考意义因人而异。有不妥之处,还请批评指正。
一、需求
根据指定的Sheet顺序号,从每个Sheet指定的行以下,读取Excel工作簿数据为包含常用数据对象的实体类对象。
二、思路
结合poi的org.apache.poi.ss.usermodel.WorkBook接口,先将Excel工作簿抽象为工作表、标题、数据行。通过HSSFWorkbook和XSSFWorkbook实现类的方法,将Sheet顺序号和指定的行号作为可配置的参数,获取有关对象后转换为实体类。
三、实现
1.Excel实体类ExcelBean
package com.myself.pottest;
import java.util.List;
import java.util.Map;
/**
* 描述一个Excel工作簿其中的一个工作表的实体类
*/
public class ExcelBean {
/*
工作表名
*/
private String sheetname = null;
/*
表格标题
*/
private Map columntitle = null;
/*
表格主体部分
*/
private List
2.工具类ExcelParser
package com.myself.pottest;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.*;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
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;
public class ExcelParser {
/**
*Excel文件
*/
private File file;
/**
* Workbook接口,用于根据条件实例化不同的实现类
*/
private Workbook ExcelWorkbook = null;
public ExcelParser(String filepath ) {
this.file = new File(filepath);
}
/**
* 读取文件,判断文件类型并创建有关实现类来实现Workbook接口。
*/
public void Read() {
try (FileInputStream fis = new FileInputStream(file)) {
if (file.getName().endsWith(".xls")) {
ExcelWorkbook = new HSSFWorkbook(fis);
} else if (file.getName().endsWith(".xlsx")) {
ExcelWorkbook = new XSSFWorkbook(fis);
} else {
System.out.println(file.getName()+"不是可以被本类解析的文件");
return;
}
} catch (FileNotFoundException e) {
System.out.println("文件不存在!");
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 获取Workbook实现类的指定位置的Sheet实现类信息到Map中,并返回。
* @param SheetNum Map,存放需要读取的Excel的Sheet的顺序号及其指定行号,如第一个Sheet就写1,第一行就写1
* @return
*/
private Map GetSheet2Map(Map SheetNum) {
Map SheetMap = new LinkedHashMap<>();
if (SheetNum == null){
for (int k = 0; k Sheet sheet = ExcelWorkbook.getSheetAt(k);
SheetMap.put((k + 1), sheet.getSheetName());
}
}else if(SheetNum != null){
for (Map.Entry entry:SheetNum.entrySet()) {
Sheet sheet = ExcelWorkbook.getSheetAt(entry.getKey()-1);
SheetMap.put((entry.getKey()), sheet.getSheetName());
}
}
return SheetMap;
}
/**
* 将某个工作表的某行转换为标题的Map实现类,并返回
*
* @param sheet 要解析的工作表 Sheet对象实现类
* @param TitleRowIndex 标题位于哪一行
* @return
*/
private Map GetAnyRow2Title(Sheet sheet, int TitleRowIndex) {
Map TitleMap = new LinkedHashMap<>();
Row row = sheet.getRow(TitleRowIndex);
GetCell(sheet, row, TitleMap);
return TitleMap;
}
/**
* 将将某个工作表的某行转换为除去标题的Map实现类的List集合,并返回
*
* @param sheet 要解析的工作表 Sheet对象实现类
* @param TitleRowIndex 标题位于哪一行,默认标题以下部分是表格主体内容
* @return
*/
private List> GetRows2ListWithMap(Sheet sheet, int TitleRowIndex) {
List> TableRows = new ArrayList<>();
int rows = sheet.getPhysicalNumberOfRows();
for (int r = TitleRowIndex+1; r Row row = sheet.getRow(r);
if (row == null) {
System.out.println("工作表:" + sheet.getSheetName() + ",第" + r + "行为空行!");
} else if (row != null) {
Map RowMap = new HashMap<>();
GetCell(sheet, row, RowMap);
TableRows.add(RowMap);
}
}
return TableRows;
}
/**
* 将Sheet、Row接口的实现类转换为特定格式的Map接口的实现类,并返回。
* 转换后的Map实现类,-1位置作为工作表名,0位置作为行的序号,其余位置按照列的序号存到Map中。
*
* @param sheet 当前工作表,Sheet的实现类
* @param columnrow 当前行,Row的实现类
* @param columns 要存数据的Map实现类
*/
private void GetCell(Sheet sheet, Row columnrow, Map columns) {
if (columnrow == null) {
System.out.println(sheet.getSheetName() + "中有空行!");
return;
}
//-1位置作为工作表名
columns.put(-1, sheet.getSheetName() + "");
//0位置作为行的序号
columns.put(0, columnrow.getRowNum() + "");
//遍历Row对象,获取每行记录的每列
for (int c = 0; c Cell cell = columnrow.getCell(c);
Object value = "";
if (cell != null) {
switch (cell.getCellType()) {
//对不同类型的字段,用不同的方式获取
case FORMULA:
value = "" + cell.getCellFormula();
break;
case NUMERIC:
value = cell.getNumericCellValue();
break;
case STRING:
value = cell.getStringCellValue();
break;
case BLANK:
value = "";
break;
case BOOLEAN:
value = "" + cell.getBooleanCellValue();
break;
case ERROR:
value = "" + cell.getErrorCellValue();
break;
default:
value = "" + cell.getCellType();
}
//其余位置按照列的序号存到Map中
columns.put(cell.getColumnIndex() + 1, value);
}
}
}
/**
* 根据工作表的序号获取ExcelBean的实体类对象
* @return ExcelBean
*/
public List GetExcelBean(Map SheetNum) {
List excelBeans = new ArrayList<>();
if(ExcelWorkbook != null){
//获取所有工作表名称
Map TitleMap = GetSheet2Map(SheetNum);
//以工作表为单位来读取数据为实体类
for(Map.Entry entry:TitleMap.entrySet()){
ExcelBean excelBean = new ExcelBean();
//将TitleMap的值写入工作表属性
excelBean.setSheetname(entry.getValue().toString());
//根据TitleMap的键获取Sheet对象
Sheet sheet = ExcelWorkbook.getSheetAt(entry.getKey()-1);
//默认行号为0
int TitleNum = 0;
if(SheetNum != null){
//根据TitleMap的键到SheetNum中获取指定的行号
TitleNum = SheetNum.get(entry.getKey())-1;
}
excelBean.setColumntitle(GetAnyRow2Title(sheet,TitleNum));
excelBean.setRows(GetRows2ListWithMap(sheet,TitleNum));
excelBeans.add(excelBean);
}
}else if(ExcelWorkbook == null){
System.out.println("获取Workbook失败!");
}
return excelBeans;
}
/**
* 关闭Workbook对象
*/
public void Close(){
try {
ExcelWorkbook.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
3.测试类Test
package com.myself.pottest;
import org.apache.poi.ss.usermodel.Row;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class Test {
public static void main(String[] args) {
String path ="D:\\书本.xls";
ExcelParser excelpaser = new ExcelParser(path);
excelpaser.Read();
Map SheetNum = new HashMap<>();
//设置要读取的工作表顺序号及其对应的行号
SheetNum.put(1,1);
SheetNum.put(2,1);
SheetNum.put(3,2);
List excelBeanList = excelpaser.GetExcelBean(SheetNum);
for(ExcelBean Eb:excelBeanList){
System.out.println("工作表"+Eb.getSheetname());
System.out.println("表头"+Eb.getColumntitle());
List > rowList = Eb.getRows();
System.out.println("表格:");
for(Map map:rowList){
System.out.println(map);
}
}
excelpaser.Close();
}
}
4.工具类功能描述
输入Excel文件路径,程序自动识别xls和xlsx文件类型。根据预先设置的要读取的工作表顺序号及其对应的行号、读取Excel工作簿为ExcelBean的列表,工作表名为String,标题为Map,表格为List>。
5.效果
表格数据
运行结果
依赖的Jar包