背景:
有一个很重要的功能需要记录日志,在排查问题时需要将日志内容导出Excel,并且针对不同的账号对个别导出字段进行隐藏
准备工作:
引包
<dependency>
<groupId>cn.afterturn</groupId>
<artifactId>easypoi-base</artifactId>
<version>4.1.0</version>
</dependency>
<dependency>
<groupId>cn.afterturn</groupId>
<artifactId>easypoi-web</artifactId>
<version>4.1.0</version>
</dependency>
<dependency>
<groupId>cn.afterturn</groupId>
<artifactId>easypoi-annotation</artifactId>
<version>4.1.0</version>
</dependency>
EasyPoiUtils.java
@Component
public class EasyPoiUtils {
private final static Logger logger = LoggerFactory.getLogger(EasyPoiUtils.class);
/**
* 功能描述:复杂导出Excel,包括文件名以及表名。创建表头
*
* @param list 导出的实体类
* @param title 表头名称
* @param sheetName sheet表名
* @param pojoClass 映射的实体类
* @param isCreateHeader 是否创建表头
* @param fileName
* @param response
* @return
*/
public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass, String fileName, boolean isCreateHeader, HttpServletResponse response) {
ExportParams exportParams = new ExportParams(title, sheetName);
exportParams.setCreateHeadRows(isCreateHeader);
exportParams.setStyle(EasyPoiExcelStyleUtil.class);
defaultExport(list, pojoClass, fileName, response, exportParams);
}
public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass, String fileName, boolean isCreateHeader) {
ExportParams exportParams = new ExportParams(title, sheetName);
exportParams.setCreateHeadRows(isCreateHeader);
exportParams.setStyle(EasyPoiExcelStyleUtil.class);
defaultExport(list, pojoClass, fileName, exportParams);
}
private static void defaultExport(List<?> list, Class<?> pojoClass, String fileName, ExportParams exportParams) {
Workbook workbook = ExcelExportUtil.exportExcel(exportParams, pojoClass, list);
if (workbook != null) {
downLoadExcel(fileName, workbook);
}
}
/**
* 功能描述:Excel导出
*
* @param fileName 文件名称
* @param workbook Excel对象
* @return
*/
public static void downLoadExcel(String fileName, Workbook workbook) {
try {
FileOutputStream fos = new FileOutputStream(fileName);
workbook.write(fos);
} catch (IOException e) {
System.out.println("文件打开异常,请确认是否已打开");
}
}
/**
* 功能描述:复杂导出Excel,包括文件名以及表名,不创建表头
*
* @param list 导出的实体类
* @param title 表头名称
* @param sheetName sheet表名
* @param pojoClass 映射的实体类
* @param fileName
* @param response
* @return
*/
public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass, String fileName, HttpServletResponse response) {
ExportParams exportParams = new ExportParams(title, sheetName);
exportParams.setStyle(EasyPoiExcelStyleUtil.class);
defaultExport(list, pojoClass, fileName, response, exportParams);
}
/**
* 功能描述:Map 集合导出
*
* @param list 实体集合
* @param fileName 导出的文件名称
* @param response
* @return
*/
public static void exportExcel(List<Map<String, Object>> list, String fileName, HttpServletResponse response) {
defaultExport(list, fileName, response);
}
/**
* 功能描述:默认导出方法
*
* @param list 导出的实体集合
* @param fileName 导出的文件名
* @param pojoClass pojo实体
* @param exportParams ExportParams封装实体
* @param response
* @return
*/
private static void defaultExport(List<?> list, Class<?> pojoClass, String fileName, HttpServletResponse response, ExportParams exportParams) {
Workbook workbook = ExcelExportUtil.exportExcel(exportParams, pojoClass, list);
if (workbook != null) {
downLoadExcel(fileName, response, workbook);
}
}
/**
* 功能描述:Excel导出
*
* @param fileName 文件名称
* @param response
* @param workbook Excel对象
* @return
*/
public static void downLoadExcel(String fileName, HttpServletResponse response, Workbook workbook) {
try {
response.setCharacterEncoding("UTF-8");
response.setHeader("Access-Control-Expose-Headers", "Content-Disposition");
response.setHeader("content-Type", "application/vnd.ms-excel");
response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(fileName, "UTF-8"));
workbook.write(response.getOutputStream());
} catch (IOException e) {
throw new RuntimeException(e);
}
}
/**
* 功能描述:默认导出方法
*
* @param list 导出的实体集合
* @param fileName 导出的文件名
* @param response
* @return
*/
private static void defaultExport(List<Map<String, Object>> list, String fileName, HttpServletResponse response) {
Workbook workbook = ExcelExportUtil.exportExcel(list, ExcelType.HSSF);
if (workbook != null) {
downLoadExcel(fileName, response, workbook);
}
}
/**
* 功能描述:根据文件路径来导入Excel
*
* @param filePath 文件路径
* @param titleRows 表标题的行数--对应数据对象
* @param headerRows 表头行数
* @param pojoClass Excel实体类
* @return
*/
public static <T> List<T> importExcel(String filePath, Integer titleRows, Integer headerRows, Class<T> pojoClass) {
//判断文件是否存在
if (StringUtils.isBlank(filePath)) {
return null;
}
ImportParams params = new ImportParams();
params.setTitleRows(titleRows);
params.setHeadRows(headerRows);
List<T> list = null;
try {
list = ExcelImportUtil.importExcel(new File(filePath), pojoClass, params);
} catch (NoSuchElementException e) {
throw new RuntimeException("模板不能为空");
} catch (Exception e) {
e.printStackTrace();
}
return list;
}
/**
* 功能描述:根据接收的Excel文件来导入Excel,并封装成实体类
*
* @param file 上传的文件
* @param titleRows 表标题的行数
* @param headerRows 表头行数
* @param pojoClass Excel实体类
* @return
*/
public static <T> List<T> importExcel(MultipartFile file, Integer titleRows, Integer headerRows, Class<T> pojoClass) {
if (file == null) {
return null;
}
ImportParams params = new ImportParams();
params.setTitleRows(titleRows);
params.setHeadRows(headerRows);
List<T> list = null;
try {
list = ExcelImportUtil.importExcel(file.getInputStream(), pojoClass, params);
} catch (NoSuchElementException e) {
throw new RuntimeException("excel文件不能为空");
} catch (Exception e) {
throw new RuntimeException(e.getMessage());
}
return list;
}
/**
* 功能描述:根据接收的Excel文件来导入多个sheet,根据索引可返回一个集合
* @param filePath 导入文件路径
* @param sheetIndex 导入sheet索引
* @param titleRows 表标题的行数
* @param headerRows 表头行数
* @param pojoClass Excel实体类
* @return
*/
public static <T> List<T> importExcel(String filePath,int sheetIndex,Integer titleRows, Integer headerRows, Class<T> pojoClass) {
// 根据file得到Workbook,主要是要根据这个对象获取,传过来的excel有几个sheet页
ImportParams params = new ImportParams();
// 第几个sheet页
params.setStartSheetIndex(sheetIndex);
params.setTitleRows(titleRows);
params.setHeadRows(headerRows);
List<T> list = null;
try {
list = ExcelImportUtil.importExcel(new File(filePath), pojoClass, params);
} catch (NoSuchElementException e) {
throw new RuntimeException("模板不能为空");
} catch (Exception e) {
e.printStackTrace();
}
return list;
}
/**
* 功能描述:根据接收的Excel文件来导入多个sheet,根据索引可返回一个集合
* @param list 实体对象集合
* @param type 表格类型
* @return
*/
public static Workbook exportExcel(List<Map<String, Object>> list, ExcelType type) {
Workbook workbook = getWorkbook(type, 0);
Iterator var3 = list.iterator();
while(var3.hasNext()) {
Map<String, Object> map = (Map)var3.next();
ExcelExportService service = new ExcelExportService();
service.createSheet(workbook, (ExportParams)map.get("title"), (Class)map.get("entity"), (Collection)map.get("data"));
}
return workbook;
}
private static Workbook getWorkbook(ExcelType type, int size) {
if (ExcelType.HSSF.equals(type)) {
return new HSSFWorkbook();
} else {
return (Workbook)(size < USE_SXSSF_LIMIT ? new XSSFWorkbook() : new SXSSFWorkbook());
}
}
}
EasyPoiExcelStyleUtil .java
public class EasyPoiExcelStyleUtil implements IExcelExportStyler {
private static final short STRING_FORMAT = (short) BuiltinFormats.getBuiltinFormat("TEXT");
private static final short FONT_SIZE_TEN = 10;
private static final short FONT_SIZE_ELEVEN = 11;
private static final short FONT_SIZE_TWELVE = 12;
/**
* 大标题样式
*/
private CellStyle headerStyle;
/**
* 每列标题样式
*/
private CellStyle titleStyle;
/**
* 数据行样式
*/
private CellStyle styles;
public EasyPoiExcelStyleUtil(Workbook workbook) {
this.init(workbook);
}
/**
* 初始化样式
*
* @param workbook
*/
private void init(Workbook workbook) {
this.headerStyle = initHeaderStyle(workbook);
this.titleStyle = initTitleStyle(workbook);
this.styles = initStyles(workbook);
}
/**
* 大标题样式
*
* @param color
* @return
*/
@Override
public CellStyle getHeaderStyle(short color) {
return headerStyle;
}
/**
* 每列标题样式
*
* @param color
* @return
*/
@Override
public CellStyle getTitleStyle(short color) {
return titleStyle;
}
/**
* 数据行样式
*
* @param parity 可以用来表示奇偶行
* @param entity 数据内容
* @return 样式
*/
@Override
public CellStyle getStyles(boolean parity, ExcelExportEntity entity) {
return styles;
}
/**
* 获取样式方法
*
* @param dataRow 数据行
* @param obj 对象
* @param data 数据
*/
@Override
public CellStyle getStyles(Cell cell, int dataRow, ExcelExportEntity entity, Object obj, Object data) {
return getStyles(true, entity);
}
/**
* 模板使用的样式设置
*/
@Override
public CellStyle getTemplateStyles(boolean isSingle, ExcelForEachParams excelForEachParams) {
return null;
}
/**
* 初始化--大标题样式
*
* @param workbook
* @return
*/
private CellStyle initHeaderStyle(Workbook workbook) {
CellStyle style = getBaseCellStyle(workbook);
style.setFont(getFont(workbook, FONT_SIZE_TWELVE, true));
return style;
}
/**
* 初始化--每列标题样式
*
* @param workbook
* @return
*/
private CellStyle initTitleStyle(Workbook workbook) {
CellStyle style = getBaseCellStyle(workbook);
style.setFont(getFont(workbook, FONT_SIZE_ELEVEN, false));
//背景色
style.setFillForegroundColor(IndexedColors.GREY_25_PERCENT.getIndex());
style.setFillPattern(FillPatternType.SOLID_FOREGROUND);
return style;
}
/**
* 初始化--数据行样式
*
* @param workbook
* @return
*/
private CellStyle initStyles(Workbook workbook) {
CellStyle style = getBaseCellStyle(workbook);
style.setFont(getFont(workbook, FONT_SIZE_TEN, false));
style.setDataFormat(STRING_FORMAT);
return style;
}
/**
* 基础样式
*
* @return
*/
private CellStyle getBaseCellStyle(Workbook workbook) {
CellStyle style = workbook.createCellStyle();
//下边框
style.setBorderBottom(BorderStyle.THIN);
//左边框
style.setBorderLeft(BorderStyle.THIN);
//上边框
style.setBorderTop(BorderStyle.THIN);
//右边框
style.setBorderRight(BorderStyle.THIN);
//水平居中
style.setAlignment(HorizontalAlignment.CENTER);
//上下居中
style.setVerticalAlignment(VerticalAlignment.CENTER);
//设置自动换行
style.setWrapText(true);
return style;
}
/**
* 字体样式
*
* @param size 字体大小
* @param isBold 是否加粗
* @return
*/
private Font getFont(Workbook workbook, short size, boolean isBold) {
Font font = workbook.createFont();
//字体样式
font.setFontName("宋体");
//是否加粗
font.setBold(isBold);
//字体大小
font.setFontHeightInPoints(size);
return font;
}
}
隐藏字段代码 HiddenColumnUtil.java
public class HiddenColumnUtil<T> {
/**
* 需要被反射的对象,使用泛型规范传入对象
*/
public T t;
/**
* 动态更改EasyPoi中控制列显示的值
*
* @param columnName 需要转换的列属性名称
* @param target 默认true
* @throws NoSuchFieldException
* @throws IllegalAccessException
*/
public void hihdColumn(String columnName, Boolean target) throws Exception {
if (t == null) {
throw new ClassNotFoundException("TARGET OBJECT NOT FOUNT");
}
if (StringUtils.isEmpty(columnName)) {
throw new NullPointerException("COLUMN NAME NOT NULL");
}
if (target == null) {
target = true;
}
//获取目标对象的属性值
Field field = t.getClass().getDeclaredField(columnName);
//获取注解反射对象
Excel excelAnnon = field.getAnnotation(Excel.class);
//获取代理
InvocationHandler invocationHandler = Proxy.getInvocationHandler(excelAnnon);
Field excelField = invocationHandler.getClass().getDeclaredField("memberValues");
excelField.setAccessible(true);
Map memberValues = (Map) excelField.get(invocationHandler);
memberValues.put("isColumnHidden", target);
}
实体类
@Data
public class TestLogDTO {
@Excel(name = "test1",orderNum = "1",width = 20,isColumnHidden = false)
private String test1;
@Excel(name = "test2",orderNum = "2",width = 20,isColumnHidden = false)
private String test2;
@Excel(name = "test3",orderNum = "3",width = 20,isColumnHidden = false)
private String test3;
}
具体实现代码
@Api(value = "日志导出", tags = { "日志导出" })
@RestController
@RequestMapping("/testExport")
public class TestLogController {
@Autowired
TestLogMapper testLogMapper;
@PostMapping("/export")
@ResponseBody
@ResponseStatus(HttpStatus.CREATED)
public String export(Long logId,String type,String excelName){
TestLogPO testLogPO = testLogMapper.getLog(logId,type);
if(StringUtils.isNullOrEmpty(testLogPO )){
throw new ServiceBizException("日志为空!");
}
// Feature.OrderedField 防止数据转成map顺序发生改变
Map<String,Object> logMap = JSONObject.parseObject(testLogPO.getResponseJson(), Map.class, Feature.OrderedField);
Workbook workBook = null;
try {
List<Map<String, Object>> sheetsList = new ArrayList<>();
if("0".equals(type)){
setTest1Data(logMap,sheetsList,type);
}else{
// 针对不同类型有不同处理情况,此处省略setTest2Data
setTest2Data(logMap,sheetsList,type);
}
// 执行方法
workBook = EasyPoiUtils.exportExcel(sheetsList, ExcelType.HSSF);
String name = excelName == "" ? "d:/ddd.xls" : "d:/"+excelName+".xls";
FileOutputStream fos = new FileOutputStream(name);
workBook.write(fos);
fos.close();
}catch (Exception e){
e.printStackTrace();
}finally {
if(workBook != null) {
try {
workBook.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
return "success";
}
/**
* 创建sheet页
* @param sheetName sheet页名称
* @param clazz 类
* @param list 呈现Excel具体数据
* @return sheet页对象
*/
private Map<String, Object> setParmas(String sheetName,Object clazz,Object list){
// 创建参数对象(用来设定excel得sheet得内容等信息)
ExportParams exportParams = new ExportParams();
// 设置sheet得名称
exportParams.setSheetName(sheetName);
// 创建sheet1使用得map
Map<String, Object> exportMap = new HashMap<>();
// title的参数为ExportParams类型,目前仅仅在ExportParams中设置了sheetName
exportMap.put("title", exportParams);
// 模版导出对应得实体类型
exportMap.put("entity", clazz);
// sheet中要填充得数据
exportMap.put("data", list);
return exportMap;
}
/**
* 设置test1数据
* @param temporaryEndMap 日志源
* @param sheetsList sheet页集合
*/
private void setTest1Data(Map<String,Object> logMap,List<Map<String, Object>> sheetsList,String type){
// 需求列表
List<TestLogDTO> list = JSONArray.parseArray(JSON.toJSONString(logMap.get("list")), TestLogDTO.class);
Map<String, Object> testMap = setParmas("测试列表",TestLogDTO.class,list);
List<TestLogDTO> finalList = JSONArray.parseArray(JSON.toJSONString(logMap.get("finalList")), TestLogDTO.class);
Map<String, Object> finalResultMap= setParmas("结果列表",TestLogDTO.class,finalList);
// 处理隐藏字段
hiddenColumn(list,type);
sheetsList.add(testMap);
sheetsList.add(finalResultMap);
}
/**
* 处理不同类型隐藏字段
* @param list 数据源
* @param type
*/
private void hiddenColumn(List<TestLogDTO> list,String type){
for (TestLogDTO item : list) {
HiddenColumnUtil<TestLogDTO> easyPoiUtil = new HiddenColumnUtil<>();
easyPoiUtil.t = item;
try {
if("0".equals(type)){
easyPoiUtil.hihdColumn("test2", true);
easyPoiUtil.hihdColumn("test3", true);
}else if("1".equals(type)){
easyPoiUtil.hihdColumn("test1", true);
easyPoiUtil.hihdColumn("test3", true);
}else{
easyPoiUtil.hihdColumn("test1", true);
easyPoiUtil.hihdColumn("test2", true);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
大部分代码出自于:
网上各种找找抄抄,已经不记得浏览过哪些博客了