本工具类经过PostMan和web页面严格测试可用,经过了多个版本迭代优化,可以直接使用,也方便大家根据自己的业务需求,修改定制自己的导出工具。
市面上有很多封装好的导出工具(如:阿里的easyExcel,GitHub上xxl-excel等),但如果直接引用依赖,扩展性和定制性比较差,所以博主通过apache.poi
,自己实现一款Excel导出工具,方便定制使用。本工具类支持SpringMVC等主流的Java框架,支持RESTful接口,代码全部通过测试。
注: 此代码可直接在项目中使用。
package com.excel.util;
import java.io.IOException;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.net.URLEncoder;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import org.apache.poi.ss.usermodel.BorderStyle;
import org.apache.poi.ss.usermodel.HorizontalAlignment;
import org.apache.poi.ss.util.CellRangeAddress;
import org.apache.poi.xssf.usermodel.XSSFCell;
import org.apache.poi.xssf.usermodel.XSSFCellStyle;
import org.apache.poi.xssf.usermodel.XSSFColor;
import org.apache.poi.xssf.usermodel.XSSFFont;
import org.apache.poi.xssf.usermodel.XSSFRichTextString;
import org.apache.poi.xssf.usermodel.XSSFRow;
import org.apache.poi.xssf.usermodel.XSSFSheet;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
/**
* 导出Excel工具类
*
* @author 大脑补丁
*
*/
public class ExportExcelUtil {
/**
* 导出多Sheet的Excel到HttpServletResponse流中
*
* @param fileName
* 另存为文件名
* @param sheetNames
* 工作簿中的多张Sheet工作表的名称列表
* @param titleName
* 表格的标题名称(没有标题,则传null)
* @param headers
* 表头列表
* @param dataList
* 要导出的数据源
* @param HttpServletResponse
* Http响应
* @param pattern
* 时间类型数据的格式,默认UTC格式
* @param isExportNullField
* 空字段是否导出(true:导出,false:不导出)
* @see 导出Excel格式:表头内容居中,字体略大于正文,颜色深灰色。正文文本类型对齐方式居左,数字类型对齐方式居右。仅有数据* 的单元格,有边框环绕,实体类的属性顺序即为表头顺序
*/
public static void exportExcel(String fileName, List sheetNames, String titleName, List headers,
List> dataLists, HttpServletResponse response, String pattern, boolean isExportNullField) {
XSSFWorkbook wb = exportAllExcel(sheetNames, titleName, headers, dataLists, pattern, isExportNullField);
setResponseHeader(response, replaceSpecStr(fileName));
ServletOutputStream out = null;
try {
out = response.getOutputStream();
wb.write(out);
} catch (IOException e) {
e.printStackTrace();
} finally {
try {
out.flush();
out.close();
wb.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
/**
* 导出多Sheet动态列的Excel到HttpServletResponse流中
*
* @param fileName
* 另存为文件名
* @param sheetName
* 工作簿中的多张Sheet工作表的名称列表
* @param titleName
* 表格的标题名称(没有标题,则传null)
* @param headers
* 表头列表
* @param dataList
* 要导出的数据源
* @param HttpServletResponse
* Http响应
* @param pattern
* 时间类型数据的格式,默认UTC格式
* @param isExportNullField
* 空字段是否导出(true:导出,false:不导出)
*/
public static void exportDynamicExcel(String fileName, List sheetNames, String titleName,
List headers, List>> dataLists, HttpServletResponse response,
String pattern, boolean isExportNullField) {
XSSFWorkbook wb = exportDynamicExcelImpl(sheetNames, titleName, headers, dataLists, pattern, isExportNullField);
setResponseHeader(response, replaceSpecStr(fileName));
ServletOutputStream out = null;
try {
out = response.getOutputStream();
wb.write(out);
} catch (IOException e) {
e.printStackTrace();
} finally {
try {
out.flush();
out.close();
wb.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
/**
* 设置响应的类型、编码和文件名称
*
* @param response
* @param fileName
*/
public static void setResponseHeader(HttpServletResponse response, String fileName) {
try {
response.reset();
response.setContentType("application/msexcel");// 设置生成的文件类型
response.setCharacterEncoding("UTF-8");// 设置文件头编码方式和文件名
// 在浏览器中测试生效,postman中文件名为response,无法修改
response.setHeader("Content-disposition", "attachment;filename="
.concat(String.valueOf(URLEncoder.encode(replaceSpecStr(fileName) + ".xlsx", "UTF-8"))));
// 此设置,可保证web端可以取到文件名
response.setHeader("Access-Control-Expose-Headers", "Content-Disposition");
} catch (Exception ex) {
ex.printStackTrace();
}
}
/**
* 设置响应的类型、编码和文件名称
*
* @param response
* @param fileName
*/
public static void setResponseHeader(HttpServletResponse response, String fileName, boolean urlEncode) {
try {
String downloadName = urlEncode == true
? String.valueOf(URLEncoder.encode(replaceSpecStr(fileName) + ".xlsx", "UTF-8"))
: String.valueOf(replaceSpecStr(fileName) + ".xlsx");
response.reset();
response.setContentType("application/msexcel");// 设置生成的文件类型
response.setCharacterEncoding("UTF-8");// 设置文件头编码方式和文件名
// 在浏览器中测试生效,postman中文件名为response,无法修改
response.setHeader("Content-Disposition", "attachment;filename=".concat(downloadName));
response.setHeader("Access-Control-Expose-Headers", "Content-Disposition");
} catch (Exception ex) {
ex.printStackTrace();
}
}
/**
* 多Sheet导出实现
*
* @param sheetNames
* @param titleName
* @param headers
* @param dataLists
* @param pattern
* @param isExportNullField
* @return
*/
private static XSSFWorkbook exportAllExcel(List sheetNames, String titleName, List headers,
List> dataLists, String pattern, boolean isExportNullField) {
// 创建一个工作薄
XSSFWorkbook workbook = new XSSFWorkbook();
for (int i = 0; i < dataLists.size(); i++) {
// 创建一个工作表
XSSFSheet sheet = workbook.createSheet(replaceSpecStr(sheetNames.get(i)));
// 设置单元格列宽度为16个字节
sheet.setDefaultColumnWidth((short) 16);
// 创建表头样式
XSSFCellStyle headersStyle = workbook.createCellStyle();
headersStyle.setBorderTop(BorderStyle.THIN);
headersStyle.setBorderBottom(BorderStyle.THIN);
headersStyle.setBorderLeft(BorderStyle.THIN);
headersStyle.setBorderRight(BorderStyle.THIN);
// 表头内容对齐方式:居中
headersStyle.setAlignment(HorizontalAlignment.CENTER);
XSSFFont headersFont = workbook.createFont();
// 设置字体格式
headersFont.setColor(new XSSFColor(java.awt.Color.DARK_GRAY));
headersFont.setFontHeightInPoints((short) 14);
// 表头样式应用生效
headersStyle.setFont(headersFont);
XSSFCellStyle dataSetStyle = workbook.createCellStyle();
// 正文单元格边框样式
dataSetStyle.setBorderBottom(BorderStyle.THIN);
dataSetStyle.setBorderRight(BorderStyle.THIN);
dataSetStyle.setBorderLeft(BorderStyle.THIN);
// 数据内容对齐方式:居左
// dataSetStyle.setAlignment(HorizontalAlignment.CENTER_SELECTION);
XSSFFont dataSetFont = workbook.createFont();
// 正文字体颜色
dataSetFont.setColor(new XSSFColor(java.awt.Color.BLACK));
// 为正文设置样式
dataSetStyle.setFont(dataSetFont);
if (titleName != null && titleName != "") {
XSSFCellStyle titleStyle = workbook.createCellStyle();
// 将首行合并居中作为标题栏
sheet.addMergedRegion(new CellRangeAddress(0, 0, 0, headers.size() - 1));
XSSFFont titleFont = workbook.createFont();
// 设置标题字体大小
titleFont.setFontHeightInPoints((short) 20);
// 设置标题字体样式
titleStyle.setFont(titleFont);
// 创建标题行并设置样式
XSSFRow titleRow = sheet.createRow(0);
XSSFCell titleCell = titleRow.createCell(0);
titleCell.setCellStyle(titleStyle);
titleCell.setCellValue(titleName);
}
int index = titleName == null || titleName.equals("") ? 0 : 1;
// 创建表头并设置样式
XSSFRow row = sheet.createRow(index);
for (short j = 0; j < headers.size(); j++) {
XSSFCell cell = row.createCell(j);
cell.setCellStyle(headersStyle);
XSSFRichTextString text = new XSSFRichTextString(headers.get(j));
cell.setCellValue(text);
}
// 导出正文数据,并设置其样式
Iterator> it = dataLists.get(i).iterator();
while (it.hasNext()) {
index++;
row = sheet.createRow(index);
Object entity = it.next();
// 利用反射,根据实体类属性的先后顺序,动态调用其getXxx()方法,得到属性值
Field[] fields = entity.getClass().getDeclaredFields();
for (short k = 0; k < fields.length; k++) {
XSSFCell cell = row.createCell(k);
Field field = fields[k];
String fieldName = field.getName();
String getMethodName = "get" + fieldName.substring(0, 1).toUpperCase() + fieldName.substring(1);
try {
@SuppressWarnings("rawtypes")
Class entityClass = entity.getClass();
@SuppressWarnings("unchecked")
Method getMethod = entityClass.getMethod(getMethodName, new Class[] {});
Object value = getMethod.invoke(entity, new Object[] {});
String textValue = null;
// 如果是时间类型,格式化
if (value instanceof Date) {
Date date = (Date) value;
pattern = pattern == null || pattern.equals("") ? "yyyy-MM-dd'T'HH:mm:ss'Z'" : pattern;
SimpleDateFormat sdf = new SimpleDateFormat(pattern);
textValue = sdf.format(date);
} else {
// 若字段为空且允许导出空字段,则将null导出为""
textValue = value == null && isExportNullField ? "" : value.toString();
}
if (!textValue.equals("")) {
// 有数据时边框环绕
cell.setCellStyle(dataSetStyle);
// 正则判断是否为数值
Pattern p = Pattern.compile("^\\d+(\\.\\d+)?$");
Matcher matcher = p.matcher(textValue);
if (matcher.matches()) {
// 是数字当作double处理,整型也不会补充小数点
cell.setCellValue(Double.parseDouble(textValue));
} else {
// 不是数字类型作为文本输出
cell.setCellValue(textValue);
}
}
} catch (SecurityException e) {
e.printStackTrace();
} catch (NoSuchMethodException e) {
e.printStackTrace();
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
}
}
}
}
return workbook;
}
/**
* 多Sheet导出动态列到Excel实现
*
* @param sheetNames
* @param titleName
* @param headers
* @param dataLists
* @param pattern
* 时间格式
* @param isExportNullField
* 是否导出空字段
* @return
*/
private static XSSFWorkbook exportDynamicExcelImpl(List sheetNames, String titleName, List headers,
List>> dataLists, String pattern, boolean isExportNullField) {
// 创建一个工作薄
XSSFWorkbook workbook = new XSSFWorkbook();
for (int i = 0; i < dataLists.size(); i++) {
// 创建一个工作表
XSSFSheet sheet = workbook.createSheet(replaceSpecStr(sheetNames.get(i)));
// 设置单元格列宽度为16个字节
sheet.setDefaultColumnWidth((short) 16);
// 创建表头样式
XSSFCellStyle headersStyle = workbook.createCellStyle();
headersStyle.setBorderTop(BorderStyle.THIN);
headersStyle.setBorderBottom(BorderStyle.THIN);
headersStyle.setBorderLeft(BorderStyle.THIN);
headersStyle.setBorderRight(BorderStyle.THIN);
// 表头内容对齐方式:居中
headersStyle.setAlignment(HorizontalAlignment.CENTER);
XSSFFont headersFont = workbook.createFont();
// 设置字体格式
headersFont.setColor(new XSSFColor(java.awt.Color.DARK_GRAY));
headersFont.setFontHeightInPoints((short) 12);
// 表头样式应用生效
headersStyle.setFont(headersFont);
// 设置单元格内内容换行
headersStyle.setWrapText(true);
XSSFCellStyle dataSetStyle = workbook.createCellStyle();
// 正文单元格边框样式
dataSetStyle.setBorderBottom(BorderStyle.THIN);
dataSetStyle.setBorderRight(BorderStyle.THIN);
dataSetStyle.setBorderLeft(BorderStyle.THIN);
// 数据内容对齐方式:居左
// dataSetStyle.setAlignment(HorizontalAlignment.CENTER_SELECTION);
XSSFFont dataSetFont = workbook.createFont();
// 正文字体颜色
dataSetFont.setColor(new XSSFColor(java.awt.Color.BLACK));
// 为正文设置样式
dataSetStyle.setFont(dataSetFont);
if (titleName != null && titleName != "") {
XSSFCellStyle titleStyle = workbook.createCellStyle();
// 将首行合并居中作为标题栏
sheet.addMergedRegion(new CellRangeAddress(0, 0, 0, headers.size() - 1));
XSSFFont titleFont = workbook.createFont();
// 设置标题字体大小
titleFont.setFontHeightInPoints((short) 20);
// 设置标题字体样式
titleStyle.setFont(titleFont);
// 创建标题行并设置样式
XSSFRow titleRow = sheet.createRow(0);
XSSFCell titleCell = titleRow.createCell(0);
titleCell.setCellStyle(titleStyle);
titleCell.setCellValue(titleName);
}
int index = titleName == null || titleName.equals("") ? 0 : 1;
// 创建表头并设置样式
XSSFRow row = sheet.createRow(index);
for (short j = 0; j < headers.size(); j++) {
XSSFCell cell = row.createCell(j);
cell.setCellStyle(headersStyle);
XSSFRichTextString text = new XSSFRichTextString(headers.get(j));
cell.setCellValue(text);
}
// 导出正文数据,并设置其样式
ListIterator
1.导出方法参数数据源:List
> dataLists
第一层List
:多个sheet页。
第二层List
:一个Sheet页下的多条数据。
T:实体类,对应一个Sheet页下的一行数据。
2.导出方法参数数据源:List
>> dataLists
第一层List
:多个Sheet页数据。
第二层List
:一个Sheet页下的多条数据。
Map
:一个Sheet页下的一行数据,其中key
:表头,value
:对应单元格的值。
使用场景: 适合Excel列的名称顺序和列数是固定的业务场景。
注意事项: 实体类的属性声明的顺序,即为Excel导出后列的顺序,想调整列的顺序,需调整实体类属性声明的顺序即可。
导出方法:
/**
* 导出多Sheet的Excel到HttpServletResponse流中
*
* @param fileName
* 另存为文件名
* @param sheetName
* 工作簿中的多张Sheet工作表的名称列表
* @param titleName
* 表格的标题名称(没有标题,则传null)
* @param headers
* 表头列表
* @param dataList
* 要导出的数据源
* @param HttpServletResponse
* Http响应
* @param pattern
* 时间类型数据的格式,默认UTC格式
* @param isExportNullField
* 空字段是否导出(true:导出,false:不导出)
*/
public static void exportExcel(String fileName, List sheetNames, String titleName, List headers,
List> dataLists, HttpServletResponse response, String pattern, boolean isExportNullField){……}
使用示例:
实体类示例:
package com.entity.dto;
import java.io.Serializable;
/**
* 数据转Excel对象 注:属性名的顺序和Excel列顺序必须相同
*/
@SuppressWarnings("serial")
public class EventDTO implements Serializable {
// 列字段1
private String name;
// 列字段2
private String code;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
}
注: 文件名和sheet名:注意不要含有Excel不支持的特殊字符。
使用示例:
在SpringMVC的RESTful接口中,控制器中调用示例
@GetMapping(value = "/myevent/export/{code}")
public void exportEvent(HttpServletResponse response, @PathVariable("code") String code) {
List> dataLists = eventService.exportEvent(stationCode);
if (dataLists != null && dataLists.size() > 0) {
try {
List sheetNames = new ArrayList(
Arrays.asList("sheet页1, "sheet页2", "sheet页3"));
List headers = new ArrayList(
Arrays.asList("类型", "型号", "编号", "参数", "描述", "级别"));
String excelName = "你的Excel名称";
ExportExcelUtil.exportExcel(excelName, sheetNames, null, headers, dataLists, response, null, true);
} catch (Exception e) {
log.info("导出Excel出错", e);
}
}
}
使用场景: 适合Excel列的名称和顺序和列数是不固定的,如每次导出的列数可能不一致的场景。
注意事项: Excel导出后列的顺序,为Map中的键值对加入的顺序,要想导出后列的顺序固定,可将Map实例化为LinkedHashMap
即可使导出后的列顺序不会改变。
例: 如下方式缓存导出数据,导出后的“名称”列,会在“类型”列的左侧。
Map tempMap = new LinkedHashMap();
tempMap.put("名称", device.getName());
tempMap.put("类型", device.getDeviceType());
导出方法:
/**
* 导出多Sheet动态列的Excel到HttpServletResponse流中
*
* @param fileName
* 另存为文件名
* @param sheetName
* 工作簿中的多张Sheet工作表的名称列表
* @param titleName
* 表格的标题名称(没有标题,则传null)
* @param headers
* 表头列表
* @param dataList
* 要导出的数据源
* @param HttpServletResponse
* Http响应
* @param pattern
* 时间类型数据的格式,默认UTC格式
* @param isExportNullField
* 空字段是否导出(true:导出,false:不导出)
*/
public static void exportDynamicExcel(String fileName, List sheetNames, String titleName,
List headers, List>> dataLists, HttpServletResponse response,
String pattern, boolean isExportNullField) {……}
使用示例:
在SpringMVC的RESTful接口中,控制器中调用示例:
@PostMapping(value = "/history/export")
public void exportHistory(HttpServletResponse response, @RequestBody Params params) {
List>> datalists = deviceService.exportHistory(params);
if (!datalists.isEmpty()) {
try {
List headers = new ArrayList("表头列名1","表头列名2","表头列名3");
String fileName ="你的文件名,若包含Excel不支持的特殊字符,会自动处理成下划线";
ExportExcelUtil.exportDynamicExcel(fileName, Arrays.asList("用户历史数据"), null, headers, datalists, response,
null, true);
} catch (Exception e) {
e.printStackTrace();
}
}
}