工具类
package com.example.util;
import org.apache.poi.ss.usermodel.FillPatternType;
import org.apache.poi.ss.usermodel.HorizontalAlignment;
import org.apache.poi.ss.usermodel.IndexedColors;
import org.apache.poi.ss.usermodel.VerticalAlignment;
import org.apache.poi.xssf.usermodel.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Field;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
public class ExportExcelUtils {
/**
* @author created by Zhangdazhuang
* @version v.0.1
* @Description TODO
* @date 2019/4/7
* @备注
**/
private static final Logger logger = LoggerFactory.getLogger(ExportExcelUtils.class);
/**
* 导出Excel
*
* @param excelName 要导出的excel名称
* @param list 要导出的数据集合
* @param fieldMap 中英文字段对应Map,即要导出的excel表头
* @param response 使用response可以导出到浏览器
* @param <T>
*/
public static <T> void export(String excelName, List<T> list, LinkedHashMap<String, String> fieldMap, HttpServletResponse response) {
// 设置默认文件名为当前时间:年月日时分秒
if (excelName == null || excelName == "") {
excelName = new SimpleDateFormat("yyyyMMddhhmmss").format(
new Date()).toString();
}
try {
//创建一个WorkBook,对应一个Excel文件
XSSFWorkbook wb = new XSSFWorkbook();
//在Workbook中,创建一个sheet,对应Excel中的工作薄(sheet)
XSSFSheet sheet = wb.createSheet(excelName);
XSSFFont xssfFont = wb.createFont();
xssfFont.setBold(true);
xssfFont.setFontName("黑体");
xssfFont.setFontHeight(15);
//表头样式
XSSFCellStyle headStyle = wb.createCellStyle();
//继承字体样式
headStyle.setFont(xssfFont);
// //竖向居中,横向居中
headStyle.setVerticalAlignment(VerticalAlignment.CENTER);
headStyle.setAlignment(HorizontalAlignment.CENTER);
//设置标题一行的单元格的填充颜色为灰色
headStyle.setFillForegroundColor(IndexedColors.GREY_25_PERCENT.getIndex());
headStyle.setFillPattern(FillPatternType.SOLID_FOREGROUND);
headStyle.setWrapText(true);//设置自动换行
headStyle.setHidden(true);//高度自动
// 填充工作表
fillSheet(sheet, list, fieldMap, headStyle);
//将文件输出
response.setContentType("application/vnd.ms-excel");
response.setHeader("Content-disposition", "attachment; filename=" + new String(excelName.getBytes("gbk"), "iso8859-1") + ".xlsx");
//转为二进制流进行吐出
ServletOutputStream out = response.getOutputStream();
wb.write(out);
out.flush();
out.close();
} catch (Exception e) {
logger.info("导出Excel失败!");
logger.error(e.getMessage());
}
}
/**
* 根据字段名获取字段对象
*
* @param fieldName 字段名
* @param clazz 包含该字段的类
* @return 字段
*/
public static Field getFieldByName(String fieldName, Class<?> clazz) {
logger.info("根据字段名获取字段对象:getFieldByName()");
// 拿到本类的所有字段
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 fieldName 字段名
* @param o 对象
* @return 字段值
* @throws Exception 异常
*/
public static Object getFieldValueByName(String fieldName, Object o)
throws Exception {
logger.info("根据字段名获取字段值:getFieldValueByName()");
Object value = null;
//根据字段名得到字段对象
Field field = getFieldByName(fieldName, o.getClass());
// Class<?> aClass = o.getClass();
// Field[] declaredFields = aClass.getDeclaredFields();
// Field field1 = Arrays.stream(declaredFields).filter(s -> fieldName.equals(s.getName())).findFirst().get();
//如果该字段存在,则取出该字段的值
if (field != null) {
field.setAccessible(true);//类中的成员变量为private,在类外边使用属性值,故必须进行此操作
value = field.get(o);//获取当前对象中当前Field的value
} else {
throw new Exception(o.getClass().getSimpleName() + "类不存在字段名 "
+ fieldName);
}
return value;
}
/**
* 根据带路径或不带路径的属性名获取属性值,即接受简单属性名,
* 如userName等,又接受带路径的属性名,如student.department.name等
*
* @param fieldNameSequence 带路径的属性名或简单属性名
* @param o 对象
* @return 属性值
* @throws Exception 异常
*/
public static Object getFieldValueByNameSequence(String fieldNameSequence,
Object o) throws Exception {
logger.info("根据带路径或不带路径的属性名获取属性值,即接受简单属性名:getFieldValueByNameSequence()");
Object value = null;
// 将fieldNameSequence进行拆分
String[] attributes = fieldNameSequence.split("\\.");
if (attributes.length == 1) {
value = getFieldValueByName(fieldNameSequence, o);
} else {
// 根据数组中第一个连接属性名获取连接属性对象,如student.department.name
Object fieldObj = getFieldValueByName(attributes[0], o);
//截取除第一个属性名之后的路径
String subFieldNameSequence = fieldNameSequence
.substring(fieldNameSequence.indexOf(".") + 1);
//递归得到最终的属性对象的值
value = getFieldValueByNameSequence(subFieldNameSequence, fieldObj);
}
return value;
}
/**
* 向工作表中填充数据
*
* @param sheet excel的工作表名称
* @param list 数据源
* @param fieldMap 中英文字段对应关系的Map
* @param style 表格中的格式
* @throws Exception 异常
*/
public static <T> void fillSheet(XSSFSheet sheet, List<T> list,
LinkedHashMap<String, String> fieldMap, XSSFCellStyle style) throws Exception {
logger.info("向工作表中填充数据:fillSheet()");
// 定义存放英文字段名和中文字段名的数组
String[] enFields = new String[fieldMap.size()];
String[] cnFields = new String[fieldMap.size()];
// 填充数组
int count = 0;
for (Map.Entry<String, String> entry : fieldMap.entrySet()) {
enFields[count] = entry.getKey();
cnFields[count] = entry.getValue();
count++;
}
//在sheet中添加表头第0行,注意老版本poi对Excel的行数列数有限制short
XSSFRow row = sheet.createRow((int) 0);
//设置宽度
sheet.setDefaultColumnWidth(20);
// 填充表头
for (int i = 0; i < cnFields.length; i++) {
XSSFCell cell = row.createCell(i);
cell.setCellValue(cnFields[i]);
cell.setCellStyle(style);
}
// 填充内容
for (int index = 0; index < list.size(); index++) {
row = sheet.createRow(index + 1);
// 获取单个对象
T item = list.get(index);
for (int i = 0; i < enFields.length; i++) {
Object objValue = getFieldValueByNameSequence(enFields[i], item);
String fieldValue = objValue == null ? "" : objValue.toString();
row.createCell(i).setCellValue(fieldValue);
}
}
}
}
实体类
package com.example.pojo;
import java.math.BigInteger;
/**
* @author created by Zhangdazhuang
* @version v.0.1
**/
public class Excel {
private BigInteger id;
private String link_man;
private String amount_real;
private String date_add;
private String status_str;
private String mobie;
private String address;
private String detailValue;
public Excel() {
}
public Excel(BigInteger id, String link_man, String amount_real, String date_add, String status_str, String mobie, String address, String detailValue) {
this.id = id;
this.link_man = link_man;
this.amount_real = amount_real;
this.date_add = date_add;
this.status_str = status_str;
this.mobie = mobie;
this.address = address;
this.detailValue = detailValue;
}
public BigInteger getId() {
return id;
}
public void setId(BigInteger id) {
this.id = id;
}
public String getAmount_real() {
return amount_real;
}
public void setAmount_real(String amount_real) {
this.amount_real = amount_real;
}
public String getDate_add() {
return date_add;
}
public void setDate_add(String date_add) {
this.date_add = date_add;
}
public String getStatus_str() {
return status_str;
}
public void setStatus_str(String status_str) {
this.status_str = status_str;
}
public String getLink_man() {
return link_man;
}
public void setLink_man(String link_man) {
this.link_man = link_man;
}
public String getMobie() {
return mobie;
}
public void setMobie(String mobie) {
this.mobie = mobie;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
public String getDetailValue() {
return detailValue;
}
public void setDetailValue(String detailValue) {
this.detailValue = detailValue;
}
}
Controller测试
@RequestMapping(value = "/excel/exportBankCheckInfo",method = RequestMethod.POST)
public void ExportBankCkeckInfo(@RequestBody Excel excel, HttpServletResponse response){
//定义导出的excel名字
String excelName = "order";
//获取需要转出的excel表头的map字段
LinkedHashMap<String, String> fieldMap = new LinkedHashMap<>();
fieldMap.put("id","编号");
fieldMap.put("link_man","姓名");
fieldMap.put("amount_real","价格");
fieldMap.put("date_add","日期");
fieldMap.put("status_str","订单状态");
fieldMap.put("mobie","收货电话");
fieldMap.put("address","地址");
fieldMap.put("detailValue","订单详情");
// Excel excel = new Excel(new BigInteger("12"), "张三", "1200", "2019-12-10", "已买", "19119991211", "北京", "到货");
List<Excel> list =new ArrayList<>();
list.add(excel);
/* 导出用户相关信息 */
new ExportExcelUtils().export(excelName,list,fieldMap,response);
}
测试举例
localhost:8080/excel/exportBankCheckInfo
{
"id":12,
"link_man":"张三",
"amount_real":"1200",
"date_add":"2019-12-10",
"status_str":"已买",
"mobie":"19119991211",
"address":"北京",
"detailValue":"到货"
}
注意事项
使用postman测试下载excel时,注意下中文名称,会将中文名称下载为response.xls.即便是xlsx结尾的也会被转化为xls结尾,所以测试阶段尽量使用 **英文名称** 。
sheet.setDefaultColumnWidth(20); 可设置sheet页中列宽。