一、用途
Apache POI是用Java编写的免费开源的跨平台的Java API,Apache POI提供API给Java程序对Microsoft Office格式档案读和写的功能,其中使用最多的就是使用POI操作Excel文件。
二、 依赖:
在pom文件中添加依赖并刷新
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi</artifactId>
<version>3.14</version>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>3.14</version>
</dependency>
三、主要的结构组件有
- XSSF - 提供读写Microsoft Excel OOXML XLSX格式档案的功能(我们使用) 2007以后.xlsx 工作表大行号 1,048,576
- HWPF - 提供读写Microsoft Word DOC格式档案的功能
- HSLF - 提供读写Microsoft PowerPoint格式档案的功能
- HDGF - 提供读Microsoft Visio格式档案的功能
- HPBF - 提供读Microsoft Publisher格式档案的功能
- HSMF - 提供读Microsoft Outlook格式档案的功能
而我们通常使用:XSSF - 提供读写Microsoft Excel OOXML XLSX格式档案的功能
四、实战
①、介绍几个核心对象
- XSSFWorkbook:工作簿
- XSSFSheet:工作表
- XSSFRow:行
- XSSFCell:单元格
②、对excel文件进行读操作:
//. 1、创建一个工作簿对象 参数为:你需要读取的excel表格
Workbook workbook = new XSSFWorkbook("d:\\read.xlsx");
//. 2、获得工作表对象 可以理解为获取第一张表 下标从0开始
Sheet sht = workbook.getSheetAt(0);
//. 3、遍历工作表对象 获得行对象
for (Row row : sht) {
// 4、遍布行对象获取单元格
for (Cell cell : row) {
// 获取单元格的类型 因为不同的单元格的类型获取
//的值的方式也所 不同
int cellType = cell.getCellType();
//比较是否是自己需要的类型
if(Cell.CELL_TYPE_NUMERIC == cellType){
// 数值类型的单元格并打印
System.out.print(cell.getNumericCellValue() + ",");
}else {
// 从单元格取值
System.out.print(cell.getStringCellValue() + ",");
}
}
System.out.println();
}
解释上面执行过程:
先绑定excel表格所在路径获取工作簿,再从工作薄中获取工作表,遍历工作表 获取行对象,遍历行获取单元格对象 , 先获取单元格的类型getCellType,进行比较(Cell.xxx中有常数类型),如果匹配的上则 获取该类型的数据,否则获取字符串对象。
③、向excel中写入数据
//1.创建工作簿对象 在内存中
Workbook workbook = new XSSFWorkbook();
//2.创建工作表对象
Sheet sht = workbook.createSheet("text");
//3.创建行对象(第一行,下标从0开始)
Row row = sht.createRow(0);
//4.创建单元格对象(第一个单元格),
Cell cell = row.createCell(0);
//给第一个单元格设置内容
cell.setCellValue("姓名");
//给第一行第二个单元格,设置内容
row.createCell(1).setCellValue("年龄");
row.createCell(2).setCellValue("所在地");
//给第二行设置数据
row = sht.createRow(1);
row.createCell(0).setCellValue("小明");
row.createCell(1).setCellValue(20);
row.createCell(2).setCellValue("北京");
//5.通过输出流将workbook对象下载到磁盘并关闭工作薄 (参数为excel文件的保存位置路径)
workbook.write(new FileOutputStream(new File("d:\\createExcel.xlsx")));
//6、 关闭工作簿
workbook.close();
小结(适用场景)
- 从excel中读取数据,写入到数据库(导入)
- 从数据库查询数据,写入到excel文件(报表技术,导出)
在项目中的实用
这里:主要使用POI技术设置每一天可以预约体检的人数,先将数据保存在excel表格中,数据格式如下图形式:
最后实现的效果为:
前端代码(采用vue2.0+Element):
定义一个上传文件的按钮
<!--上传文件框-->
<el-upload action="/ordersetting/upload.do"
name="excelFile"
:show-file-list="false"
:on-success="handleSuccess"
:before-upload="beforeUpload">
<el-button type="primary">上传文件</el-button>
</el-upload>
<!--
action: 提交文件之后给后台controller类处理
name: 上传文件的参数名,。---后台使用MultipartFile类接收 excelFile为参数名
show-file-list: 显示上传的文件列表。
on-success: 上传成功后回调的方法
before-upload: 上传前调用的方法
-->
上传文件之前先对文件做一个校验:
在这上传文件只能是xls或者xlsx格式!
beforeUpload(file) {
//获取文件类型,并对其进行判断是否为xls类型,
const isXLS = file.type === 'application/vnd.ms-excel';
if (isXLS) {
return true;
}
//获取文件类型,并对其进行判断是否为xlsx类型,
const isXLSX = file.type === 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
if (isXLSX) {
return true;
}
//如果都不是,给出友好提示
this.$message.error('上传文件只能是xls或者xlsx格式!');
return false;
}
上传文件成功,后台执行并响应数据给前端,
前端拿到数据之后,对页面进行刷新,并设置
显示当月的预约情况
//调用--回调函数
handleSuccess(res, file) {
this.$message({
message: res.message,
type: res.flag ? "success" : "error"
})
// 同时刷新,日历中的日历信息
this.initData(null);
this.getDataByMonth();
}
后台处理(采用springMVC等):
介绍一个POI工具类(用于读取excel文件)
package com.health.utils;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.List;
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;
import org.springframework.web.multipart.MultipartFile;
/*
* 读取excel文件
* */
public class POIUtils {
private final static String xls = "xls";
private final static String xlsx = "xlsx";
public final static String DATE_FORMAT = "yyyy/MM/dd";
/**
* 读入excel文件,解析后返回
* @param file
* @throws IOException
*/
public static List<String[]> readExcel(MultipartFile file) throws IOException {
//检查文件
checkFile(file);
//获得Workbook工作薄对象
Workbook workbook = getWorkBook(file);
//创建返回对象,把每行中的值作为一个数组,所有行作为一个集合返回
List<String[]> list = new ArrayList<>();
if(workbook != null){
for(int sheetNum = 0;sheetNum < workbook.getNumberOfSheets();sheetNum++){
//获得当前sheet工作表
Sheet sheet = workbook.getSheetAt(sheetNum);
if(sheet == null){
continue;
}
//获得当前sheet的开始行
int firstRowNum = sheet.getFirstRowNum();
//获得当前sheet的结束行
int lastRowNum = sheet.getLastRowNum();
//循环除了第一行的所有行
for(int rowNum = firstRowNum+1;rowNum <= lastRowNum;rowNum++){
//获得当前行
Row row = sheet.getRow(rowNum);
if(row == null){
continue;
}
//获得当前行的开始列
int firstCellNum = row.getFirstCellNum();
//获得当前行的列数
int lastCellNum = row.getPhysicalNumberOfCells();
String[] cells = new String[row.getPhysicalNumberOfCells()];
//循环当前行
for(int cellNum = firstCellNum; cellNum < lastCellNum;cellNum++){
Cell cell = row.getCell(cellNum);
cells[cellNum] = getCellValue(cell);
}
list.add(cells);
}
}
workbook.close();
}
return list;
}
//校验文件是否合法
public static void checkFile(MultipartFile file) throws IOException{
//判断文件是否存在
if(null == file){
throw new FileNotFoundException("文件不存在!");
}
//获得文件名
String fileName = file.getOriginalFilename().toLowerCase();
//判断文件是否是excel文件
if(!fileName.endsWith(xls) && !fileName.endsWith(xlsx)){
throw new IOException(fileName + "不是excel文件");
}
}
public static Workbook getWorkBook(MultipartFile file) {
//获得文件名
String fileName = file.getOriginalFilename();
//创建Workbook工作薄对象,表示整个excel
Workbook workbook = null;
try {
//获取excel文件的io流
InputStream is = file.getInputStream();
//根据文件后缀名不同(xls和xlsx)获得不同的Workbook实现类对象
if(fileName.endsWith(xls)){
//2003
workbook = new HSSFWorkbook(is);
}else if(fileName.endsWith(xlsx)){
//2007
workbook = new XSSFWorkbook(is);
}
} catch (IOException e) {
e.printStackTrace();
}
return workbook;
}
public static String getCellValue(Cell cell){
String cellValue = "";
if(cell == null){
return cellValue;
}
//如果当前单元格内容为日期类型,需要特殊处理
String dataFormatString = cell.getCellStyle().getDataFormatString();
if(dataFormatString.equals("m/d/yy")){
cellValue = new SimpleDateFormat(DATE_FORMAT).format(cell.getDateCellValue());
return cellValue;
}
//把数字当成String来读,避免出现1读成1.0的情况
if(cell.getCellType() == Cell.CELL_TYPE_NUMERIC){
cell.setCellType(Cell.CELL_TYPE_STRING);
}
//判断数据的类型
switch (cell.getCellType()){
case Cell.CELL_TYPE_NUMERIC: //数字
cellValue = String.valueOf(cell.getNumericCellValue());
break;
case Cell.CELL_TYPE_STRING: //字符串
cellValue = String.valueOf(cell.getStringCellValue());
break;
case Cell.CELL_TYPE_BOOLEAN: //Boolean
cellValue = String.valueOf(cell.getBooleanCellValue());
break;
case Cell.CELL_TYPE_FORMULA: //公式
cellValue = String.valueOf(cell.getCellFormula());
break;
case Cell.CELL_TYPE_BLANK: //空值
cellValue = "";
break;
case Cell.CELL_TYPE_ERROR: //故障
cellValue = "非法字符";
break;
default:
cellValue = "未知类型";
break;
}
return cellValue;
}
}
web层
//接收上传文件的请求
@PostMapping("/upload")
public Result upload(MultipartFile excelFile) {
try {
//将读取出来的数据放入List容器中,
//使用OrderSetting POJO类进行接收
List<String[]> excel = POIUtils.readExcel(excelFile);
List<OrderSetting> orderSettingList = new ArrayList<>();
OrderSetting os = null;
//设置日期格式--"yyyy/MM/dd"
SimpleDateFormat sdf = new SimpleDateFormat(POIUtils.DATE_FORMAT);
for (String[] arr : excel) {
//格式化日期
Date parse = sdf.parse(arr[0]);
Integer integer = Integer.valueOf(arr[1]);
//创建对象放入容器中
os = new OrderSetting(parse, integer);
orderSettingList.add(os);
}
//调用服务层方法 对其数据进行处理
orderSettingService.addImport(orderSettingList);
return new Result(true, MessageConstant.IMPORT_ORDERSETTING_SUCCESS);
} catch (Exception e) {
e.printStackTrace();
return new Result(false, MessageConstant.IMPORT_ORDERSETTING_FAIL);
}
}
完毕!