1. Apache POI

1.1 POI介绍

Apache POI是用Java编写的免费开源的跨平台的Java API,Apache POI提供API给Java程序对Microsoft Office格式档案读和写的功能,其中使用最多的就是使用POI操作Excel文件。

jxl:专门操作Excel

POI:操作的范围更广,专门操作Microsoft Office

maven坐标:

  1. <dependency>
  2. <groupId>org.apache.poi</groupId>
  3. <artifactId>poi</artifactId>
  4. <version>3.14</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>org.apache.poi</groupId>
  8. <artifactId>poi-ooxml</artifactId>
  9. <version>3.14</version>
  10. </dependency>

POI结构:

  1. HSSF - 提供读写Microsoft Excel XLS格式档案的功能
  2. XSSF - 提供读写Microsoft Excel OOXML XLSX格式档案的功能
  3. HWPF - 提供读写Microsoft Word DOC格式档案的功能
  4. HSLF - 提供读写Microsoft PowerPoint格式档案的功能
  5. HDGF - 提供读Microsoft Visio格式档案的功能
  6. HPBF - 提供读Microsoft Publisher格式档案的功能
  7. HSMF - 提供读Microsoft Outlook格式档案的功能

1.2 入门案例

1.2.1 从Excel文件读取数据

使用POI可以从一个已经存在的Excel文件中读取数据

  1. //创建工作簿
  2. XSSFWorkbook workbook = new XSSFWorkbook("D:\\hello.xlsx");
  3. //获取工作表,既可以根据工作表的顺序获取,也可以根据工作表的名称获取
  4. XSSFSheet sheet = workbook.getSheetAt(0);
  5. //遍历工作表获得行对象
  6. for (Row row : sheet) {
  7. //遍历行对象获取单元格对象
  8. for (Cell cell : row) {
  9. //获得单元格中的值
  10. //如果单元格的值是数值,那么执行该getStringCellValue(),会抛异常
  11. String value = cell.getStringCellValue();
  12. System.out.println(value);
  13. }
  14. }
  15. workbook.close();

通过上面的入门案例可以看到,POI操作Excel表格封装了几个核心对象:

  1. XSSFWorkbook:工作簿
  2. XSSFSheet:工作表
  3. Row:行
  4. Cell:单元格

上面案例是通过遍历工作表获得行,遍历行获得单元格,最终获取单元格中的值。

还有一种方式就是获取工作表最后一个行号,从而根据行号获得行对象,通过行获取最后一个单元格索引,从而根据单元格索引获取每行的一个单元格对象,代码如下:

  1. //创建工作簿
  2. XSSFWorkbook workbook = new XSSFWorkbook("D:\\hello.xlsx");
  3. //获取工作表,既可以根据工作表的顺序获取,也可以根据工作表的名称获取
  4. XSSFSheet sheet = workbook.getSheetAt(0);
  5. //获取当前工作表最后一行的行号,行号从0开始
  6. int lastRowNum = sheet.getLastRowNum();
  7. for(int i=0;i<=lastRowNum;i++){
  8. //根据行号获取行对象
  9. XSSFRow row = sheet.getRow(i);
  10. //获取当前行最后一个单元格索引
  11. short lastCellNum = row.getLastCellNum();
  12. for(short j=0;j<lastCellNum;j++){
  13. String value = row.getCell(j).getStringCellValue();
  14. System.out.println(value);
  15. }
  16. }
  17. workbook.close();

注意点:在java代码中,行号从0开始,列号从1开始

1.2.2 向Excel文件写入数据

使用POI可以在内存中创建一个Excel文件并将数据写入到这个文件,最后通过输出流将内存中的Excel文件下载到磁盘

  1. //在内存中创建一个Excel文件
  2. XSSFWorkbook workbook = new XSSFWorkbook();
  3. //在内存中默认是没有工作表的
  4. //创建工作表,指定工作表名称
  5. XSSFSheet sheet = workbook.createSheet("传智播客");
  6. //创建行,0表示第一行
  7. XSSFRow row = sheet.createRow(0);
  8. //创建单元格,0表示第一个单元格
  9. row.createCell(0).setCellValue("编号");
  10. row.createCell(1).setCellValue("名称");
  11. row.createCell(2).setCellValue("年龄");
  12. XSSFRow row1 = sheet.createRow(1);
  13. row1.createCell(0).setCellValue("1");
  14. row1.createCell(1).setCellValue("小明");
  15. row1.createCell(2).setCellValue("10");
  16. XSSFRow row2 = sheet.createRow(2);
  17. row2.createCell(0).setCellValue("2");
  18. row2.createCell(1).setCellValue("小王");
  19. row2.createCell(2).setCellValue("20");
  20. //通过输出流将workbook对象下载到磁盘
  21. FileOutputStream out = new FileOutputStream("D:\\itcast.xlsx");
  22. //FileOutputStream out = new FileOutputStream(new File("D:\\itcast.xlsx"));
  23. workbook.write(out);
  24. out.flush();
  25. out.close();
  26. workbook.close();

