Java导出Excel-Utils类和业务层调用
莫英卓
Java导出Excel-Utils类和业务层调用
提示：可以点击目录跳转到想要查看或使用的位置
前言
大多数情况下，系统的数据列表都需要导出Excel，再进一步处理后才能进行汇报。本文主要记录【多Sheet导出】到Excel实现的工具类，并且举例演示使用方法。
一、多Sheet导出到Excel实现
传参注释：
/**
* @param fileName
* 另存为文件名
* @param sheetNames
* 工作簿中的多张Sheet工作表的名称列表
* @param titleName
* 表格的标题名称（没有标题，则传null）
* @param headers
* 表头列表
* @param dataLists
* 要导出的数据源
* @param response
* Http响应
* @param pattern
* 时间类型数据的格式,默认UTC格式
* @param isExportNullField
* 空字段是否导出（true：导出，false:不导出）
* @see
*/
2.主方法
/**
* 多Sheet导出实现
*
* @param sheetNames
* @param titleName
* @param headers
* @param dataLists
* @param pattern
* @param isExportNullField
* @return
*/
private static <T> XSSFWorkbook exportAllExcel(List<String> sheetNames, String titleName, List<String> headers,
List<List<T>> 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)));//3replaceSpecStr方法
// 设置单元格列宽度为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 HH:mm:ss" : 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;
}
3.replaceSpecStr方法
/**
* 正则替换所有特殊字符
*
* @param orgStr
* @return
*/
public static String replaceSpecStr(String orgStr) {
if (null != orgStr && !"".equals(orgStr.trim())) {
String regEx = "[\\\\|:/\"<>?*\\[\\] ]";
Pattern p = Pattern.compile(regEx);
Matcher m = p.matcher(orgStr);
return m.replaceAll("_");
}
return null;
}
二、工具类自引用
1.对接业务方法
代码如下（示例）：
public static <T> void exportExcel(String fileName, List<String> sheetNames, String titleName, List<String> headers,
List<List<T>> 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();
}
}
}
2.setResponseHeader方法
代码如下（示例）：
/**
* 设置响应的类型、编码和文件名称
*
* @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();
}
}
三、总代码
package cn.trustway.cppcc.social.situation.info.point.utils;
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.*;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
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.Date;
import java.util.Iterator;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class TestUtil<T> {
/**
* 导出多Sheet的Excel到HttpServletResponse流中
*
* @param fileName
* 另存为文件名
* @param sheetNames
* 工作簿中的多张Sheet工作表的名称列表
* @param titleName
* 表格的标题名称（没有标题，则传null）
* @param headers
* 表头列表
* @param dataLists
* 要导出的数据源
* @param response
* Http响应
* @param pattern
* 时间类型数据的格式,默认UTC格式
* @param isExportNullField
* 空字段是否导出（true：导出，false:不导出）
* @see
*/
public static <T> void exportExcel(String fileName, List<String> sheetNames, String titleName, List<String> headers,
List<List<T>> 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();
}
}
}
/**
* 设置响应的类型、编码和文件名称
*
* @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 orgStr
* @return
*/
public static String replaceSpecStr(String orgStr) {
if (null != orgStr && !"".equals(orgStr.trim())) {
String regEx = "[\\\\|:/\"<>?*\\[\\] ]";
Pattern p = Pattern.compile(regEx);
Matcher m = p.matcher(orgStr);
return m.replaceAll("_");
}
return null;
}
/**
* 多Sheet导出实现
*
* @param sheetNames
* @param titleName
* @param headers
* @param dataLists
* @param pattern
* @param isExportNullField
* @return
*/
private static <T> XSSFWorkbook exportAllExcel(List<String> sheetNames, String titleName, List<String> headers,
List<List<T>> 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 HH:mm:ss" : 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;
}
}
四、业务层调用
List<对象> exportDtoList = new ArrayList<>();
//文件名
String fileName = "文件名";
//sheet名
List<String> strings = Arrays.asList("sheet名");
//表头
String[] columnNames = new String[]{"主题", "名称", "单位", "分类", "上报人", "时间"};
List<String> columnName = Arrays.asList(columnNames);
List<List<对象>> lists = new ArrayList<>();
lists.add(exportDtoList);
ExportExcelUtil.exportExcel(fileName, strings, null, columnName, lists, response, null, true);
总结
以上就是今天要讲的内容，个人记录和分享。
类似资料：