一、基于Apache下的poi实现Excel表格的导出功能
1、引入poi相关依赖
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>3.11-beta1</version>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml-schemas</artifactId>
<version>3.11-beta1</version>
</dependency>
2、自定义ExcelColumn注解（包含如下几个属性）
package com.xd.excel.anno;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@Retention(RetentionPolicy.RUNTIME)
public @interface ExcelColumn {
// 定义字段在excel的单元格列坐标位置
int order() default 9999;
// 定义列坐标对应的标题
String title() default "";
// 定义列宽
int column() default 100;
// 定义日期显示格式
String pattern() default "yyyy-MM-dd HH:mm:ss";
}
3、自定义TitleColumn类（标题、列宽）
package com.xd.excel.common;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class TitleColumn implements Serializable {
// 标题
private String title;
// 列宽
private int column;
}
4、自定义ExcelModel导出实体类
package com.xd.excel.entity;
import com.alibaba.fastjson.JSONObject;
import com.xd.excel.anno.ExcelColumn;
import com.xd.excel.enums.SexType;
import lombok.Data;
import java.io.Serializable;
import java.time.LocalDateTime;
@Data
public class ExcelModel implements Serializable {
@ExcelColumn(order=0, title = "姓名", column = 10)
private String name;
@ExcelColumn(order=1, title = "年龄", column = 10)
private Integer age;
@ExcelColumn(order=2, title = "创建时间", column = 24)
private LocalDateTime createTime;
@ExcelColumn(order=3, title = "性别", column = 10)
private SexType sex;
@Override
public String toString() {
return JSONObject.toJSONString(this); }
}
5、枚举字段导出需要自定义枚举类（实现字段toString()方法）
package com.xd.excel.enums;
public enum SexType {
MALE("男"),
FEMALE("女");
private String typeName;
SexType(String typeName) {
this.typeName = typeName;
}
@Override
public String toString() {
return typeName;
}
}
6、自定义封装ExcelUtil工具类（重点 --> 可拓展）
package com.xd.excel.utils;
import com.xd.excel.anno.ExcelColumn;
import com.xd.excel.common.TitleColumn;
import org.apache.poi.hssf.usermodel.*;
import org.apache.poi.hssf.util.HSSFColor;
import org.springframework.util.Assert;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.lang.reflect.Field;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* @Description Excel操作工具类
* @Author sueno
* @Date 2021/4/18 10:30
*/
public class ExcelUtil {
// 标题行高
private static final float TITLE_ROW_HEIGHT = 30;
// 数据行高
private static final float DATA_ROW_HEIGHT = 25;
public static void exportExcel(HttpServletRequest request, HttpServletResponse response, String fileName , List<?> excelData, Class<?> clazz) {
try {
HSSFWorkbook resultWb=new HSSFWorkbook();
HSSFSheet sheet=resultWb.createSheet(fileName);
// 根据类类型信息获取导出的excel对应的标题和列宽 key-列号，value-标题和列宽
Map<Integer, TitleColumn> orderTitleAndColumnMap = getTitleColumnMap(clazz);
// 设置标题列宽
orderTitleAndColumnMap.forEach((k,v) -> {
sheet.setColumnWidth(k, v.getColumn() * 256);
});
HSSFRow row0 = sheet.createRow(0);
// 设置标题行高
row0.setHeightInPoints(TITLE_ROW_HEIGHT);
// 创建标题单元格格式
HSSFCellStyle titleCellStyle = getCellStyle(resultWb,11,true,HSSFColor.BLACK.index);
// 填充标题行内容
orderTitleAndColumnMap.forEach((k,v) -> {
HSSFCell row0Cell = row0.createCell(k);
row0Cell.setCellValue(v.getTitle());
row0Cell.setCellStyle(titleCellStyle);
});
// 创建正文单元格格式
HSSFCellStyle dataStyle = getCellStyle(resultWb,11,false, HSSFColor.BLACK.index);
// 将正文转换为excel数据
int rowNum = 1;
for(Object data : excelData){
HSSFRow row = sheet.createRow(rowNum++);
row.setHeightInPoints(DATA_ROW_HEIGHT);
// 获取对象值 key-列号 value-String值
Map<Integer,String> orderValueMap = getValueMap(data);
orderValueMap.forEach((k,v) ->{
HSSFCell cell = row.createCell(k);
cell.setCellValue(v);
cell.setCellStyle(dataStyle);
}
);
}
String downFileName = fileName.concat(".xlsx");
// application/x-download
response.setContentType("application/vnd.ms-excel; charset=UTF-8");
response.setHeader("Content-Disposition", "attachment; ".concat(encodeFileName(request, downFileName)));
OutputStream outputStream = response.getOutputStream();
resultWb.write(outputStream);
outputStream.flush();
outputStream.close();
resultWb.close();
}catch (Exception e) {
e.printStackTrace();
}
}
/**
* 获取类的属性对应单元格标题和列宽
* @param clz
* @return 返回结果数据
*/
private static Map<Integer, TitleColumn> getTitleColumnMap(Class<?> clz) {
Map<Integer, TitleColumn> orderTitleColumnMap=new HashMap<>();
Field[] fs = clz.getDeclaredFields();
for(Field f : fs) {
f.setAccessible(true);
if(f.isAnnotationPresent(ExcelColumn.class)) {
Integer order = f.getAnnotation(ExcelColumn.class).order();
String title= f.getAnnotation(ExcelColumn.class).title();
int column = f.getAnnotation(ExcelColumn.class).column();
TitleColumn titleColumn = new TitleColumn(title, column);
orderTitleColumnMap.put(order, titleColumn);
}
}
return orderTitleColumnMap;
}
/**
* 获取单元格样式
* @param workbook
* @param fontSize
* @param isBolaWeight
* @param color
* @return 返回结果数据
*/
private static HSSFCellStyle getCellStyle(HSSFWorkbook workbook,int fontSize,boolean isBolaWeight,short color){
HSSFCellStyle style = workbook.createCellStyle();
// 设置水平居中
style.setAlignment(HSSFCellStyle.ALIGN_CENTER);
// 设置垂直居中
style.setVerticalAlignment(HSSFCellStyle.VERTICAL_CENTER);
style.setBorderBottom(HSSFCellStyle.BORDER_THIN);
style.setBorderLeft(HSSFCellStyle.BORDER_THIN);
style.setBorderRight(HSSFCellStyle.BORDER_THIN);
style.setBorderTop(HSSFCellStyle.BORDER_THIN);
HSSFFont font = workbook.createFont();
// 设置字体大小
font.setFontHeightInPoints((short) fontSize);
// 设置字体颜色
font.setColor(color);
// 设置字体类型
font.setFontName("宋体");
// 是否需要字体加粗
if(isBolaWeight) {
font.setBoldweight(HSSFFont.BOLDWEIGHT_BOLD);
}
style.setWrapText(true);
style.setFont(font);
return style;
}
/**
* 获取对象的属性对应单元格坐标和值的键值对
* @param obj
* @return 返回结果数据
*/
private static Map<Integer, String> getValueMap(Object obj) throws IllegalAccessException {
Map<Integer, String> result=new HashMap<>();
Class<?> clz=obj.getClass();
Field[] fs = clz.getDeclaredFields();
for(Field f : fs) {
f.setAccessible(true);
if(f.isAnnotationPresent(ExcelColumn.class)) {
Integer order = f.getAnnotation(ExcelColumn.class).order();
String value = "";
Object valueObj = f.get(obj);
if(valueObj != null) {
// 日期格式进行特殊处理
if(f.getType() == LocalDateTime.class){
String pattern=f.getAnnotation(ExcelColumn.class).pattern();
LocalDateTime dateTime = (LocalDateTime) valueObj;
value = dateTime.format(DateTimeFormatter.ofPattern(pattern));
}else {
// 其他格式调用toString方法，这里枚举就需要定义自己的toString方法
value=valueObj.toString();
}
}
result.put(order, value);
}
}
return result;
}
/**
* 根据不同的浏览器生成不同类型中文文件名编码
* @param request
* @param fileName
* @return 返回结果数据
* @throws UnsupportedEncodingException
*/
private static String encodeFileName(HttpServletRequest request, String fileName) throws UnsupportedEncodingException {
String new_filename = URLEncoder.encode(fileName, "UTF8").replaceAll("\\+", "%20");
String agent = request.getHeader("USER-AGENT").toLowerCase();
Assert.notNull(agent, "代理浏览器不存在！！！");
if (agent.contains("msie")) {
/**
* IE浏览器，只能采用URLEncoder编码
*/
return "filename=\"" + new_filename +"\"";
}else {
String s = "filename=\"" + new String(fileName.getBytes(StandardCharsets.UTF_8), "ISO8859-1") + "\"";
if (agent.contains("applewebkit")) {
/**
* Chrome浏览器，只能采用ISO编码的中文输出
*/
return s;
} else if (agent.contains("opera")) {
/**
* Opera浏览器只可以使用filename*的中文输出
* RFC2231规定的标准
*/
return "filename*=" + new_filename ;
}else if (agent.contains("safari")) {
/**
* Safani浏览器，只能采用iso编码的中文输出
*/
return s;
}else if (agent.contains("firefox")) {
/**
* Firfox浏览器，可以使用filename*的中文输出
* RFC2231规定的标准
*/
return "filename*=" + new_filename ;
} else {
return "filename=\"" + new_filename +"\"";
}
}
}
}
7、自定义ExcelExportController类（测试）
package com.xd.excel.controller;
import com.xd.excel.entity.ExcelModel;
import com.xd.excel.service.ExcelExportService;
import com.xd.excel.utils.ExcelUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.List;
/**
* @Description
* @Author sueno
* @Date 2021/4/18 11:18
*/
@RestController
@RequestMapping(value = "/excel")
public class ExcelExportController {
@Autowired
private ExcelExportService excelExportService;
@PostMapping(value = "/export")
public void export(HttpServletRequest request, HttpServletResponse response) {
List<ExcelModel> list = excelExportService.findAll();
ExcelUtil.exportExcel(request, response, "用户数据", list, ExcelModel.class);
}
}
测试结果如下：
完整代码地址，如下：
码云：https://gitee.com/liao_hanlin/ProjectDirectory/tree/dev/Springboot-Excel
github：https://github.com/mbql/ProjectDirectory/tree/dev/Springboot-Excel