1.2.3 POI报表工具类POIUtils

  1. package com.itheima.util;
  2. import java.io.FileNotFoundException;
  3. import java.io.IOException;
  4. import java.io.InputStream;
  5. import java.text.SimpleDateFormat;
  6. import java.util.ArrayList;
  7. import java.util.List;
  8. import org.apache.poi.hssf.usermodel.HSSFWorkbook;
  9. import org.apache.poi.ss.usermodel.Cell;
  10. import org.apache.poi.ss.usermodel.Row;
  11. import org.apache.poi.ss.usermodel.Sheet;
  12. import org.apache.poi.ss.usermodel.Workbook;
  13. import org.apache.poi.xssf.usermodel.XSSFWorkbook;
  14. import org.springframework.web.multipart.MultipartFile;
  15. public class POIUtils {
  16. private final static String xls = "xls";
  17. private final static String xlsx = "xlsx";
  18. private final static String DATE_FORMAT = "yyyy/MM/dd";
  19. /**
  20. * 读入excel文件,解析后返回
  21. * @param file
  22. * @throws IOException
  23. */
  24. public static List<String[]> readExcel(MultipartFile file) throws IOException {
  25. //检查文件
  26. checkFile(file);
  27. //获得Workbook工作薄对象
  28. Workbook workbook = getWorkBook(file);
  29. //创建返回对象,把每行中的值作为一个数组,所有行作为一个集合返回
  30. List<String[]> list = new ArrayList<String[]>();
  31. if(workbook != null){
  32. for(int sheetNum = 0;sheetNum < workbook.getNumberOfSheets();sheetNum++){
  33. //获得当前sheet工作表
  34. Sheet sheet = workbook.getSheetAt(sheetNum);
  35. if(sheet == null){
  36. continue;
  37. }
  38. //获得当前sheet的开始行
  39. int firstRowNum = sheet.getFirstRowNum();
  40. //获得当前sheet的结束行
  41. int lastRowNum = sheet.getLastRowNum();
  42. //循环除了第一行的所有行
  43. for(int rowNum = firstRowNum+1;rowNum <= lastRowNum;rowNum++){
  44. //获得当前行
  45. Row row = sheet.getRow(rowNum);
  46. if(row == null){
  47. continue;
  48. }
  49. //获得当前行的开始列
  50. int firstCellNum = row.getFirstCellNum();
  51. //获得当前行的列数
  52. int lastCellNum = row.getPhysicalNumberOfCells();
  53. String[] cells = new String[row.getPhysicalNumberOfCells()];
  54. //循环当前行
  55. for(int cellNum = firstCellNum; cellNum < lastCellNum;cellNum++){
  56. Cell cell = row.getCell(cellNum);
  57. cells[cellNum] = getCellValue(cell);
  58. }
  59. list.add(cells);
  60. }
  61. }
  62. workbook.close();
  63. }
  64. return list;
  65. }
  66. //校验文件是否合法
  67. public static void checkFile(MultipartFile file) throws IOException{
  68. //判断文件是否存在
  69. if(null == file){
  70. throw new FileNotFoundException("文件不存在!");
  71. }
  72. //获得文件名
  73. String fileName = file.getOriginalFilename();
  74. //判断文件是否是excel文件
  75. if(!fileName.endsWith(xls) && !fileName.endsWith(xlsx)){
  76. throw new IOException(fileName + "不是excel文件");
  77. }
  78. }
  79. public static Workbook getWorkBook(MultipartFile file) {
  80. //获得文件名
  81. String fileName = file.getOriginalFilename();
  82. //创建Workbook工作薄对象,表示整个excel
  83. Workbook workbook = null;
  84. try {
  85. //获取excel文件的io流
  86. InputStream is = file.getInputStream();
  87. //根据文件后缀名不同(xls和xlsx)获得不同的Workbook实现类对象
  88. if(fileName.endsWith(xls)){
  89. //2003
  90. workbook = new HSSFWorkbook(is);
  91. }else if(fileName.endsWith(xlsx)){
  92. //2007
  93. workbook = new XSSFWorkbook(is);
  94. }
  95. } catch (IOException e) {
  96. e.printStackTrace();
  97. }
  98. return workbook;
  99. }
  100. public static String getCellValue(Cell cell){
  101. String cellValue = "";
  102. if(cell == null){
  103. return cellValue;
  104. }
  105. //如果当前单元格内容为日期类型,需要特殊处理
  106. String dataFormatString = cell.getCellStyle().getDataFormatString();
  107. if(dataFormatString.equals("m/d/yy")){
  108. cellValue = new SimpleDateFormat(DATE_FORMAT).format(cell.getDateCellValue());
  109. return cellValue;
  110. }
  111. //把数字当成String来读,避免出现1读成1.0的情况
  112. if(cell.getCellType() == Cell.CELL_TYPE_NUMERIC){
  113. cell.setCellType(Cell.CELL_TYPE_STRING);
  114. }
  115. //判断数据的类型
  116. switch (cell.getCellType()){
  117. case Cell.CELL_TYPE_NUMERIC: //数字
  118. cellValue = String.valueOf(cell.getNumericCellValue());
  119. break;
  120. case Cell.CELL_TYPE_STRING: //字符串
  121. cellValue = String.valueOf(cell.getStringCellValue());
  122. break;
  123. case Cell.CELL_TYPE_BOOLEAN: //Boolean
  124. cellValue = String.valueOf(cell.getBooleanCellValue());
  125. break;
  126. case Cell.CELL_TYPE_FORMULA: //公式
  127. cellValue = String.valueOf(cell.getCellFormula());
  128. break;
  129. case Cell.CELL_TYPE_BLANK: //空值
  130. cellValue = "";
  131. break;
  132. case Cell.CELL_TYPE_ERROR: //故障
  133. cellValue = "非法字符";
  134. break;
  135. default:
  136. cellValue = "未知类型";
  137. break;
  138. }
  139. return cellValue;
  140. }
  141. }

