easy Excel
EasyExcel官方文档 - 基于Java的Excel处理工具 | Easy Excel 官网
**java解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存,poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题,但POI还是有一些缺陷,比如07版Excel解压缩以及解压后存储都是在内存中完成的,内存消耗依然很大。easyexcel重写了poi对07版Excel的解析,一个3M的excel用POI sax解析依然需要100M左右内存,改用easyexcel可以降低到几M,并且再大的excel也不会出现内存溢出;03版依赖POI的sax模式,在上层做了模型转换的封装,让使用者更加简单方便
完成写
- 导入依赖
<!-- EasyExcel -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>3.3.1</version>
</dependency>
- 创建实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
@ExcelProperty(value = "姓名", index = 0)
private String name;
@ExcelProperty(value = "年龄", index = 1)
private Integer age;
@ExcelProperty(value = "性别", index = 2)
private String sex;
@ExcelProperty(value = "地址", index = 3)
private String address;
}
- 测试
@Test
void write(){
// 文件输出的路径
String fileName = System.currentTimeMillis() + ".xlsx";
// 这里 需要指定写用哪个class去写,然后写到第一个sheet,名字为模板 然后文件流会自动关闭
List<Student> list = new ArrayList<>();
list.add(new Student("张三丰", 25,"男","驻马店"));
list.add(new Student("郭靖", 29,"男", "上蔡县"));
list.add(new Student("蓉儿", 25,"女", "东洪镇"));
list.add(new Student("云朵", 15,"女", "赵楼村"));
EasyExcel.write(fileName, Student.class).sheet("学生信息").doWrite(list);
}
web 的下载数据
- 依赖
<!-- EasyExcel -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>3.3.1</version>
</dependency>
- controller 层
@GetMapping("/download")
public void download(HttpServletResponse response) throws IOException {
// 这里注意 有同学反应使用swagger 会导致各种问题,请直接用浏览器或者用postman
response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
response.setCharacterEncoding("utf-8");
// 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
String fileName = URLEncoder.encode("测试", "UTF-8").replaceAll("\\+", "%20");
response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
/*后面这些数据可以从数据库中查到*/
List<Student> list = new ArrayList<>();
list.add(new Student("张三丰", 25,"男","驻马店"));
list.add(new Student("郭靖", 29,"男", "上蔡县"));
list.add(new Student("蓉儿", 25,"女", "东洪镇"));
list.add(new Student("云朵", 15,"女", "赵楼村"));
EasyExcel.write(response.getOutputStream(), Student.class).sheet("模板").doWrite(list);
}
- 测试
http://localhost:8080/download
浏览器直接打开立马下载
读操作
- 导入依赖
<!-- EasyExcel -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>3.3.1</version>
</dependency>
- 创建实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
@ExcelProperty(value = "姓名", index = 0)
private String name;
@ExcelProperty(value = "年龄", index = 1)
private Integer age;
@ExcelProperty(value = "性别", index = 2)
private String sex;
@ExcelProperty(value = "地址", index = 3)
private String address;
}
- 创建监听器
public class DemoDataListener implements ReadListener<Student> {
/**
* 每隔5条存储数据库,实际使用中可以100条,然后清理list ,方便内存回收
*/
private static final int BATCH_COUNT = 100;
/**
* 缓存的数据
*/
private List<Student> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
/**
* 假设这个是一个DAO,当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。
*/
private final StudentDao studentDao;
public DemoDataListener() {
// 这里是demo,所以随便new一个。实际使用如果到了spring,请使用下面的有参构造函数
studentDao = new StudentDao();
}
/**
* 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来
*
* @param studentDao s
*/
public DemoDataListener(StudentDao studentDao) {
this.studentDao = studentDao;
}
/**
* 这个每一条数据解析都会来调用
*/
@Override
public void invoke(Student student, AnalysisContext context) {
cachedDataList.add(student);
// 达到BATCH_COUNT了,需要去存储一次数据库,防止数据几万条数据在内存,容易OOM
if (cachedDataList.size() >= BATCH_COUNT) {
saveData();
// 存储完成清理 list
cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
}
}
/**
* 所有数据解析完成了 都会来调用
*
*/
@Override
public void doAfterAllAnalysed(AnalysisContext context) {
// 这里也要保存数据,确保最后遗留的数据也存储到数据库
saveData();
System.out.println("所有数据解析完成!");
}
/**
* 加上存储数据库
*/
private void saveData() {
System.out.println("{"+cachedDataList.size()+"}条数据,开始存储数据库!");
studentDao.save(cachedDataList);
System.out.println("存储数据库成功!");
}
}
:::tips
监听器:
- 由于这里的监听器类并未交给 spring 管理因此上面的
StudenDao
不能通过自动注入的方式来直接写,这里采用构造器的方式注入。 - 这里调用的方法,后面真正调用时就直接存入到数据库了,(最好采用批量添加的方式)
:::
- StudentDao
@Repository
public class StudentDao {
public void save(List<Student> students) {
// 我们这里测试先打印出来,后面可以直接添加到数据库
students.forEach(System.out::println);
System.out.println("保存成功");
}
}
- 测试
@Test
void read() throws UnsupportedEncodingException, FileNotFoundException {
// 文件的绝对路径
String fileName = "D:\\IdeaProjects\\easyExcel\\easyExcel\\AAA1721460305714.xlsx";
// 这里默认读取第一个sheet
EasyExcel.read(fileName, Student.class, new DemoDataListener()).sheet().doRead();
}
读操作 web
- 引入依赖
<!-- EasyExcel -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>3.3.1</version>
</dependency>
<!-- 文件上传依赖 -->
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.4</version>
</dependency>
- 创建实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
@ExcelProperty(value = "姓名", index = 0)
private String name;
@ExcelProperty(value = "年龄", index = 1)
private Integer age;
@ExcelProperty(value = "性别", index = 2)
private String sex;
@ExcelProperty(value = "地址", index = 3)
private String address;
}
- 创建监听器
public class DemoDataListener implements ReadListener<Student> {
/**
* 每隔5条存储数据库,实际使用中可以100条,然后清理list ,方便内存回收
*/
private static final int BATCH_COUNT = 100;
/**
* 缓存的数据
*/
private List<Student> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
/**
* 假设这个是一个DAO,当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。
*/
private final StudentDao studentDao;
public DemoDataListener() {
// 这里是demo,所以随便new一个。实际使用如果到了spring,请使用下面的有参构造函数
studentDao = new StudentDao();
}
/**
* 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来
*
* @param studentDao s
*/
public DemoDataListener(StudentDao studentDao) {
this.studentDao = studentDao;
}
/**
* 这个每一条数据解析都会来调用
*/
@Override
public void invoke(Student student, AnalysisContext context) {
cachedDataList.add(student);
// 达到BATCH_COUNT了,需要去存储一次数据库,防止数据几万条数据在内存,容易OOM
if (cachedDataList.size() >= BATCH_COUNT) {
saveData();
// 存储完成清理 list
cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
}
}
/**
* 所有数据解析完成了 都会来调用
*
*/
@Override
public void doAfterAllAnalysed(AnalysisContext context) {
// 这里也要保存数据,确保最后遗留的数据也存储到数据库
saveData();
System.out.println("所有数据解析完成!");
}
/**
* 加上存储数据库
*/
private void saveData() {
System.out.println("{"+cachedDataList.size()+"}条数据,开始存储数据库!");
studentDao.save(cachedDataList);
System.out.println("存储数据库成功!");
}
}
:::tips
监听器:
- 由于这里的监听器类并未交给 spring 管理因此上面的
StudenDao
不能通过自动注入的方式来直接写,这里采用构造器的方式注入。 - 这里调用的方法,后面真正调用时就直接存入到数据库了,(最好采用批量添加的方式)
:::
- StudentDao
@Repository
public class StudentDao {
public void save(List<Student> students) {
// 我们这里测试先打印出来,后面可以直接添加到数据库
students.forEach(System.out::println);
System.out.println("保存成功");
}
}
- controller 层
@Autowired
private StudentDao studentDao;
@ResponseBody
@PostMapping("/upload")
public String upload(MultipartFile file) throws IOException {
EasyExcel.read(file.getInputStream(), Student.class, new DemoDataListener(studentDao)).sheet().doRead();
return "success";
}
- 这里的测试需要借助
**Apipost**
** 或 ****postman**
:::tips
这里的参数名和类型都要选择正确,否者就会报空指针异常
:::