b2baccline/ballcat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

✨ excel自定义头生成器

Browse Source
This commit is contained in:
b2baccline
2021-04-30 11:03:26 +08:00
parent f58ac98afe
commit 9f1f4e968c
5 changed files with 62 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
ballcat-starters/ballcat-spring-boot-starter-easyexcel/src/main/java/com/hccake/common/excel/annotation/ResponseExcel.java
View File

@@ -39,7 +39,7 @@ public @interface ResponseExcel {
* sheet 名称，支持多个
* @return String[]
*/
String[] sheet() default { "Sheet1" };
Sheet[] sheets() default @Sheet(sheetName = "sheet1");
/**
* 内存操作

71
ballcat-starters/ballcat-spring-boot-starter-easyexcel/src/main/java/com/hccake/common/excel/handler/AbstractSheetWriteHandler.java
View File

@@ -8,19 +8,26 @@ import com.alibaba.excel.write.builder.ExcelWriterSheetBuilder;
import com.alibaba.excel.write.handler.WriteHandler;
import com.alibaba.excel.write.metadata.WriteSheet;
import com.hccake.common.excel.annotation.ResponseExcel;
import com.hccake.common.excel.annotation.Sheet;
import com.hccake.common.excel.aop.DynamicNameAspect;
import com.hccake.common.excel.config.ExcelConfigProperties;
import com.hccake.common.excel.converters.LocalDateStringConverter;
import com.hccake.common.excel.converters.LocalDateTimeStringConverter;
import com.hccake.common.excel.enhance.WriterBuilderEnhancer;
import com.hccake.common.excel.head.HeadGenerator;
import com.hccake.common.excel.head.HeadMeta;
import com.hccake.common.excel.kit.ExcelException;
import lombok.RequiredArgsConstructor;
import lombok.SneakyThrows;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.core.io.ClassPathResource;
import org.springframework.http.HttpHeaders;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
@@ -28,6 +35,7 @@ import org.springframework.web.context.request.RequestContextHolder;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.InputStream;
import java.lang.reflect.Modifier;
import java.net.URLEncoder;
import java.util.Arrays;
import java.util.List;
@@ -39,7 +47,7 @@ import java.util.Objects;
* @date 2020/3/31
*/
@RequiredArgsConstructor
public abstract class AbstractSheetWriteHandler implements SheetWriteHandler {
public abstract class AbstractSheetWriteHandler implements SheetWriteHandler, ApplicationContextAware {
private final ExcelConfigProperties configProperties;
@@ -47,13 +55,15 @@ public abstract class AbstractSheetWriteHandler implements SheetWriteHandler {
private final WriterBuilderEnhancer excelWriterBuilderEnhance;
private ApplicationContext applicationContext;
@Override
public void check(ResponseExcel responseExcel) {
if (!StringUtils.hasText(responseExcel.name())) {
throw new ExcelException("@ResponseExcel name 配置不合法");
}
if (responseExcel.sheet().length == 0) {
if (responseExcel.sheets().length == 0) {
throw new ExcelException("@ResponseExcel sheet 配置不合法");
}
}
@@ -135,37 +145,66 @@ public abstract class AbstractSheetWriteHandler implements SheetWriteHandler {
/**
* 获取 WriteSheet 对象
* @param sheetNo 页签号
* @param sheetName 页签名称
* @param sheet sheet annotation info
* @param dataClass 数据类型
* @param template 模板
* @param headEnhancerClass 自定义头处理器
* @return WriteSheet
*/
public WriteSheet sheet(Integer sheetNo, String sheetName, Class<?> dataClass, String template,
public WriteSheet sheet(Sheet sheet, Class<?> dataClass, String template,
Class<? extends HeadGenerator> headEnhancerClass) {
// 头信息增强
HeadGenerator headGenerator = null;
if (!headEnhancerClass.isInterface()) {
headGenerator = BeanUtils.instantiateClass(headEnhancerClass);
}
// 是否模板写入
Integer sheetNo = sheet.sheetNo() >= 0 ? sheet.sheetNo() : null;
ExcelWriterSheetBuilder writerSheetBuilder = StringUtils.hasText(template) ? EasyExcel.writerSheet(sheetNo)
: EasyExcel.writerSheet(sheetNo, sheetName);
// 自定义头信息
if (headGenerator != null) {
writerSheetBuilder.head(headGenerator.head(dataClass));
: EasyExcel.writerSheet(sheetNo, sheet.sheetName());
Class<? extends HeadGenerator> headGenerateClass = sheet.headGenerateClass();
// 头信息增强
if (isNotInterface(headGenerateClass)) {
fillCustomHeadInfo(dataClass, headGenerateClass, writerSheetBuilder);
}
else if (isNotInterface(headEnhancerClass)) {
fillCustomHeadInfo(dataClass, headEnhancerClass, writerSheetBuilder);
}
else if (dataClass != null) {
writerSheetBuilder.head(dataClass);
if (sheet.excludes().length > 0) {
writerSheetBuilder.excludeColumnFiledNames(Arrays.asList(sheet.excludes()));
}
if (sheet.includes().length > 0) {
writerSheetBuilder.includeColumnFiledNames(Arrays.asList(sheet.includes()));
}
}
// sheetBuilder 增强
writerSheetBuilder = excelWriterBuilderEnhance.enhanceSheet(writerSheetBuilder, sheetNo, sheetName, dataClass,
template, headEnhancerClass);
writerSheetBuilder = excelWriterBuilderEnhance.enhanceSheet(writerSheetBuilder, sheetNo, sheet.sheetName(),
dataClass, template, headEnhancerClass);
return writerSheetBuilder.build();
}
private void fillCustomHeadInfo(Class<?> dataClass, Class<? extends HeadGenerator> headEnhancerClass,
ExcelWriterSheetBuilder writerSheetBuilder) {
HeadGenerator headGenerator = this.applicationContext.getBean(headEnhancerClass);
Assert.notNull(headGenerator, "The header generated bean does not exist.");
HeadMeta head = headGenerator.head(dataClass);
writerSheetBuilder.head(head.getHead());
writerSheetBuilder.excludeColumnFiledNames(head.getIgnoreHeadFields());
}
/**
* 是否为Null Head Generator
* @param headGeneratorClass
* @return true 已指定 false 未指定(默认值)
*/
private boolean isNotInterface(Class<? extends HeadGenerator> headGeneratorClass) {
return !Modifier.isInterface(headGeneratorClass.getModifiers());
}
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
}
}

10
ballcat-starters/ballcat-spring-boot-starter-easyexcel/src/main/java/com/hccake/common/excel/handler/ManySheetWriteHandler.java
View File

@@ -4,6 +4,7 @@ import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.converters.Converter;
import com.alibaba.excel.write.metadata.WriteSheet;
import com.hccake.common.excel.annotation.ResponseExcel;
import com.hccake.common.excel.annotation.Sheet;
import com.hccake.common.excel.config.ExcelConfigProperties;
import com.hccake.common.excel.enhance.WriterBuilderEnhancer;
import com.hccake.common.excel.kit.ExcelException;
@@ -45,18 +46,15 @@ public class ManySheetWriteHandler extends AbstractSheetWriteHandler {
public void write(Object obj, HttpServletResponse response, ResponseExcel responseExcel) {
List objList = (List) obj;
ExcelWriter excelWriter = getExcelWriter(response, responseExcel);
String[] sheets = responseExcel.sheet();
Sheet[] sheets = responseExcel.sheets();
WriteSheet sheet;
for (int i = 0; i < sheets.length; i++) {
List eleList = (List) objList.get(i);
Class<?> dataClass = eleList.get(0).getClass();
// 创建sheet
sheet = this.sheet(i, responseExcel.sheet()[i], dataClass, responseExcel.template(),
responseExcel.headGenerator());
sheet = this.sheet(sheets[i], dataClass, responseExcel.template(), responseExcel.headGenerator());
// 写入sheet
excelWriter.write((List) objList.get(i), sheet);
excelWriter.write(eleList, sheet);
}
excelWriter.finish();
}

2
ballcat-starters/ballcat-spring-boot-starter-easyexcel/src/main/java/com/hccake/common/excel/handler/SingleSheetWriteHandler.java
View File

@@ -50,7 +50,7 @@ public class SingleSheetWriteHandler extends AbstractSheetWriteHandler {
// 有模板则不指定sheet名
Class<?> dataClass = list.get(0).getClass();
WriteSheet sheet = this.sheet(null, responseExcel.sheet()[0], dataClass, responseExcel.template(),
WriteSheet sheet = this.sheet(responseExcel.sheets()[0], dataClass, responseExcel.template(),
responseExcel.headGenerator());
excelWriter.write(list, sheet);
excelWriter.finish();

2
ballcat-starters/ballcat-spring-boot-starter-easyexcel/src/main/java/com/hccake/common/excel/head/HeadGenerator.java
View File

@@ -19,6 +19,6 @@ public interface HeadGenerator {
* @param clazz 当前sheet的数据类型
* @return List<List<String>> Head头信息
*/
List<List<String>> head(Class<?> clazz);
HeadMeta head(Class<?> clazz);
}