1.3 实际项目中使用场景

1.3.1 从Excel文件读取数据的实际场景

上传并读取Excel文件,完成批量导入预约设置数据
image.png
Controller层

  1. /**
  2. * 预约设置
  3. */
  4. @RestController
  5. @RequestMapping("/ordersetting")
  6. public class OrderSettingController {
  7. @Reference
  8. private OrderSettingService orderSettingService;
  9. /**
  10. * Excel文件上传,并解析文件内容保存到数据库
  11. * @param excelFile
  12. * @return
  13. */
  14. @RequestMapping("/upload")
  15. public Result upload(@RequestParam("excelFile")MultipartFile excelFile){
  16. try {
  17. //读取Excel文件数据
  18. List<String[]> list = POIUtils.readExcel(excelFile);
  19. if(list != null && list.size() > 0){
  20. List<OrderSetting> orderSettingList = new ArrayList<>();
  21. for (String[] strings : list) {
  22. OrderSetting orderSetting =
  23. new OrderSetting(new Date(strings[0]), Integer.parseInt(strings[1]));
  24. orderSettingList.add(orderSetting);
  25. }
  26. orderSettingService.add(orderSettingList);
  27. }
  28. } catch (IOException e) {
  29. e.printStackTrace();
  30. return new Result(false, MessageConstant.IMPORT_ORDERSETTING_FAIL);
  31. }
  32. return new Result(true,MessageConstant.IMPORT_ORDERSETTING_SUCCESS);
  33. }
  34. }

1.3.2 向Excel文件写入数据的实际场景

将运营数据统计写入到Excel文件中,并提供给客户端浏览器进行下载
image.png

POI报表技术 - 图3
在企业实际开发中,对于这种比较复杂的表格导出一般我们会提前设计一个Excel模板文件,在这个模板文件中提前将表格的结构和样式设置好,我们的程序只需要读取这个文件并在文件中的相应位置写入具体的值就可以了。

1.3.2.1 完善页面

在report_business.html页面提供导出按钮并绑定事件

  1. <div class="excelTitle" >
  2. <el-button @click="exportExcel">导出Excel</el-button>运营数据统计
  3. </div>
  1. methods:{
  2. //导出Excel报表
  3. exportExcel(){
  4. window.location.href = '/report/exportBusinessReport.do';
  5. }
  6. }

异步请求返回的是json对象,是一个字符串。不能用作传输流

当前需要使用同步请求,以流的形式,将文件写到浏览器页面上,浏览器页面是会刷新的。

6.png

1.3.2.2 后台代码

在ReportController中提供exportBusinessReport方法,基于POI将数据写入到Excel中并通过输出流下载到客户端

  1. /**
  2. * 导出Excel报表
  3. * @return
  4. */
  5. @RequestMapping("/exportBusinessReport")
  6. public Result exportBusinessReport(HttpServletRequest request, HttpServletResponse response){
  7. try{
  8. //远程调用报表服务获取报表数据
  9. Map<String, Object> result = reportService.getBusinessReport();
  10. //取出返回结果数据,准备将报表数据写入到Excel文件中
  11. String reportDate = (String) result.get("reportDate");
  12. Integer todayNewMember = (Integer) result.get("todayNewMember");
  13. Integer totalMember = (Integer) result.get("totalMember");
  14. Integer thisWeekNewMember = (Integer) result.get("thisWeekNewMember");
  15. Integer thisMonthNewMember = (Integer) result.get("thisMonthNewMember");
  16. Integer todayOrderNumber = (Integer) result.get("todayOrderNumber");
  17. Integer thisWeekOrderNumber = (Integer) result.get("thisWeekOrderNumber");
  18. Integer thisMonthOrderNumber = (Integer) result.get("thisMonthOrderNumber");
  19. Integer todayVisitsNumber = (Integer) result.get("todayVisitsNumber");
  20. Integer thisWeekVisitsNumber = (Integer) result.get("thisWeekVisitsNumber");
  21. Integer thisMonthVisitsNumber = (Integer) result.get("thisMonthVisitsNumber");
  22. List<Map> hotSetmeal = (List<Map>) result.get("hotSetmeal");
  23. //获得Excel模板文件绝对路径
  24. //File.separator表示分隔符/,考虑到不知道之后部署的系统是windows还是linux,因此不推荐直接使用/
  25. String temlateRealPath = request.getSession().getServletContext().getRealPath("template") +
  26. File.separator + "report_template.xlsx";
  27. //读取模板文件创建Excel表格对象
  28. XSSFWorkbook workbook = new XSSFWorkbook(new FileInputStream(new File(temlateRealPath)));
  29. XSSFSheet sheet = workbook.getSheetAt(0);
  30. XSSFRow row = sheet.getRow(2);
  31. row.getCell(5).setCellValue(reportDate);//日期
  32. row = sheet.getRow(4);
  33. row.getCell(5).setCellValue(todayNewMember);//新增会员数(本日)
  34. row.getCell(7).setCellValue(totalMember);//总会员数
  35. row = sheet.getRow(5);
  36. row.getCell(5).setCellValue(thisWeekNewMember);//本周新增会员数
  37. row.getCell(7).setCellValue(thisMonthNewMember);//本月新增会员数
  38. row = sheet.getRow(7);
  39. row.getCell(5).setCellValue(todayOrderNumber);//今日预约数
  40. row.getCell(7).setCellValue(todayVisitsNumber);//今日到诊数
  41. row = sheet.getRow(8);
  42. row.getCell(5).setCellValue(thisWeekOrderNumber);//本周预约数
  43. row.getCell(7).setCellValue(thisWeekVisitsNumber);//本周到诊数
  44. row = sheet.getRow(9);
  45. row.getCell(5).setCellValue(thisMonthOrderNumber);//本月预约数
  46. row.getCell(7).setCellValue(thisMonthVisitsNumber);//本月到诊数
  47. int rowNum = 12;//表示第13行
  48. for(Map map : hotSetmeal){//热门套餐
  49. String name = (String) map.get("name");
  50. Long setmeal_count = (Long) map.get("setmeal_count");
  51. BigDecimal proportion = (BigDecimal) map.get("proportion");
  52. row = sheet.getRow(rowNum ++);
  53. row.getCell(4).setCellValue(name);//套餐名称
  54. row.getCell(5).setCellValue(setmeal_count);//预约数量
  55. row.getCell(6).setCellValue(proportion.doubleValue());//占比
  56. }
  57. //通过输出流进行文件下载,基于浏览器作为客户端下载,不能直接new流对象
  58. ServletOutputStream out = response.getOutputStream();//当前只知道是流,但是不知道是什么文件类型
  59. response.setContentType("application/vnd.ms-excel"); //向客户端声明往回写的是Excel文件类型
  60. //指定以附件形式下载,如果不指定附件下载,可能会被浏览器直接解析
  61. response.setHeader("content-Disposition", "attachment;filename=report.xlsx");
  62. workbook.write(out);
  63. out.flush();
  64. out.close();
  65. workbook.close();
  66. return null;
  67. }catch (Exception e){
  68. return new Result(false, MessageConstant.GET_BUSINESS_REPORT_FAIL,null);
  69. }
  70. }

1.3.2.3 测试结果可通过前端F12查看

7.png
60.png9.png在前面的课程中我们完成了将运营数据导出到Excel文件的功能。在企业开发中,除了常见的Excel形式报表,还有PDF形式的报表。那么如何导出PDF形式的报表呢?

2.PDF报表

2.1 常见的PDF报表生成方式

2.1.1 iText(不常用)

iText是著名的开放源码的站点sourceforge一个项目,是用于生成PDF文档的一个java类库。通过iText不仅可以生成PDF或rtf的文档,而且可以将XML、Html文件转化为PDF文件。 iText的安装非常方便,下载iText.jar文件后,只需要在系统的CLASSPATH中加入iText.jar的路径,在程序中就可以使用iText类库了。

maven坐标:

  1. <dependency>
  2. <groupId>com.lowagie</groupId>
  3. <artifactId>itext</artifactId>
  4. <version>2.1.7</version>
  5. </dependency>

示例代码:

一般不使用iText原生java进行生成pdf,该操作繁琐,一般不使用。

  1. package com.itheima.app;
  2. import com.lowagie.text.Document;
  3. import com.lowagie.text.DocumentException;
  4. import com.lowagie.text.Paragraph;
  5. import com.lowagie.text.pdf.PdfWriter;
  6. import java.io.FileNotFoundException;
  7. import java.io.FileOutputStream;
  8. public class ItextDemo {
  9. public static void main(String[] args) {
  10. try {
  11. Document document = new Document();//内存对象
  12. PdfWriter.getInstance(document, new FileOutputStream("D:\\test.pdf"));//磁盘化
  13. document.open();//打开文档
  14. document.add(new Paragraph("hello itext"));//往文档添加段落文字
  15. document.close();
  16. } catch (FileNotFoundException e) {
  17. e.printStackTrace();
  18. } catch (DocumentException e) {
  19. e.printStackTrace();
  20. }
  21. }
  22. }

2.1.2 JasperReports

JasperReports是一个强大、灵活的报表生成工具,能够展示丰富的页面内容,并将之转换成PDF,HTML,或者XML格式。该库完全由Java写成,可以用于在各种Java应用程序,包括J2EE,Web应用程序中生成动态内容。一般情况下,JasperReports会结合Jaspersoft Studio(模板设计器)使用导出PDF报表。

maven坐标:

  1. <dependency>
  2. <groupId>net.sf.jasperreports</groupId>
  3. <artifactId>jasperreports</artifactId>
  4. <version>6.8.0</version>
  5. </dependency>

2.2 JasperReports概述

2.2.1 JasperReports快速体验

本小节我们先通过一个快速体验来感受一下JasperReports的开发过程。

第一步:创建maven工程,导入JasperReports的maven坐标

  1. <dependency>
  2. <groupId>net.sf.jasperreports</groupId>
  3. <artifactId>jasperreports</artifactId>
  4. <version>6.8.0</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>junit</groupId>
  8. <artifactId>junit</artifactId>
  9. <version>4.12</version>
  10. </dependency>

第二步:将提前准备好的jrxml文件复制到maven工程中(后面会详细讲解如何创建jrxml文件)

42.png

第三步:编写单元测试,输出PDF报表

  1. @Test
  2. public void testJasperReports()throws Exception{
  3. //模板路径
  4. String jrxmlPath =
  5. "D:\\ideaProjects\\projects111\\jasperdemo\\src\\main\\resources\\demo.jrxml";
  6. //编译后模板路径
  7. String jasperPath =
  8. "D:\\ideaProjects\\projects111\\jasperdemo\\src\\main\\resources\\demo.jasper";
  9. //编译模板
  10. JasperCompileManager.compileReportToFile(jrxmlPath,jasperPath);
  11. //构造数据
  12. Map paramters = new HashMap();
  13. paramters.put("reportDate","2019-10-10");
  14. paramters.put("company","itcast");
  15. List<Map> list = new ArrayList();
  16. Map map1 = new HashMap();
  17. map1.put("name","xiaoming");
  18. map1.put("address","beijing");
  19. map1.put("email","xiaoming@itcast.cn");
  20. Map map2 = new HashMap();
  21. map2.put("name","xiaoli");
  22. map2.put("address","nanjing");
  23. map2.put("email","xiaoli@itcast.cn");
  24. list.add(map1);
  25. list.add(map2);
  26. //填充数据,在内存中
  27. JasperPrint jasperPrint =
  28. JasperFillManager.fillReport(jasperPath,
  29. paramters,
  30. new JRBeanCollectionDataSource(list));
  31. //输出文件
  32. String pdfPath = "D:\\test.pdf";
  33. JasperExportManager.exportReportToPdfFile(jasperPrint,pdfPath);
  34. }

2.2.2 JasperReports原理

43.png

  • JRXML:报表填充模板,本质是一个xml文件
  • Jasper:由JRXML模板编译成的二进制文件,用于代码填充数据
  • Jrprint:当用数据填充完Jasper后生成的对象,用于输出报表
  • Exporter:报表输出的管理类,可以指定要输出的报表为何种格式
  • PDF/HTML/XML:报表形式

2.2.3 开发流程

使用JasperReports导出pdf报表,开发流程如下:

  1. 制作报表模板(借助软件Jaspersoft Studio来设计模板)
  2. 模板编译
  3. 构造数据
  4. 填充数据
  5. 输出文件

2.3 模板设计器Jaspersoft Studio

Jaspersoft Studio是一个图形化的报表设计工具,可以非常方便的设计出PDF报表模板文件(其实就是一个xml文件),再结合JasperReports使用,就可以渲染出PDF文件。

下载地址:https://community.jaspersoft.com/community-download

1.png

下载完成后会得到如下安装文件:

2.png

直接双击安装即可。

2.3.1 Jaspersoft Studio面板介绍

4.png

2.3.2 创建工程和模板文件

打开Jaspersoft Studio工具,首先需要创建一个工程,创建过程如下:

5.png
6.png
7.png
8.png

创建完工程后,可以在工程上点击右键,创建模板文件:

9.png
10.png
11.png
12.png

这步根据需要选择数据适配器(空或者连接数据库)。
13.png
14.png

可以看到创建处理的模板文件后缀为jrxml,从设计区面板可以看到如下效果:

15.png

可以看到整个文件是可视化的,分为几大区域(Title、Page Header、Column Header等),如果某些区域不需要也可以选中区域位置,点击右键删除。

在面板左下角可以看到有三种视图方式:Design(设计模式)、Source(源码模式)、Preview(预览模式):

  • 通过Design视图可以看到模板的直观结构和样式
  • 通过Source视图可以看到文件xml源码
  • 通过Preview视图可以预览PDF文件输出后的效果

通过右侧Palette窗口可以看到常用的元素:

16.png

2.3.3 设计模板文件

2.3.3.1 增减Band

可以根据情况删除或者增加模板文件中的区域(称为Band),例如在Page Header区域上点击右键,选择删除菜单:

17.png

其中Detail区域可以添加多个,其他区域只能有一个。

2.3.3.2 将元素应用到模板中

2.3.3.2.1 Image元素

从右侧Palette面板中选择Image元素(图片元素),拖动到Title区域:
18.png

弹出如下对话框,有多种创建模式,选择URL模式,并在下面输入框中输入一个网络图片的连接地址:

19.png

20.png

可以选中图片元素,鼠标拖动调整位置,也可以通过鼠标调整图片的大小。

调整完成后,可以点击Preview进入预览视图,查看PDF输出效果:

21.png

点击Source进入源码视图,查看xml文件内容:

22.png

其实我们上面创建的demo1.jrxml模板文件,本质上就是一个xml文件,只不过我们不需要自己编写xml文件的内容,而是通过Jaspersoft Studio这个设计器软件进行可视化设计即可。

2.3.3.2.2 Static Text元素

Static Text元素就是静态文本元素,用于在PDF文件上展示静态文本信息:

23.png

双击Title面板中的Static Text元素,可以修改文本内容:

24.png

选中元素,也可以调整文本的字体和字号:
25.png

点击Preview进入预览视图,查看效果:

26.png

2.3.3.2.3 Current Date元素

Current Date元素用于在报表中输出当前系统日期,将该元素拖动到Title区域:

27.png

预览输出效果:

28.png

默认日期输出格式如上图所示,可以回到设计视图并选中元素,在Properties面板中的Text Field子标签中修改日期输出格式:

87.png

29.png

修改日期格式:

30.png

保存文件后重新预览:

31.png

2.3.3.3 动态数据填充

上面我们在PDF文件中展示的都是一些静态数据,那么如果需要动态展示一些数据应该如何实现呢?我们可以使用Outline面板中的Parameters和Fields来实现。

32.png

Parameters通常用来展示单个数据,Fields通常用来展示需要循环的列表数据。

2.3.3.3.1 Parameters

在Parameters上点击右键,创建一个Parameter参数:

33.png

可以在右侧的Properties面板中修改刚才创建的参数名称:

34.png

064.png

将刚才创建的Parameter参数拖动到面板中:

35.png

进入预览视图,查看效果:

36.png

由于模板中我们使用了Parameter动态元素,所以在预览之前需要为其动态赋值:

37.png

注意:由于我们是在Jaspersoft Studio软件中进行预览,所以需要通过上面的输入框动态为Parameter赋值,在后期项目使用时,需要我们在Java程序中动态为Parameter赋值进行数据填充。

2.3.3.3.2 Fields

使用Fields方式进行数据填充,既可以使用jdbc数据源方式也可以使用JavaBean数据源方式。

  • jdbc数据源数据填充(依赖这个工具进行填充,与Java代码无关)

第一步:在Repository Explorer面板中,在Data Adapters点击右键,创建一个数据适配器

38.png

第二步:选择Database JDBC Connection

39.png

第三步:选择mysql数据库,并完善jdbc连接信息

40.png

为了能够在Jaspersoft Studio中预览到数据库中的数据,需要加入MySQL的驱动包

41.png

第四步:在Outline视图中,右键点击工程名,选择Database and Query菜单(用来连接数据库)

44.png

第五步:在弹出的对话框中选择刚刚创建的JDBC数据库连接选项

45.png

第六步:在弹出对话框中Language选择sql,在右侧区域输入SQL语句并点击Read Fields按钮

46.png

可以看到通过点击上面的Read Fields按钮,已经读取到了t_setmeal表中的所有字段信息并展示在了下面,这些字段可以根据需要进行删除或者调整位置

第七步:在Outline视图中的Fields下可以看到t_setmeal表中相关字段信息,拖动某个字段到设计区的Detail区域并调整位置

47.png

可以看到,在拖动Fields到设计区时,同时会产生两个元素,一个是静态文本,一个是动态元素。静态文本相当于表格的表头,可以根据需要修改文本内容。最终设计完的效果如下:

48.png

第八步:使用Preview预览视图进行预览

49.png

通过上图可以看到,虽然列表数据展示出来了,但是展示的还存在问题。在每条数据遍历时表头也跟着遍历了一遍。这是怎么回事呢?这是由于我们设计的表头和动态Fields都在Detail区域。为了能够解决上面的问题,需要将表头放在Column Header区域,将动态Fields放在Detail区域。具体操作如下:

1、在Outline视图的Column Header点击右键创建出一个区域

50.png

2、将Detail下的静态文本拖动到Column Header下

51.png

拖动完成后如下:

52.png

3、调整静态文本在Column Header区域的位置,最终效果如下

53.png

4、预览查看效果

54.png

  • JavaBean数据源数据填充

第一步:复制上面的demo1.jrxml文件,名称改为demo2.jrxml

55.png

修改Report Name:

57.png

第二步:打开demo2.jrxml文件,将detail区域中的动态Fields元素删除

56.png

第三步:将Outline面板中Fields下的字段全部删除

58.png

第四步:清除JDBC数据源和相关SQL语句

61.png
62.png

第五步:在Fields处点击右键创建新的Field

59.png

创建完成后在Properties属性面板中修改Field的名称
60.png
63.png

第六步:将创建的Fields拖动到Detail区域并调整好位置

64.png

注意:使用此种JavaBean数据源数据填充方式,无法正常进行预览,因为这些动态Fields需要在Java程序中动态进行数据填充。

2.3.3.4添加边框

416.png

2.3.4 结合JasperReports输出报表

前面我们已经使用Jaspersoft Studio设计了两个模板文件:demo1.jrxml和demo2.jrxml。其中demo1.jrxml的动态列表数据是基于JDBC数据源方式进行数据填充,demo2.jrxml的动态列表数据是基于JavaBean数据源方式进行数据填充。本小节我们就结合JasperReports的Java API来完成pdf报表输出。

2.3.4.1 JDBC数据源方式填充数据

第一步:创建maven工程,导入相关maven坐标

  1. <dependency>
  2. <groupId>net.sf.jasperreports</groupId>
  3. <artifactId>jasperreports</artifactId>
  4. <version>6.8.0</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>junit</groupId>
  8. <artifactId>junit</artifactId>
  9. <version>4.12</version>
  10. </dependency>
  11. <dependency>
  12. <groupId>mysql</groupId>
  13. <artifactId>mysql-connector-java</artifactId>
  14. <version>5.1.47</version>
  15. </dependency>

第二步:将设计好的demo1.jrxml文件复制到当前工程的resources目录下

65.png

第三步:编写单元测试

  1. @Test
  2. public void testReport_JDBC() throws Exception{
  3. Class.forName("com.mysql.jdbc.Driver");
  4. Connection connection =
  5. DriverManager.getConnection("jdbc:mysql://localhost:3306/health",
  6. "root",
  7. "root");
  8. String jrxmlPath = "D:\\ideaProjects\\projects111\\jasperreports_test\\src\\main\\resources\\demo1.jrxml";
  9. String jasperPath = "D:\\ideaProjects\\projects111\\jasperreports_test\\src\\main\\resources\\demo1.jasper";
  10. //编译模板,编译为后缀为jasper的二进制文件
  11. JasperCompileManager.compileReportToFile(jrxmlPath,jasperPath);
  12. //构造数据
  13. Map paramters = new HashMap();
  14. paramters.put("company","传智播客");
  15. //填充数据---使用JDBC数据源方式填充
  16. JasperPrint jasperPrint =
  17. JasperFillManager.fillReport(jasperPath,
  18. paramters,
  19. connection);
  20. //输出文件
  21. String pdfPath = "D:\\test.pdf";
  22. JasperExportManager.exportReportToPdfFile(jasperPrint,pdfPath);
  23. }

通过上面的操作步骤可以输出pdf文件,但是中文的地方无法正常显示。这是因为JasperReports默认情况下对中文支持并不友好,需要我们自己进行修复。具体操作步骤如下:

1、在Jaspersoft Studio中打开demo1.jrxml文件,选中中文相关元素,统一将字体设置为“华文宋体”并将修改后的demo1.jrxml重新复制到maven工程中

2、将本章资源/解决中文无法显示问题目录下的文件复制到maven工程的resources目录中

66.png

按照上面步骤操作后重新执行单元测试导出PDF文件:

67.png

2.3.4.2 JavaBean数据源方式填充数据

第一步:为了能够避免中文无法显示问题,首先需要将demo2.jrxml文件相关元素字体改为“华文宋体”并将demo2.jrxml文件复制到maven工程的resources目录下

68.png

第二步:编写单元测试方法输出PDF文件

  1. @Test
  2. public void testReport_JavaBean() throws Exception{
  3. String jrxmlPath = "D:\\ideaProjects\\projects111\\jasperreports_test\\src\\main\\resources\\demo2.jrxml";
  4. String jasperPath = "D:\\ideaProjects\\projects111\\jasperreports_test\\src\\main\\resources\\demo2.jasper";
  5. //编译模板
  6. JasperCompileManager.compileReportToFile(jrxmlPath,jasperPath);
  7. //构造数据
  8. Map paramters = new HashMap();
  9. paramters.put("company","传智播客");
  10. List<Map> list = new ArrayList();
  11. Map map1 = new HashMap();
  12. map1.put("tName","入职体检套餐");
  13. map1.put("tCode","RZTJ");
  14. map1.put("tAge","18-60");
  15. map1.put("tPrice","500");
  16. Map map2 = new HashMap();
  17. map2.put("tName","阳光爸妈老年健康体检");
  18. map2.put("tCode","YGBM");
  19. map2.put("tAge","55-60");
  20. map2.put("tPrice","500");
  21. list.add(map1);
  22. list.add(map2);
  23. //填充数据---使用JavaBean数据源方式填充
  24. JasperPrint jasperPrint =
  25. JasperFillManager.fillReport(jasperPath,
  26. paramters,
  27. new JRBeanCollectionDataSource(list));
  28. //输出文件
  29. String pdfPath = "D:\\test.pdf";
  30. JasperExportManager.exportReportToPdfFile(jasperPrint,pdfPath);
  31. }

查看输出效果:

69.png

2.4. 在项目中输出运营数据PDF报表

本小节我们将在项目中实现运营数据的PDF报表导出功能。

2.4.1 设计PDF模板文件

使用Jaspersoft Studio设计运营数据PDF报表模板文件health_business3.jrxml,设计后的效果如下:

70.png

在资源中已经提供好了此文件,直接使用即可。

2.4.2 搭建环境

第一步:在health_common工程的pom.xml中导入JasperReports的maven坐标

  1. <dependency>
  2. <groupId>net.sf.jasperreports</groupId>
  3. <artifactId>jasperreports</artifactId>
  4. <version>6.8.0</version>
  5. </dependency>

第二步:将资源中提供的模板文件health_business3.jrxml复制到health_backend工程的template目录下

71.png

第三步:将解决中文问题的相关资源文件复制到项目中

72.png

2.4.3 修改页面

修改health_backend工程的report_business.html页面,添加导出PDF的按钮并绑定事件

73.png
74.png

2.4.4 Java代码实现

在health_backend工程的ReportController中提供exportBusinessReport4PDF方法

  1. //导出运营数据到pdf并提供客户端下载
  2. @RequestMapping("/exportBusinessReport4PDF")
  3. public Result exportBusinessReport4PDF(HttpServletRequest request, HttpServletResponse response) {
  4. try {
  5. Map<String, Object> result = reportService.getBusinessReportData();
  6. //取出返回结果数据,准备将报表数据写入到PDF文件中
  7. List<Map> hotSetmeal = (List<Map>) result.get("hotSetmeal");
  8. //动态获取模板文件绝对磁盘路径
  9. String jrxmlPath =
  10. request.getSession().getServletContext().getRealPath("template") + File.separator + "health_business3.jrxml";
  11. String jasperPath =
  12. request.getSession().getServletContext().getRealPath("template") + File.separator + "health_business3.jasper";
  13. //编译模板
  14. JasperCompileManager.compileReportToFile(jrxmlPath, jasperPath);
  15. //填充数据---使用JavaBean数据源方式填充
  16. JasperPrint jasperPrint =
  17. JasperFillManager.fillReport(jasperPath,result,
  18. new JRBeanCollectionDataSource(hotSetmeal));
  19. ServletOutputStream out = response.getOutputStream();
  20. response.setContentType("application/pdf");//声明下载类型为pdf
  21. response.setHeader("content-Disposition", "attachment;filename=report.pdf");
  22. //输出文件
  23. JasperExportManager.exportReportToPdfStream(jasperPrint,out);
  24. return null;
  25. } catch (Exception e) {
  26. e.printStackTrace();
  27. return new Result(false, MessageConstant.GET_BUSINESS_REPORT_FAIL);
  28. }
  29. }