先说说优化前,怎么做EXCEL导出功能的:
1. 先定义一个VO类,类中的字段按照EXCEL的顺序定义,并且该类只能用于EXCEL导出使用,不能随便修改。
2. 将查询到的结果集循环写入到这个VO类中。
3. 将这个VO类的数据集写入到EXCEL中。
缺点:
1.每次做一个功能的excel导出需要定义一个vo类,并且vo类不可随便变更。
2. 从数据库查询到结果集不能直接输出到excel,需要二次遍历写入到vo中。
3. excel导出的顺序必须与vo定义的字段顺序一致,并且输出vo中所有的字段。
针对以上情况做了一次改进:
1. 去掉每次导出都必须定义vo类
2. 直接从数据库获取数据集来写入到excel中
3. 可以自己指定要导出的字段
如何实现呢:
1. 查询要使用的结果集,比如产品的列表信息放到list中。
List<TProduct> list = productService.getProductExpiredList(vo);
2.定一个2个字符串,分别为字段和字段名,这两个来自于查询的结果集的对象中。如下
String colName = "RR商品编码,规格型号,商品名称,单位,产品类别,批准文号,有效期,备注"; String columnFieldStr = "ptCode,ptRuleModel,ptName,um.umUm1,proType.typeName,ptPemissionNO,ptExpiryDate,ptRemark";
3. 调用自定义的工具类
ExcelUtil excel = new ExcelUtil(); excel.exportExcelNew("商品许可到期报表", colName, columnFieldStr, list, response);
这个ExcelUtil是自己封装的一个工具类,重点来了,我们定义的字段的名,可以通过反射的原理来获取对象中的值。
所以下面重点介绍下怎么解析columnFieldStr来获取值。
//拿到字段的字符串,先转为数组 String[] columnFields = columnFieldStr.split(","); //中间省略部分代码 ... ... //迭代器来获取list中的对象,由于ExcelUtil是一个工具类,所以不指定具体的对象,使用泛型T表示,更具有通用性 Iterator<T> it = list.iterator();while (it.hasNext()) { T t = (T) it.next(); //获取list中对象 //遍历指定的字段数组 for (short i = 0; i < columnFields.length; i++) { String fieldName = columnFields[i]; //获取字段名 //使用自定义的getValue方法获取值 //这个getValue其实是一个递归方法, //参数t为对象,fieldName为我们写的要输出的字段 Object value = getValue(t,fieldName); //拿到value值后写入到excel中,这里省略部分代码.... } //for } //while
重点中的重点:getValue方法的解析
对于一般的类中的标准类型,可以直接通过Field反射来获取值,但是注意到我们的指定的字段中有um.umUml和proType.typeName这个两个字段。
um和proType属于对象T中的一个属性,本身也是一个类对象,所以我们需要使用递归方法来获取对象属性中的类的对象的值, 有点绕口。
所以下面代码中加了(.)点号判断,如果指定的字段带有点号,需要做进一步的解析来获取值。这个有点类似于springmvc中的包装对象的参数绑定。
如例子中的对象TProduct中的部分属性如下,所以我们要获取单位的名称,定义字段时则为um.umUm1,后面的umUm1为类Um中的属性。
@Entity @Table(name="T_PRODUCT") public class TProduct extends BaseDomain { /** * 单位 * null */ @Column(name="UM_ID") private String umId; @ManyToOne @JoinColumn(name="UM_ID",insertable=false,updatable=false) private TUm um; /** * 类别 * null */ @Column(name="PT_TYPE") private String ptType; @ManyToOne @JoinColumn(name="PT_TYPE",insertable=false,updatable=false) private TProType proType; //省略部分代码......
getValue完整方法如下:
//递归调用,获取多层包装类中的值 private Object getValue(Object obj,String colField) throws NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException, ClassNotFoundException { Object value = null; if(colField.indexOf(".") > 0){ String fieldName = colField.substring(0,colField.indexOf(".")); Field field = obj.getClass().getDeclaredField(fieldName); Class<?> clazz = Class.forName(field.getType().getName()); field.setAccessible(true); Object fieldObj = field.get(obj); String nextField = colField.substring(colField.indexOf(".")+1); value = getValue(fieldObj,nextField); } else { Field field = obj.getClass().getDeclaredField(colField); field.setAccessible(true); value = field.get(obj); } return value; }
最后放上完整的ExcelUtil工具类代码供参考:
public class ExcelUtil<T> { /** * 新的EXCEL输出工具类 * * @param fileName * @param columnNameStr * 指定输出的字段名,逗号分开 * @param columnFieldStr * 指定输出的字段,逗号分开 * @param dataList * @param response * @throws IOException * @throws ClassNotFoundException * @throws NoSuchFieldException */ public void exportExcelNew(String fileName, String columnNameStr,String columnFieldStr, List<T> dataList,HttpServletResponse response) throws Exception { String[] columnNames = URLDecoder.decode(columnNameStr, "UTF-8").split(","); String[] columnFields = columnFieldStr.split(","); SimpleDateFormat sdf = new SimpleDateFormat("yyyyMMddhhmmss"); String pattern = sdf.format(new Date()); // 声明一个工作薄 HSSFWorkbook workbook = new HSSFWorkbook(); // 生成一个表格 HSSFSheet sheet = workbook.createSheet(fileName + pattern); // 设置表格默认列宽度为15个字节 sheet.setDefaultColumnWidth((short) 15); // 生成一个样式 HSSFCellStyle style = workbook.createCellStyle(); // 设置这些样式 // style.setFillForegroundColor(HSSFColor.SKY_BLUE.index); //设置前景色 // style.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND); style.setBorderBottom(HSSFCellStyle.BORDER_THIN); style.setBorderLeft(HSSFCellStyle.BORDER_THIN); style.setBorderRight(HSSFCellStyle.BORDER_THIN); style.setBorderTop(HSSFCellStyle.BORDER_THIN); style.setAlignment(HSSFCellStyle.ALIGN_CENTER); // 生成一个字体 HSSFFont font = workbook.createFont(); // font.setColor(HSSFColor.VIOLET.index); font.setFontHeightInPoints((short) 10); font.setBoldweight(HSSFFont.BOLDWEIGHT_BOLD); // 把字体应用到当前的样式 style.setFont(font); // 生成并设置另一个样式 HSSFCellStyle style2 = workbook.createCellStyle(); // style2.setFillForegroundColor(HSSFColor.LIGHT_YELLOW.index); //生成前景色 // style2.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND); style2.setBorderBottom(HSSFCellStyle.BORDER_THIN); style2.setBorderLeft(HSSFCellStyle.BORDER_THIN); style2.setBorderRight(HSSFCellStyle.BORDER_THIN); style2.setBorderTop(HSSFCellStyle.BORDER_THIN); style2.setAlignment(HSSFCellStyle.ALIGN_LEFT); style2.setVerticalAlignment(HSSFCellStyle.VERTICAL_CENTER); // 生成另一个字体 HSSFFont font2 = workbook.createFont(); font2.setBoldweight(HSSFFont.BOLDWEIGHT_NORMAL); font2.setFontName("宋体"); // 设置字体 font2.setFontHeightInPoints((short) 10); // 设置字体大小 // 把字体应用到当前的样式 style2.setFont(font2); // 声明一个画图的顶级管理器 HSSFPatriarch patriarch = sheet.createDrawingPatriarch(); // 定义注释的大小和位置,详见文档 // HSSFComment comment = patriarch.createComment(new // HSSFClientAnchor(0,0, 0, 0, (short) 4, 2, (short) 6, 5)); // 设置注释内容 // comment.setString(new HSSFRichTextString("可以在POI中添加注释!")); // 设置注释作者,当鼠标移动到单元格上是可以在状态栏中看到该内容. // comment.setAuthor("leno"); // 产生表格标题行 HSSFRow row = sheet.createRow(0); for (short i = 0; i < columnNames.length; i++) { HSSFCell cell = row.createCell(i); cell.setCellStyle(style); HSSFRichTextString text = new HSSFRichTextString(columnNames[i]); cell.setCellValue(text); } // 遍历集合数据,产生数据行 Iterator<T> it = dataList.iterator(); int index = 0; // HSSFFont font3 = workbook.createFont(); while (it.hasNext()) { index++; row = sheet.createRow(index); T t = (T) it.next(); for (short i = 0; i < columnFields.length; i++) { HSSFCell cell = row.createCell(i); cell.setCellStyle(style2); String fieldName = columnFields[i]; try { Object value = getValue(t, fieldName); // 判断值的类型后进行强制类型转换 String textValue = null; if (value instanceof String) { textValue = value.toString(); } else if (value instanceof Integer) { textValue = value.toString(); } else if (value instanceof BigInteger) { textValue = value.toString(); } else if (value instanceof Float) { textValue = value.toString(); } else if (value instanceof Double) { textValue = value.toString(); } else if (value instanceof Long) { textValue = value.toString(); } else if (value instanceof BigDecimal) { textValue = value.toString(); } else if (value instanceof Boolean) { boolean bValue = (Boolean) value; textValue = "是"; if (!bValue) { textValue = "否"; } } else if (value instanceof Date) { Date date = (Date) value; SimpleDateFormat sdf2 = new SimpleDateFormat( "yyyy-MM-dd HH:mm:ss"); textValue = sdf2.format(date); } else if (value instanceof byte[]) { // 有图片时,设置行高为60px; row.setHeightInPoints(60); // 设置图片所在列宽度为80px,注意这里单位的一个换算 sheet.setColumnWidth(i, (short) (35.7 * 80)); // sheet.autoSizeColumn(i); byte[] bsValue = (byte[]) value; HSSFClientAnchor anchor = new HSSFClientAnchor(0, 0, 1023, 255, (short) 6, index, (short) 6, index); anchor.setAnchorType(2); patriarch.createPicture(anchor, workbook.addPicture( bsValue, HSSFWorkbook.PICTURE_TYPE_JPEG)); } else { // 其它数据类型都当作字符串简单处理 if (value != null) { textValue = value.toString(); } } // 如果不是图片数据,就利用正则表达式判断textValue是否全部由数字组成 if (textValue != null) { Pattern p = Pattern.compile("^//d+(//.//d+)?{1}quot"); Matcher matcher = p.matcher(textValue); if (matcher.matches()) { // 是数字当作double处理 cell.setCellValue(Double.parseDouble(textValue)); } else { HSSFRichTextString richString = new HSSFRichTextString(textValue); // font3.setColor(HSSFColor.BLUE.index); // richString.applyFont(font3); cell.setCellValue(richString); } } } catch (SecurityException e) { e.printStackTrace(); } catch (IllegalArgumentException e) { e.printStackTrace(); } catch (IllegalAccessException e) { e.printStackTrace(); } finally { // 清理资源 } } } // 输出流 OutputStream out = null; try { response.setContentType("application/vnd.ms-excel; charset=utf-8"); response.setHeader("Content-Disposition", "attachment;filename="+ java.net.URLEncoder.encode(fileName + ".xls", "UTF-8")); response.setCharacterEncoding("utf-8"); out = response.getOutputStream(); workbook.write(out); } catch (IOException e) { e.printStackTrace(); } finally { out.flush(); out.close(); } } // 递归调用,获取多层包装类中的值 private Object getValue(Object obj, String colField) throws NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException, ClassNotFoundException { Object value = null; if (colField.indexOf(".") > 0) { String fieldName = colField.substring(0, colField.indexOf(".")); Field field = obj.getClass().getDeclaredField(fieldName); Class<?> clazz = Class.forName(field.getType().getName()); field.setAccessible(true); Object fieldObj = field.get(obj); String nextField = colField.substring(colField.indexOf(".") + 1); value = getValue(fieldObj, nextField); } else { Field field = obj.getClass().getDeclaredField(colField); field.setAccessible(true); value = field.get(obj); } return value; }
使用excel导出功能完整例子如下,直接在controller中完成,代码很简洁:
@RequestMapping(value="/exportProductExpiredReport",method=RequestMethod.POST) public void exportProductExpiredReport(ProductVo vo,HttpServletResponse response) throws Exception{ List<TProduct> list = productService.getProductExpiredList(vo); String colName = "RR商品编码,规格型号,商品名称,单位,产品类别,批准文号,有效期,备注"; String columnFieldStr = "ptCode,ptRuleModel,ptName,um.umUm1,proType.typeName,ptPemissionNO,ptExpiryDate,ptRemark"; ExcelUtil excel = new ExcelUtil(); excel.exportExcelNew("商品许可到期报表", colName, columnFieldStr, list, response); }
今天七夕,祝天下有情人终成眷属。