WMS、ERP等管理系统经常涉及库存、人员信息的管理,通常我们会提供一个模板,此模块我们可以使用easyExcel导出数据生成的一个Excel文件当作模板,提供下载链接。用户在该文件内填入规定的数据格式以后可以批量导入数据到数据库中。
controller层:
//excel批量导入用户数据
@PostMapping("/user/import")
public Object addUserList(@RequestParam("file") MultipartFile file) {
try {
BufferedInputStream in = new BufferedInputStream(file.getInputStream());
//调用写的一个工具类传入 文件流,所要转换存储的类,以及业务逻辑(我这边直接就是插入语句)
ExcelUtils.readExcel(in, User.class,userDao);
}catch (Exception e){
e.printStackTrace();
}
return "ok";
}
ExcelUtils工具类:
网上的一些工具类包括公司内部所使用的对Excel操作的工具包利用了反射、对于每个异常都做了处理有固定的返回格式和状态码,导致那那些工具包太大太乱对于新手同学来说不太友好,因此我这边就单独写了一个简易的版本,让功能实现即可。
package com.example.webdemo.utils.excel;
import com.alibaba.excel.EasyExcelFactory;
import com.alibaba.excel.ExcelReader;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.event.AnalysisEventListener;
import com.alibaba.excel.metadata.BaseRowModel;
import com.alibaba.excel.metadata.Sheet;
import com.alibaba.excel.support.ExcelTypeEnum;
import com.example.webdemo.Dao.UserDao;
import java.io.*;
import java.util.List;
/**
* @author zhangqianwei
* @date 2022/2/16 19:45
*/
public class ExcelUtils {
/**
* @param is 导入文件输入流
* @param clazz Excel实体映射类
* @return
*/
public static Boolean readExcel(InputStream is, Class clazz, UserDao userDao){
BufferedInputStream bis = null;
try {
bis = new BufferedInputStream(is);
// 解析每行结果在listener中处理
AnalysisEventListener listener = new ExcelListener(userDao);
ExcelReader excelReader = EasyExcelFactory.getReader(bis, listener);
excelReader.read(new Sheet(1, 1, clazz));
} catch (Exception e) {
e.printStackTrace();
return false;
} finally {
if (bis != null) {
try {
bis.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
return true;
}
/**
*
* @param response http请求报文
* @param clazz Excel实体映射类
* @param data 导出数据
* @return
*/
public static Boolean writeExcel(HttpServletResponse response, Class clazz, List<? extends BaseRowModel> data){
BufferedOutputStream bos= null;
try {
ServletOutputStream out = response.getOutputStream();
ExcelWriter writer = new ExcelWriter(out, ExcelTypeEnum.XLSX, true);
String fileName = "用户数据";
//这边对应的实体类改为你所导出的实体类
Sheet sheet = new Sheet(1, 0, User.class);
//设置自适应宽度
sheet.setAutoWidth(Boolean.TRUE);
// 第一个 sheet 名称
sheet.setSheetName("第一个sheet");
writer.write(data, sheet);
//通知浏览器以附件的形式下载处理,设置返回头要注意文件名有中文
response.setHeader("Content-disposition", "attachment;filename=" + new String( fileName.getBytes("gb2312"), "ISO8859-1" ) + ".xlsx");
writer.finish();
response.setContentType("multipart/form-data");
response.setCharacterEncoding("utf-8");
out.flush();
} catch (Exception e) {
e.printStackTrace();
return false;
} finally {
if (bos != null) {
try {
bos.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
return true;
}
}
监听类ExcelListener:
Excel批量导入,其实是监听解析出来的每一行数据转换为对应的类,逐个插入数据库,当然也可以监听到每一行数据时候存储到一个list中,供后续业务处理。
package com.example.webdemo.utils.excel;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import com.example.webdemo.Dao.UserDao;
import com.example.webdemo.Entity.User;
import java.util.ArrayList;
import java.util.List;
/**
* @author zhangqianwei
* @date 2022/2/16 20:03
*/
/** 解析监听器,
* 每解析一行会回调invoke()方法。
* 整个excel解析结束会执行doAfterAllAnalysed()方法
*/
public class ExcelListener extends AnalysisEventListener {
private final UserDao userDao;
//解析出来的每一行数据可以存入一个list中
private List<Object> datas = new ArrayList<Object>();
public ExcelListener(UserDao userDao) {
this.userDao = userDao;
}
@Override
public void invoke(Object object, AnalysisContext context) {
System.out.println("当前行:"+context.getCurrentRowNum());
System.out.println(object);
datas.add(object);//数据存储到list,供批量处理,或后续自己业务逻辑处理。
insert(object);//根据自己业务做处理
}
private void insert(Object object) {
User user = (User) object;
userDao.addUser(user);
}
@Override
public void doAfterAllAnalysed(AnalysisContext context) {
// datas.clear();//解析结束销毁不用的资源
}
public List<Object> getDatas() {
return datas;
}
public void setDatas(List<Object> datas) {
this.datas = datas;
}
}
User类:
使用easyExcel导出Excel时候生成的Excel文件作为模板,使用该模板进行批量导入:
数据库生成数据: