JAVA实现导出excel功能,封装通用导出工具类
Posted pxblog
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了JAVA实现导出excel功能,封装通用导出工具类相关的知识,希望对你有一定的参考价值。
引入maven
<!--excel导出--> <dependency> <groupId>net.sourceforge.jexcelapi</groupId> <artifactId>jxl</artifactId> <version>2.6.12</version> </dependency> <!--工具包--> <dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>[4.1.12,)</version> </dependency> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> </dependency> <!--lombok插件--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency>
导出excel工具类
ExcelUtils.java
package com.test.cms.excel; import cn.hutool.core.util.ObjectUtil; import jxl.Workbook; import jxl.write.Label; import jxl.write.WritableSheet; import jxl.write.WritableWorkbook; import javax.servlet.http.HttpServletResponse; import java.io.OutputStream; import java.lang.reflect.Field; import java.text.SimpleDateFormat; import java.util.*; import java.util.Map.Entry; public class ExcelUtils { /** * @param list 数据源 * @param fieldMap 类的英文属性和Excel中的中文列名的对应关系 * @param sheetName 工作表的名称 * @param sheetSize 每个工作表中记录的最大个数 * @param out 导出流 * @throws Exception * @MethodName : listToExcel * @Description : 导出Excel(可以导出到本地文件系统,也可以导出到浏览器,可自定义工作表大小) */ public static <T> void listToExcel( List<T> list, LinkedHashMap<String, String> fieldMap, String sheetName, int sheetSize, OutputStream out ) throws Exception { if (list == null || list.size() == 0) { throw new Exception("数据源中没有任何数据"); } if (sheetSize > 65535 || sheetSize < 1) { sheetSize = 65535; } //创建工作簿并发送到OutputStream指定的地方 WritableWorkbook wwb; try { wwb = Workbook.createWorkbook(out); //因为2003的Excel一个工作表最多可以有65536条记录,除去列头剩下65535条 //所以如果记录太多,需要放到多个工作表中,其实就是个分页的过程 //1.计算一共有多少个工作表 double sheetNum = Math.ceil(list.size() / new Integer(sheetSize).doubleValue()); //2.创建相应的工作表,并向其中填充数据 for (int i = 0; i < sheetNum; i++) { //如果只有一个工作表的情况 if (1 == sheetNum) { WritableSheet sheet = wwb.createSheet(sheetName, i); fillSheet(sheet, list, fieldMap, 0, list.size() - 1); //有多个工作表的情况 } else { WritableSheet sheet = wwb.createSheet(sheetName + (i + 1), i); //获取开始索引和结束索引 int firstIndex = i * sheetSize; int lastIndex = (i + 1) * sheetSize - 1 > list.size() - 1 ? list.size() - 1 : (i + 1) * sheetSize - 1; //填充工作表 fillSheet(sheet, list, fieldMap, firstIndex, lastIndex); } } wwb.write(); wwb.close(); } catch (Exception e) { e.printStackTrace(); //如果是Exception,则直接抛出 if (e instanceof Exception) { throw (Exception) e; //否则将其它异常包装成Exception再抛出 } else { throw new Exception("导出Excel失败"); } } } /** * @param list 数据源 * @param fieldMap 类的英文属性和Excel中的中文列名的对应关系 * @param sheetSize 每个工作表中记录的最大个数 * @param response 使用response可以导出到浏览器 * @throws Exception * @MethodName : listToExcel * @Description : 导出Excel(导出到浏览器,可以自定义工作表的大小) */ public static <T> void listToExcel( List<T> list, LinkedHashMap<String, String> fieldMap, String sheetName, int sheetSize, HttpServletResponse response ) throws Exception { //设置默认文件名为当前时间:年月日时分秒 String fileName = new SimpleDateFormat("yyyyMMddhhmmss").format(new Date()).toString(); //设置response头信息 response.reset(); response.setContentType("application/vnd.ms-excel"); //改成输出excel文件 response.setHeader("Content-disposition", "attachment; filename=" + new String(sheetName.getBytes(), "iso-8859-1") + ".xls"); //创建工作簿并发送到浏览器 try { OutputStream out = response.getOutputStream(); listToExcel(list, fieldMap, sheetName, sheetSize, out); } catch (Exception e) { e.printStackTrace(); //如果是Exception,则直接抛出 if (e instanceof Exception) { throw (Exception) e; //否则将其它异常包装成Exception再抛出 } else { throw new Exception("导出Excel失败"); } } } /** * @param list 数据源 * @param fieldMap 类的英文属性和Excel中的中文列名的对应关系 * @param response 使用response可以导出到浏览器 * @throws Exception * @MethodName : listToExcel * @Description : 导出Excel(导出到浏览器,工作表的大小是2003支持的最大值) */ public static <T> void listToExcel( List<T> list, LinkedHashMap<String, String> fieldMap, String sheetName, HttpServletResponse response ) throws Exception { listToExcel(list, fieldMap, sheetName, 65535, response); } /** * @param fieldName 字段名 * @param o 对象 * @return 字段值 * @MethodName : getFieldValueByName * @Description : 根据字段名获取字段值 */ private static Object getFieldValueByName(String fieldName, Object o) throws Exception { Object value = null; Field field = getFieldByName(fieldName, o.getClass()); if (field != null) { field.setAccessible(true); value = field.get(o); } else { throw new Exception(o.getClass().getSimpleName() + "类不存在字段名 " + fieldName); } return value; } /** * @param fieldName 字段名 * @param clazz 包含该字段的类 * @return 字段 * @MethodName : getFieldByName * @Description : 根据字段名获取字段 */ private static Field getFieldByName(String fieldName, Class<?> clazz) { //拿到本类的所有字段 Field[] selfFields = clazz.getDeclaredFields(); //如果本类中存在该字段,则返回 for (Field field : selfFields) { if (field.getName().equals(fieldName)) { return field; } } //否则,查看父类中是否存在此字段,如果有则返回 Class<?> superClazz = clazz.getSuperclass(); if (superClazz != null && superClazz != Object.class) { return getFieldByName(fieldName, superClazz); } //如果本类和父类都没有,则返回空 return null; } /** * @param fieldNameSequence 带路径的属性名或简单属性名 * @param o 对象 * @return 属性值 * @throws Exception * @MethodName : getFieldValueByNameSequence * @Description : * 根据带路径或不带路径的属性名获取属性值 * 即接受简单属性名,如userName等,又接受带路径的属性名,如student.department.name等 */ private static Object getFieldValueByNameSequence(String fieldNameSequence, Object o) throws Exception { Object value = null; //将fieldNameSequence进行拆分 String[] attributes = fieldNameSequence.split("\\."); if (attributes.length == 1) { value = getFieldValueByName(fieldNameSequence, o); } else { //根据属性名获取属性对象 Object fieldObj = getFieldValueByName(attributes[0], o); String subFieldNameSequence = fieldNameSequence.substring(fieldNameSequence.indexOf(".") + 1); value = getFieldValueByNameSequence(subFieldNameSequence, fieldObj); } return value; } /** * @param ws * @MethodName : setColumnAutoSize * @Description : 设置工作表自动列宽和首行加粗 */ private static void setColumnAutoSize(WritableSheet ws, int extraWith) { //获取本列的最宽单元格的宽度 for (int i = 0; i < ws.getColumns(); i++) { int colWith = 0; for (int j = 0; j < ws.getRows(); j++) { String content = ws.getCell(i, j).getContents().toString(); int cellWith = content.length(); if (colWith < cellWith) { colWith = cellWith; } } //设置单元格的宽度为最宽宽度+额外宽度 ws.setColumnView(i, colWith + extraWith); } } /** * @param sheet 工作表 * @param list 数据源 * @param fieldMap 中英文字段对应关系的Map * @param firstIndex 开始索引 * @param lastIndex 结束索引 * @MethodName : fillSheet * @Description : 向工作表中填充数据 */ private static <T> void fillSheet( WritableSheet sheet, List<T> list, LinkedHashMap<String, String> fieldMap, int firstIndex, int lastIndex ) throws Exception { //定义存放英文字段名和中文字段名的数组 String[] enFields = new String[fieldMap.size()]; String[] cnFields = new String[fieldMap.size()]; //填充数组 int count = 0; for (Entry<String, String> entry : fieldMap.entrySet()) { enFields[count] = entry.getKey(); cnFields[count] = entry.getValue(); count++; } //填充表头 for (int i = 0; i < cnFields.length; i++) { Label label = new Label(i, 0, cnFields[i]); sheet.addCell(label); } //填充内容 int rowNo = 1; for (int index = firstIndex; index <= lastIndex; index++) { //获取单个对象 T item = list.get(index); for (int i = 0; i < enFields.length; i++) { Object objValue = getFieldValueByNameSequence(enFields[i], item); if (objValue instanceof Date) { objValue = date2Str((Date) objValue, "yyyy-MM-dd HH:mm:ss"); } String fieldValue = (objValue == null) ? "" : objValue.toString(); Label label = new Label(i, rowNo, fieldValue); sheet.addCell(label); } rowNo++; } //设置自动列宽 setColumnAutoSize(sheet, 5); } public static String date2Str(Date date, String formats) { return ObjectUtil.isEmpty(date) ? null : (new SimpleDateFormat(formats)).format(date); } }
测试导出的实体类
ExcelDTO.java
package com.test.cms.excel; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; import lombok.experimental.Accessors; @Data @Accessors(chain = true) @AllArgsConstructor @NoArgsConstructor public class ExcelDTO { private String name; private String operator; }
导出控制器类
ExcelController.java
package com.test.cms.controller; import com.test.cms.excel.ExcelDTO; import com.test.cms.excel.ExcelUtils; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import javax.servlet.http.HttpServletResponse; import java.util.ArrayList; import java.util.LinkedHashMap; import java.util.List; @RestController public class ExcelController { @RequestMapping("/excel/export") public void test(HttpServletResponse response){ List<ExcelDTO> records = new ArrayList(); //添加测试数据 for (int i=0;i<10;i++){ ExcelDTO dto=new ExcelDTO("name"+i,"operator"+i); records.add(dto); } LinkedHashMap<String, String> titleMap = getTitleMap(); try { ExcelUtils.listToExcel(records, titleMap, "文档名称", response); } catch (Exception e) { e.printStackTrace(); } } /** * d导出标题栏 * * @return */ private static LinkedHashMap<String, String> getTitleMap() { LinkedHashMap<String, String> names = new LinkedHashMap<String, String>(); //name和operator是ExcelDTO实体类的属性名,姓名表示name列表头显示的名称 names.put("name", "姓名"); names.put("operator", "操作人"); return names; } }
导出数据效果
以上是关于JAVA实现导出excel功能,封装通用导出工具类的主要内容,如果未能解决你的问题,请参考以下文章