Java Excel导入导出，基于XML和Easy-excel使用
来源：SegmentFault
时间：2023-01-14 16:43:44 253浏览 收藏
小伙伴们对数据库编程感兴趣吗？是否正在学习相关知识点？如果是，那么本文《Java Excel导入导出，基于XML和Easy-excel使用》，就很适合你，本篇文章讲解的知识点主要包括MySQL、Java、spring、maven。在之后的文章中也会多多分享相关知识点，希望对大家的知识积累有所帮助！
1.前言
在工作时，遇到过这样的需求，需要灵活的对工单进行导入或导出，以前自己也做过，但使用不灵活繁琐。我想能不能像配置文件一样可配置的导入导出，那样使用起来就方便许多。
2.SpringMVC项目搭建
创建基于Maven版本管理Springmvc项目，以下是主要的依赖，用jetty作为内嵌的服务器，直接启动。
架包相关依赖pom.xml。
1.9.2 3.2.1 2.6 3.14 2.6.0 4.2.6.RELEASE 1.2.17 1.0.11 junit 源码。3.Xml配置和Easy-excel使用
下面是员工信息模型。
//员工模型
public class EmployeeModel {
/**
* ID
*/
protected Integer id;
/**
* 创建时间
*/
protected Date createTime;
/**
* 姓名
*/
private String name;
/**
* 性别 0:男 1:女
*/
private Integer sex;
/**
* 年龄
*/
private Integer age;
/**
* 手机号
*/
private String mobile;
/**
* 状态 0:在职
* 1:离职
*/
private Integer status;
//省略getter setter
}
有如下的Excel文件格式，需要映射成学生实体类。
那么使用easy-excel 如何导入呢？
前一行是属于不规则的数据，从标题行以后才是规则的数据，也就是从规则数据之后才能正常转换成JavaBean。
具体实现代码，首先编写配置文件：excel-config.xml。
解释,每个excel表示一种Excel文件到JavaBean的映射规则,该规则可以是导入和导出。
配置了一个id为employee的映射,要映射对应的JavaBean实体为 EmployeeModel。
excel文件中标题为ID的列,把它的值映射到 EmployeeModel.id属性上。
isNull属性,表示在excel文件中标题为【年龄】的单元格的值不能为空,并且符合正则【 regex】,当正则校验没有通过时,会提示【xxx行,[ 年龄 ]必须是数字,如果为空同理,xxx行[年龄]不能为空】。
pattern：不做过多解释,SimpleDateFormat(pattern),导入数据时字符串的值如何转换成日期。支持多种映射pattern，使用【英文逗号】进行分割。
format属性,观察上面的excel文件结构会发现状态列是中文,那么导入时,可能javaBean中并不是中文,而是数字或其他,那么如何把它转换成数字呢？format就是做这个事情的。导入时它会以【,分割:前面的作为导入时使用的值，:后面的作为导出时使用的值】:后面值进行逆推,导出时同理。思考一个问题？如果这个值不确定如何解决,或者这个值需要到数据库校验？比如是个城市地址，这个时候是需要查询数据库进行比对的，如果地址不存在则抛出错误提示信息的,就说这么多,easy-excel已经做好了,支持自定义的转换器可以解决。
那么核心的代码是哪几行？
//导入
public Result importExcel(@RequestParam(value = "file", required = true) MultipartFile file) throws Exception {
Boolean excel = StringUtil.isExcel(file.getOriginalFilename());
if (!excel){
return Result.wrapErrorResult("该文件不是Excel格式");
}
InputStream fis = file.getInputStream();
ExcelContext context = new ExcelContext("excel/config.xml");
ExcelUtil excelUtil = new ExcelUtil(excelContext, "employee");
List stus;
try {
stus = excelUtil.importExcel(1, fis);
} catch (ExcelException e) {//这里主动返回错误信息
return Result.wrapErrorResult(e.getMessage());
}
List list=BdUtil.e2OList(stus,Employee.class);
return Result.wrapSuccessfulResult(list);
}
//导出
public void exportExcel(HttpServletRequest request, HttpServletResponse response) throws Exception {
ExcelUtil excelUtil = new ExcelUtil(excelContext, "employee");
final List list = getEmployeeList();
List specifyFields = new ArrayList(
ExcelHeader header=new ExcelHeader() {
public void buildHeader(Sheet sheet, ExcelDefinition excelDefinition, List> beans,Workbook workbook) {
// 设置第一行样式
CellStyle style1 = workbook.createCellStyle();
// 水平居中
style1.setAlignment(HSSFCellStyle.ALIGN_CENTER);
// 垂直居中
style1.setVerticalAlignment(HSSFCellStyle.VERTICAL_CENTER);
// 设置字体 大小
Font font1 = workbook.createFont();
font1.setFontHeightInPoints((short) 18);
style1.setFont(font1);
//第一行数据
Row row1 = sheet.createRow(0);
Cell cell1 = row1.createCell(0);
cell1.setCellValue("共导出【"+list.size()+"】条数据");
// 行高
row1.setHeight((short) 700);
cell1.setCellStyle(style1);
//合并单元格
CellRangeAddress region = new CellRangeAddress(0, 0, 0, 2);
sheet.addMergedRegion(region);
}
};
excelUtil.exportExcel(response,list, header,specifyFields,"员工信息");
}
只有准备数据、创建上下文、读取excel。。通常在真实的常见创建上下文都可以省略了，因为它会交给spring容器管理，整个jvm中，只保持一个实例就够了。
关于导入配置的一个很重要的属性：resolveFieldValueConverterName。
它是一个ResolveFieldValueConverter接口的实现类：假设我们的Excel中有地址，或者结合业务中可能是其他，都是需要查询数据库，或者经过更复杂的业务逻辑进行校验的，那么我们可以配置它。我们来观察这个接口做了什么事？
/**
* 解析Excel值解析接口
*
*/
public interface ResolveFieldValueConverter {
/**
* 操作类型，导入或导出
*/
enum Type {
EXPORT, IMPORT
}
/**
* 解析配置中Field元素 处理后的值
* @param bean Excel配置的JavaBean对象
* @param value Excel原值
* @param fieldValue FieldValue信息
* @param type 导入或导出
* @param rowNum 行号
* @return 解析结果对应的value
* @throws Exception
*/
public Object resolveFieldValue(Object bean,Object value, FieldValue fieldValue, Type type,int rowNum) throws Exception;
}
核心只有一个方法resolveFieldValue。
我们可以自定义它的实现类，然后把全类名注册到 resolveFieldValueConverterName
属性上如：假设创建人是需要查询用户表进行校验，如果没有则不允许导入，我们则可以在自定义的实现类抛出一个异常，可以精准的提示用户多少行，哪一个字段【标题】的值错误了。
直接上代码，下面是导入导出封装好工具类。
/**
* Excel 导出方法调用(主)
*/
public class ExcelUtil {
//创建excel上下文实例,配置文件路径
private ExcelContext context;
//Excel配置文件中配置的id
private String excelId;
public ExcelUtil(ExcelContext context, String excelId) {
this.context = context;
this.excelId = excelId;
}
/**
* @param startRow 头部从第几行开始导入
* @param fis 文件流
* @return
* @throws Exception
*/
public List importExcel(int startRow, InputStream fis) throws Exception {
//第二个参数需要注意,它是指标题索引的位置,可能你的前几行并不是标题,而是其他信息,
//比如数据批次号之类的,关于如何转换成javaBean,具体参考配置信息描述
ExcelImportResult result = context.readExcel(excelId, startRow, fis);
// System.out.println(result.getHeader());
List stus = result.getListBean();
return stus;
//这种方式和上面的没有任何区别,底层方法默认标题索引为0
//context.readExcel(excelId, fis);
}
/**
* 导出Excel并下载
* @param response
* @param list 结果集,null默认导出模板
* @param header 自定义表头,null默认无
* @param specifyFields 导出字段,null导出所有字段
* @param fileName 下载的文件名
*/
public void exportExcel(HttpServletResponse response, List list,ExcelHeader header, List specifyFields, String fileName) {
File file = null;
OutputStream ops = null;
OutputStream out = null;
Workbook workbook = null;
try {
/**
* Step1:创建临时xlsx文件
*/
file = File.createTempFile("tmp", ".xlsx");
/**
* Step2:导出数据写入临时xlsx文件
*/
String path = file.getAbsolutePath();
ops = new FileOutputStream(path);
//获取POI创建结果
if (list != null && !list.isEmpty()) {
workbook = context.createExcel(excelId, list, header, specifyFields);
// workbook = context.createExcel(excelId, list);
} else {//查询结果为空,导出模板
workbook = context.createExcelTemplate(excelId, header, specifyFields);
}
workbook.write(ops);
/**
* Step3:下载临时xlsx文件
*/
response.reset();
response.setContentType("application/octet-stream; charset=utf-8");
fileName = URLEncoder.encode(fileName + ".xlsx", "UTF-8");
response.setHeader("Content-Disposition", "attachment; filename=" + fileName);
out = response.getOutputStream();
out.write(FileUtils.readFileToByteArray(file));
out.flush();
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
} finally {
file.deleteOnExit();//临时文件若存在,则删除
try {
if (ops != null) {
ops.close();
}
if (workbook != null) {
workbook.close();
}
if (out != null) {
out.close();
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
好了，本文到此结束，带大家了解了《Java Excel导入导出，基于XML和Easy-excel使用》，希望本文对你有所帮助！关注golang学习网公众号，给大家分享更多数据库知识！
-
499 收藏
-
244 收藏
-
235 收藏
-
157 收藏
-
101 收藏
-
475 收藏
-
266 收藏
-
273 收藏
-
283 收藏
-
210 收藏
-
371 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案，代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景，打造一站式知识长龙服务，适合有JS基础的同学学习。
- 立即学习 542次学习
-
- GO语言核心编程课程
- 本课程采用真实案例，全面具体可落地，从理论到实践，一步一步将GO核心编程技术、编程思想、底层实现融会贯通，使学习者贴近时代脉搏，做IT互联网时代的弄潮儿。
- 立即学习 507次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信：Le-studyg；在课程中，我们将首先介绍MySQL8的新特性，包括性能优化、安全增强、新数据类型等，帮助学生快速熟悉MySQL8的最新功能。接着，我们将深入解析MySQL的网络通信机制，包括协议、连接管理、数据传输等，让
- 立即学习 497次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网，分为导航，轮播，关于我们，成功案例，服务流程，团队介绍，数据部分，公司动态，底部信息等内容区块。网站整体采用CSSGrid布局，支持响应式，有流畅过渡和展现动画。
- 立即学习 484次学习
-
- 甜蜜的大米
- 这篇技术贴出现的刚刚好，太细致了，感谢大佬分享，已收藏，关注up主了！希望up主能多写数据库相关的文章。
- 2023-01-26 08:39:36
-
- 敏感的鸵鸟
- 很有用，一直没懂这个问题，但其实工作中常常有遇到...不过今天到这，看完之后很有帮助，总算是懂了，感谢大佬分享博文！
- 2023-01-24 07:14:00
-
- 高高的星星
- 这篇技术文章真是及时雨啊，作者加油！
- 2023-01-16 22:26:52
-
- 温柔的铃铛
- 细节满满，已收藏，感谢up主的这篇博文，我会继续支持！
- 2023-01-16 16:31:21
-
- 美好的发夹
- 这篇文章真及时，太全面了，很棒，收藏了，关注大佬了！希望大佬能多写数据库相关的文章。
- 2023-01-15 11:27:54
-
- 凶狠的水杯
- 太给力了，一直没懂这个问题，但其实工作中常常有遇到...不过今天到这，看完之后很有帮助，总算是懂了，感谢作者大大分享技术贴！
- 2023-01-15 06:19:28