1. 使用指南
1.1 升级父级工程至 1.1.5-SNAPSHOT
<parent>
<artifactId>brain-parent</artifactId>
<groupId>com.ylz</groupId>
<version>1.1.5-SNAPSHOT</version>
</parent>
1.2 使用 brain-core 包 ExcelUtils 工具的 read 与 write 方法
image.png
2. Excel生成使用说明（即write方法）
2.1 导出对象之导出注解类说明（ExportField.class说明）
public @interface ExportField {
/**
* 导出字段 头部 名字
* @return
*/
String value();
/**
* 导出字段 对应 字典映射key
* @return
*/
String dictType() default "";
/**
* 导出字段 时间 格式化
* @return
*/
String format() default "yyyy-MM-dd HH:mm:ss";
}
2.2 导出配置说明
public class WriteExcelConfig<T> {
/**
* 文件名称
*/
private String fileName = "未自定义文件名";
/**
* sheet名称
*/
private String sheetName = "sheet";
/**
* xls
* xlsx
* csv 暂不支持 后续有需求在更新
*/
private ExcelTypeEnum excelType = ExcelTypeEnum.XLSX;
/**
* 最大内存处理数量
*/
private int maxComputeRowSize = 200;
/**
* 数据导出对象
*/
private Class<T> dataClass;
/**
* 导出对象数据集合
*/
private List<T> datum;
/**
* Excel输出流
*/
private OutputStream outputStream;
/**
* 字段映射字典属性
* Map<dictType, Map<dictKey, dictValue>>
*/
private Map<String, Map<String, String>> dictMap;
}
2.3 导出对象定义
public class AttachVO {
/**
* 应用id
*/
@ExportField("应用id")
private String appId;
/**
* 附件类型：01/图片,11/文件
*/
@ExportField(value = "附件类型：01/图片,11/文件", dictType = "attachType")
private String attachType;
/**
* 更新时间
*/
@ExportField(value = "更新时间", format = "yyyy-MM-dd")
private Date updateTime;
}
2.4 导出对象支持数据类型 String，Integer, Long, Boolean, Date, BigDecimal 的基础数据类型
2.5 导出示例Demo
@Test
public void test1() throws FileNotFoundException {
// 模拟导出数据
List<AttachVO> list = new ArrayList<>();
for (int i = 0; i < 100000; i++) {
AttachVO attachment = new AttachVO();
attachment.setAppId(UUID.randomUUID().toString() + i);
attachment.setAttachType(i % 2 == 0 ? "02" : "01");
attachment.setUpdateTime(new Date());
list.add(attachment);
}
// 导出配置定义
WriteExcelConfig<AttachVO> config = new WriteExcelConfig<>();
config.setDatum(list);
config.setDataClass(AttachVO.class);
HashMap<String, Map<String, String>> dictMap = new HashMap<>();
Map<String, String> keyMap = new HashMap<>();
keyMap.put("01", "图片");
keyMap.put("02", "文件");
dictMap.put("attachType", keyMap);
config.setDictMap(dictMap);
config.setExcelType(ExcelTypeEnum.XLSX);
File file = new File("D:\\test1.xlsx");
FileOutputStream outputStream = new FileOutputStream(file);
config.setOutputStream(outputStream);
// 生成Excel
ExcelUtils.write(config);
}
3. Excel读取使用说明（即read方法）
3.1 有导出注解就有导入注解 -- > 导入对象之导入注解类说明（ImportParam.class, ImportValidNotNull.class, ImportValidPattern.class说明）
- ImportParam.class 说明
public @interface ImportParam {
/**
* 字段头部值（对应的Excel头部信息）
* @return
*/
String value();
/**
* 导入字段类型 如不是String 字段类型需要重新定义改注解使用的字段的字段类型
* @return
*/
Class<?> fieldType() default String.class;
/**
* 格式化
* @return
*/
String format() default "";
/**
* 字典类型
* @return
*/
String dictType() default "";
}
- ImportValidNotNull.class 说明
public @interface ImportValidNotNull {
/**
* 验证未通过的错误报错信息
* @return
*/
String errorMsg();
}
- ImportValidPattern.class 说明
public @interface ImportValidPattern {
/**
* 正则表达式
* @return
*/
String pattern();
/**
* 验证未通过的错误报错信息
* @return
*/
String errorMsg();
}
3.2 导入配置类说明（ReadExcelConfig.class 说明）
public class ReadExcelConfig<T> {
/**
* 文件名称
*/
private String fileName;
/**
* 头部所在行数
*/
private int headerRow = 0;
/**
* Excel文件输入流
*/
private InputStream inputStream;
/**
* 导入数据对象
*/
private Class<T> dataClass;
/**
* 字段映射字典属性
* Map<dictType, Map<dictValue, dictKey>>
*/
private Map<String, Map<String, String>> dictMap = new HashMap<>();
}
3.3 导入获取结果类说明
public class ReadExcelResult<T> {
/**
* 解析后的文件头部全部信息
*/
private List<String> excelHeader;
/**
* 解析后导入对象数据集合
*/
private List<T> datum;
/**
* 解析后错误行报错信息
*/
private List<String> errorRowMsg;
}
3.4 导入对象示例说明
public class AttachVO {
/**
* 应用id
*/
@ImportParam("应用id")
private String appId;
/**
* 业务类型
*/
@ImportParam("业务类型")
private String businessType;
/**
* 附件类型：01/图片,11/文件 dictType 为字典类型
*/
@ImportParam(value = "附件类型：01/图片,11/文件", dictType = "attachType")
private String attachType;
/**
* 金额 非String 的字段类型需定义字段类型类 fieldType
*/
@ImportParam(value = "金额", fieldType = BigDecimal.class)
private BigDecimal amount;
}
3.5 导入Demo
@Test
public void test2() throws Exception {
// 导入配置
File file = new File("D:\\test1.xlsx");
FileInputStream fileInputStream = new FileInputStream(file);
ReadExcelConfig<AttachVO> config = new ReadExcelConfig<>();
config.setHeaderRow(1);
config.setDataClass(AttachVO.class);
config.setInputStream(fileInputStream);
HashMap<String, Map<String, String>> dictMap = new HashMap<>();
Map<String, String> keyMap = new HashMap<>();
keyMap.put("图片", "01");
keyMap.put("文件", "02");
dictMap.put("attachType", keyMap);
config.setDictMap(dictMap);
// 解析导入Excel的数据
ReadExcelResult<AttachVO> excelResult = ExcelUtils.read(config);
System.out.println("ExcelUtils.read success");
}
