介绍
Apache POI 是一个处理Miscrosoft Office各种文件格式的开源项目。我们可以使用 POI 在 Java 程序中对Miscrosoft Office各种文件进行读写操作。PS: 一般情况下,POI 都是用于操作 Excel 文件,如图:
Apache POI 的应用场景:
- 银行网银系统导出交易明细
- 各种业务系统导出Excel报表
- 批量导入业务数据
入门案例
- 导入Apache POI的maven坐标:
<dependency><groupId>org.apache.poi</groupId><artifactId>poi</artifactId>
</dependency>
<dependency><groupId>org.apache.poi</groupId><artifactId>poi-ooxml</artifactId>
</dependency>
- 数据写入Excel文件:
public class POITest {/*** 通过POI创建Excel,并写入文件内容*/public static void write() throws Exception {// 在内存中创建一个Excel文件XSSFWorkbook excel = new XSSFWorkbook();// 在Excel文件中创建一个sheet页XSSFSheet sheet = excel.createSheet("info");// 在sheet页中创建行对象,rownum的编号从0开始,写1表示创建第2行XSSFRow row = sheet.createRow(1);// 在行中创建单元格, columnIndex也是从0开始,使用setCellValue写入文本内容row.createCell(1).setCellValue("姓名");row.createCell(2).setCellValue("城市");// 创建新的一行row = sheet.createRow(2);row.createCell(1).setCellValue("张三");row.createCell(2).setCellValue("成都");row = sheet.createRow(3);row.createCell(1).setCellValue("李四");row.createCell(2).setCellValue("北京");FileOutputStream out = new FileOutputStream("/home/zxy/Projects/info.xlsx");excel.write(out);// 关闭资源out.close();excel.close();}public static void main(String[] args) throws Exception{write();}
}
运行效果:
- 从Excel中读取数据
/*** 通过POI读取Excel中的内容* @throws Exception*/public static void read() throws Exception{// 读取磁盘上已经存在的Excel文件FileInputStream in = new FileInputStream(new File("/home/zxy/Projects/info.xlsx"));XSSFWorkbook excel = new XSSFWorkbook(in);// 读取Excel文件中的第一个Sheet页XSSFSheet sheet = excel.getSheetAt(0);// 获取sheet页中数据所在最后一行的行号int lastRowNum = sheet.getLastRowNum();for (int i = 1; i <= lastRowNum; i++) {// 获得某一行XSSFRow row = sheet.getRow(i);// 获得单元格对象String cellValue1 = row.getCell(1).getStringCellValue();String cellValue2 = row.getCell(2).getStringCellValue();System.out.println(cellValue1 + " " + cellValue2);}// 关闭资源excel.close();in.close();}public static void main(String[] args) throws Exception{read();}
效果:
应用
场景:导出(并下载)商户最近30天的运营数据
注意:对导出数据的请求并没有返回数据,因为报表导出功能本质上是文件下载,服务端会通过输出流将Excel文件下载到客户端浏览器。
实现步骤:
- 设计Excel模板文件
- 查询近30天的运营数据
- 将查询到的运营数据写入模板文件
- 通过输出流将Excel文件下载到客户端浏览器
虽然POI可以设置文件的字体、字号、合并单元格等格式,但这会使得代码变得非常复杂,所以提前在文本编辑器中设置好Excel的模版文件,然后通过读取模版文件来填充数据,从而可以简化代码。
具体代码:
controller部分:
/*** 导出运营数据报表* @param response*/@GetMapping("/export")@ApiOperation("导出运营数据报表")public void export(HttpServletResponse response){reportService.exportBusinessData(response);}
Service部分:
/*** 导出运营数据报表* @param response*/void exportBusinessData(HttpServletResponse response);
重点: Service的实现类中对应的方法:
/*** 导出运营数据报表** @param response*/@Overridepublic void exportBusinessData(HttpServletResponse response) {// 1. 查询数据库,获取营业数据 --- 查询最近30天的数据LocalDate dateBegin = LocalDate.now().minusDays(30);LocalDate dateEnd = LocalDate.now().minusDays(1);// 查询概览数据BusinessDataVO businessData = workspaceService.getBusinessData(LocalDateTime.of(dateBegin, LocalTime.MIN), LocalDateTime.of(dateEnd, LocalTime.MAX));// 2. 通过POI将数据写入到Excel文件中InputStream in = this.getClass().getClassLoader().getResourceAsStream("template/运营数据报表模板.xlsx");try {// 基于模板文件创建一个新的Excel文件XSSFWorkbook excel = new XSSFWorkbook(in);// 获取表格文件的Sheet页XSSFSheet sheet = excel.getSheet("Sheet1");// 填充数据——时间sheet.getRow(1).getCell(1).setCellValue("时间:" + dateBegin + "至" + dateEnd);// 获取第4行XSSFRow row = sheet.getRow(3);row.getCell(2).setCellValue(businessData.getTurnover());row.getCell(4).setCellValue(businessData.getOrderCompletionRate());row.getCell(6).setCellValue(businessData.getNewUsers());// 获取第5行row = sheet.getRow(4);row.getCell(2).setCellValue(businessData.getValidOrderCount());row.getCell(4).setCellValue(businessData.getUnitPrice());// 填充明细数据for (int i = 0; i < 30; i++) {LocalDate date = dateBegin.plusDays(i);// 查询某一天的数据BusinessDataVO businessDataVO = workspaceService.getBusinessData(LocalDateTime.of(date, LocalTime.MIN), LocalDateTime.of(date, LocalTime.MAX));// 获得某一行row = sheet.getRow(7 + i);row.getCell(1).setCellValue(date.toString());row.getCell(2).setCellValue(businessDataVO.getTurnover());row.getCell(3).setCellValue(businessDataVO.getValidOrderCount());row.getCell(4).setCellValue(businessDataVO.getOrderCompletionRate());row.getCell(5).setCellValue(businessDataVO.getUnitPrice());row.getCell(6).setCellValue(businessDataVO.getNewUsers());}// 3. 通过输出流将Excel文件下载到客户端浏览器ServletOutputStream out = response.getOutputStream();excel.write(out);// 关闭资源out.close();excel.close();} catch (IOException e) {throw new RuntimeException(e);}}
代码细节补充:
workspaceService.getBusinessData:
@Overridepublic BusinessDataVO getBusinessData(LocalDateTime begin, LocalDateTime end) {/*** 营业额:当日完成订单的总额* 有效订单:当日完成订单的数量* 订单完成率:有效订单数 / 总订单数* 新增用户:当日新增用户的数量*/Map map = new HashMap();map.put("begin",begin);map.put("end",end);// 查询订单总数Integer totalOrderCount = orderMapper.getByMap(map);map.put("status", Orders.COMPLETED);// 营业额Double turnover = orderMapper.sumByMap(map);turnover = turnover ==null? 0.0 :turnover;// 有效订单数Integer validOrderCount = orderMapper.getByMap(map);Double unitPrice = 0.0;Double orderCompletionRate = 0.0;if(totalOrderCount != 0 && validOrderCount != 0){// 订单完成率orderCompletionRate = validOrderCount.doubleValue() / totalOrderCount;//平均客单价unitPrice = turnover / validOrderCount;}// 新增用户数Integer newUsers = userMapper.countByMap(map);return BusinessDataVO.builder().turnover(turnover).validOrderCount(validOrderCount).orderCompletionRate(orderCompletionRate).unitPrice(unitPrice).newUsers(newUsers).build();}
实现效果: