springboot+JXLS+Jexl实现报表模版生成报表

前言

做这个项目的思路是由于公司基于自身发展，需要将之前的老项目平台拆解出来，由于之前的项目是所有的功能全部集中在一起，学习成本以及后续的扩展性来说，非常的不友好，并且由于之前设计人员的流失导致了项目无法进一步优化，所以想将其进行拆解，将单个功能模块进行拆分，形成微服务化，使每个功能的业务更加单一，也更加简单
经过使用了一段时间的老平台，发现目前公司的平台的一些设计确实非常的好，其中，报表的设计理念比市面上大多的报表工具设计都要好，为什么呢，因为我们公司是基于B to B的项目模式，所以，客户可能会经常临时性的提出一些报表需求，并且需要响应时间比较快速，所以我们需要一种基于模版即可生成报表的报表工具
报表工具的比对

基于模版形式的报表工具

目前市场上基于模版的是JXLS，他的优势是JXLS 是基于 Jakarta POI API 的 Excel 报表生成工具，可以生成精美的 Excel 格式报表。它采用标签的方式，类似 JSP 标签，写一个 Excel 模板，然后生成报表，非常灵活，简单！
缺点是它只可以导出03版本的excel
实现jxls

配置与使用

• 引入依赖
  1.                                 <dependency>
  2.             <groupId>org.jxls</groupId>
  3.             <artifactId>jxls</artifactId>
  4.             <version>2.8.0</version>
  5.         </dependency>
  6.         <dependency>
  7.             <groupId>org.jxls</groupId>
  8.             <artifactId>jxls-poi</artifactId>
  9.             <version>1.0.15</version>
  10.         </dependency>
  11.         <dependency>
  12.             <groupId>net.sf.jxls</groupId>
  13.             <artifactId>jxls-core</artifactId>
  14.             <version>1.0.5</version>
  15.         </dependency>

  复制代码
• 编写工具辅助类
  研发一个execl生成的工具类，其中加入了自定义方法，这个思想与lims平台设计中的Alog类类似,采用Jexl来进行实现，本项目采用的是jexl3
  1. package com.thyc.reportserver.utils;
  3. import com.thyc.reportserver.excelCal.CalTime;
  4. import org.apache.commons.jexl3.JexlBuilder;
  5. import org.apache.commons.jexl3.JexlEngine;
  6. import org.jxls.area.Area;
  7. import org.jxls.builder.AreaBuilder;
  8. import org.jxls.builder.xls.XlsCommentAreaBuilder;
  9. import org.jxls.common.CellRef;
  10. import org.jxls.common.Context;
  11. import org.jxls.expression.JexlExpressionEvaluator;
  12. import org.jxls.transform.Transformer;
  13. import org.jxls.util.TransformerFactory;
  15. import javax.servlet.http.HttpServletResponse;
  16. import java.io.IOException;
  17. import java.io.InputStream;
  18. import java.io.OutputStream;
  19. import java.util.HashMap;
  20. import java.util.List;
  21. import java.util.Map;
  22. import java.util.Set;
  24. /**
  25. * @Description: excel辅助工具类
  26. * @Author: wanping
  27. * @Date: 6/13/23
  28. **/
  29. public class ExcelUtils {
  30.     /***
  31.      * excel导出到response
  32.      * @param fileName   导出文件名
  33.      * @param templateFile 模板文件地址
  34.      * @param params     数据集合
  35.      * @param response   response
  36.      */
  37.     public static void exportExcel(String fileName, InputStream templateFile, Map<String, Object> params,
  38.                                    HttpServletResponse response) throws IOException {
  39.         response.reset();
  40.         response.setHeader("Accept-Ranges", "bytes");
  41.         OutputStream os = null;
  42.         response.setHeader("Content-disposition", String.format("attachment; filename="%s"", fileName));
  43.         response.setContentType("application/octet-stream;charset=UTF-8");
  44.         try {
  45.             os = response.getOutputStream();
  46.             exportExcel(templateFile, params, os);
  47.         } catch (IOException e) {
  48.             throw e;
  49.         }
  50.     }
  52.     /**
  53.      * 导出excel到输出流中
  54.      * @param templateFile 模板文件
  55.      * @param params 传入参数
  56.      * @param os 输出流
  57.      * @throws IOException
  58.      */
  59.     public static void exportExcel(InputStream templateFile, Map<String, Object> params, OutputStream os) throws IOException {
  60.         try {
  61.             Context context = new Context();
  62.             Set<String> keySet = params.keySet();
  63.             for (String key : keySet) {
  64.                 //设置参数变量
  65.                 context.putVar(key, params.get(key));
  66.             }
  67.             Map<String, Object> myFunction = new HashMap<>();
  68.             myFunction.put("calTime", new CalTime());
  69.             // 启动新的jxls-api 加载自定义方法
  70.             Transformer trans = TransformerFactory.createTransformer(templateFile, os);
  71.             JexlExpressionEvaluator evaluator = (JexlExpressionEvaluator) trans.getTransformationConfig().getExpressionEvaluator();
  72. //            evaluator.getJexlEngine().setFunctions(myFunction); 这个方法是2版本的
  73.             JexlBuilder jb = new JexlBuilder();
  74.             jb.namespaces(myFunction);
  75.             JexlEngine je = jb.create();
  76.             evaluator.setJexlEngine(je);
  78.             // 载入模板、处理导出
  79.             AreaBuilder areaBuilder = new XlsCommentAreaBuilder(trans);
  80.             List<Area> areaList = areaBuilder.build();
  81.             areaList.get(0).applyAt(new CellRef("sheet1!A1"), context);
  82.             trans.write();
  83.         } catch (IOException e) {
  84.             throw e;
  85.         } finally {
  86.             try {
  87.                 if (os != null) {
  88.                     os.flush();
  89.                     os.close();
  90.                 }
  91.                 if (templateFile != null) {
  92.                     templateFile.close();
  93.                 }
  94.             } catch (IOException e) {
  95.                 throw e;
  96.             }
  97.         }
  98.     }
  99. }

  复制代码
• 编写计算类
  1. package com.thyc.reportserver.excelCal;
  3. import org.jxls.transform.poi.WritableCellValue;
  4. import org.jxls.transform.poi.WritableHyperlink;
  6. import java.text.SimpleDateFormat;
  7. import java.util.Date;
  9. /**
  10. * @Description: excel计算时间方法
  11. * @Author: wanping
  12. * @Date: 6/13/23
  13. **/
  14. public class CalTime {
  16.     /**
  17.      * 格式化时间
  18.      */
  19.     public Object formatDate(Date date) {
  20.         if (date != null) {
  21.             SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
  22.             String dateStr = sdf.format(date);
  23.             return dateStr;
  24.         }
  25.         return "--";
  26.     }
  28.     /**
  29.      * 设置超链接方法
  30.      */
  31.     public WritableCellValue getLink(String address, String title) {
  32.         return new WritableHyperlink(address, title);
  33.     }
  35. }

  复制代码
• 编写剩下的测试用例
  service
  1. package com.thyc.reportserver.service;
  3. import javax.servlet.http.HttpServletResponse;
  5. import java.io.File;
  6. import java.io.OutputStream;
  7. import java.util.Map;
  9. /**
  10. * @Description: TODO
  11. * @Author: wanping
  12. * @Date: 6/13/23
  13. **/
  14. public interface ExcelService {
  16.     /**
  17.      * 导出excel,写入文件中
  18.      * @param templateFile
  19.      * @param params
  20.      * @param outputFile
  21.      * @return
  22.      */
  23.     boolean getExcel(String templateFile, Map<String,Object> params, File outputFile);
  24. }

  复制代码
  impl
  1. package com.thyc.reportserver.service.impl;
  3. import com.thyc.reportserver.service.ExcelService;
  4. import com.thyc.reportserver.utils.ExcelUtils;
  5. import javax.servlet.http.HttpServletResponse;
  6. import org.slf4j.Logger;
  7. import org.slf4j.LoggerFactory;
  8. import org.springframework.beans.factory.annotation.Value;
  9. import org.springframework.stereotype.Service;
  10. import org.springframework.util.ResourceUtils;
  12. import java.io.*;
  13. import java.util.Map;
  15. /**
  16. * @Description: TODO
  17. * @Author: wanping
  18. * @Date: 6/13/23
  19. **/
  20. @Service
  21. public class ExcelServiceImpl implements ExcelService {
  23.     private Logger logger = LoggerFactory.getLogger(getClass());
  25.     /**
  26.      * 模板文件的基础路径
  27.      */
  28.     @Value("${jxls.template.path}")
  29.     private String templatePath;
  31.     @Override
  32.     public boolean getExcel(String templateFile, Map<String, Object> params, File outputFile) {
  33.         FileInputStream inputStream = null;
  34.         try {
  35.             //获取模板文件的输入流
  36.             inputStream = new FileInputStream(ResourceUtils.getFile(templatePath + templateFile));
  37.             File dFile = outputFile.getParentFile();
  38.             //文件夹不存在时创建文件夹
  39.             if(dFile.isDirectory()){
  40.                 if(!dFile.exists()){
  41.                     dFile.mkdir();
  42.                 }
  43.             }
  44.             //文件不存在时创建文件
  45.             if(!outputFile.exists()){
  46.                 outputFile.createNewFile();
  47.             }
  48.             //导出excel文件
  49.             ExcelUtils.exportExcel(inputStream, params, new FileOutputStream(outputFile));
  50.         } catch (IOException e) {
  51.             logger.error("excel export has error" + e);
  52.             return false;
  53.         }
  54.         return true;
  55.     }
  56. }

  复制代码
  编写测试用例
  1. package com.thyc.reportserver;
  3. import com.thyc.reportserver.excelModel.UserModel;
  4. import com.thyc.reportserver.service.ExcelService;
  5. import org.junit.jupiter.api.Test;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.boot.test.context.SpringBootTest;
  9. import java.io.File;
  10. import java.util.*;
  12. @SpringBootTest
  13. class ReportServerApplicationTests {
  15.     @Autowired
  16.     ExcelService excelService;
  18.     @Test
  19.     void contextLoads() {
  20.         Map<String, Object> params = new HashMap();
  21.         List<UserModel> list = new ArrayList<>();
  22.         for (int i = 0; i < 10; i++) {
  23.             int i1 = i + 1;
  24.             list.add(new UserModel(i1, "test" + i1, "男", 25 + i, "tttttttttt" + i1, new Date(), "htpp://wwww.baidu.com"));
  25.         }
  26.         params.put("list", list);
  27.         excelService.getExcel("user1.xlsx", params, new File("/Users/wanping/IdeaProjects/ddd/report-server/excel/test01.xlsx"));
  28.     }
  30. }

  复制代码
  
  
  • 结果展示
    
  导入模版
  
  

结果

参考：https://www.jb51.net/article/195015.htm

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！