SpringBoot 整合 EasyExcel

最新推荐文章于 2024-09-25 15:22:21 发布

qq_27420125

最新推荐文章于 2024-09-25 15:22:21 发布

阅读量398

点赞数 1

文章标签： java spring boot excel

本文链接：https://blog.csdn.net/qq_27420125/article/details/118445144

版权

一分钟学会 EasyExcel 的简单使用

一、引入Maven依赖

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>2.1.6</version>
</dependency>

二、官方中文文档

https://www.yuque.com/easyexcel/doc/easyexcel

三、Excel 导出（写入）

1.1 创建springboot的项目

在这里插入图片描述

1.2 编写实体类

package com.lkm.easy_excel_demo.entity;

import com.alibaba.excel.annotation.ExcelIgnore;
import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.annotation.format.DateTimeFormat;
import com.alibaba.excel.annotation.format.NumberFormat;
import com.alibaba.excel.annotation.write.style.ColumnWidth;
import com.alibaba.excel.annotation.write.style.ContentRowHeight;
import com.alibaba.excel.annotation.write.style.HeadRowHeight;

import java.io.Serializable;
import java.math.BigDecimal;
import java.net.URL;
import java.util.Date;

/**
 * 书本的实体类
 *
 * @author LiKunMou
 * @date 2021/7/3 14:53
 */

/**
 * @ContentRowHeight 设置内容（excel中每个单元格的）的行高
 * @HeadRowHeight 设置标题的行高 ，也就是字段中 “书本的基本信息” 的行高
 * @ColumnWidth 设置每个单元格的列宽
 */
@HeadRowHeight(20)
@ContentRowHeight(10)
@ColumnWidth(25)
public class Book implements Serializable {

    /**
     * 书本的id
         * @ExcelIgnore 注解是忽略忽略该属性，该属性不进行导入导出操作
     */
    @ExcelIgnore
    private Integer id;

    /**
     * 书本名称
     * @ExcelProperty是定义列名称，{"这是共有的标题","属性对应的列名称"}
     * index 是指定这个属性在excel表格中的索引位置，从0开始
     */
    @ExcelProperty(value = {"书本的基本信息","书本的名称"},index = 0)
    private String name;

    /**
     * 书本的价格
     * @ExcelProperty是定义列名称，{"这是共有的标题","属性对应的列名称"}
     * 这里的index = 2 会导致 第1列 是空的
     */
    @ExcelProperty(value = {"书本的基本信息","书本的价格"},index = 2)
    private BigDecimal price;

    /**
     * 购买的百分比
     * @NumberFormat 将double 类型进行格式转换
     */
    @NumberFormat("#.##%")
    @ExcelProperty({"书本的基本信息","购买的百分比"})
    private Double doubleData;

    /**
     * 出版日期
     * @DateTimeFormat 进行日期格式转换
     * 还可以在ExcelProperty注解中使用 converter = "xxx.class" 自定义转换
     */
    @DateTimeFormat("yyyy年MM月dd日HH时mm分ss秒")
    @ExcelProperty({"书本的基本信息","出版时间"})
    private Date publishing ;

    /**
     * 根据 url 导出图片
     */
    @ExcelProperty({"书本的基本信息","书本图片"})
    private URL url;

    
    //getter 、 setter 、toString 省略
}

1.3 编写Controller层

package com.lkm.easy_excel_demo.controller;

import com.alibaba.excel.EasyExcel;
import com.lkm.easy_excel_demo.entity.Book;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.math.BigDecimal;
import java.net.URL;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;

/**
 * Excel的Controller 类
 *
 * @author LiKunMou
 * @date 2021/7/3 15:32
 */
@RestController
@RequestMapping("/easyExcel")
public class ExcelController {

    /**
     * 下载 excel导出 
     */
    @GetMapping("/download")
    public void download(HttpServletResponse response) throws IOException {
        // 我这里用的假数据 ，可以根据需求，从数据库中查询书数据返回一个list集合
        List<Book> list = new ArrayList<>();
        Book book1 = new Book();
        book1.setId(1);
        book1.setName("法外狂徒");
        book1.setDoubleData(45.38);
        book1.setPublishing(new Date());
        book1.setPrice(new BigDecimal(99.99));
        book1.setUrl(new URL("https://raw.githubusercontent.com/alibaba/easyexcel/master/src/test/resources/converter/img.jpg"));
        Book book2 = new Book();
        book2.setId(2);
        book2.setName("mysql从删库到跑路");
        book2.setDoubleData(78.97);
        book2.setPublishing(new Date());
        book2.setPrice(new BigDecimal(88.45));
        book2.setUrl(new URL("https://raw.githubusercontent.com/alibaba/easyexcel/master/src/test/resources/converter/img.jpg"));
        list.add(book1);
        list.add(book2);

        // 设置响应回浏览器的格式，指定是个excel文件
        response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
        //指定编码格式
        response.setCharacterEncoding("utf-8");

        //第一个参数：将数据写浏览器的输出流 ，第二个参数：根据Book去将数据写入Excel中，sheet("sheet的名字") doWrite(要写入excel的数据)
        // sheet的名字建议别使用中文，可能会导致中文乱码而下载excel失败
        EasyExcel.write(response.getOutputStream(),Book.class).sheet("书本的sheet").doWrite(list);
    }
}

1.4 效果图

在这里插入图片描述

1.5 问题

实体类 @ExcelPropery() 中 index 似乎没有生效，原因可能是我们设置了标题，自动给合并了

四、Excel 导入（读取）

1.1 编写 dao 层代码

（这边只是为了测试就直接创建一个类跟方法了）正常情况下 dao层是一个接口

package com.lkm.easy_excel_demo.dao;

import com.lkm.easy_excel_demo.entity.Book;

import java.util.ArrayList;
import java.util.List;

/**
 * @author LiKunMou
 * @date 2021/7/3 16:27
 */
 // 实际这里应该是接口 
public class BookDao {
    /**
     * 这个数组就模拟数据库的表了，实际应该调用这个这个方法进行数据插入
     */
    List<Book> mysqlData = new ArrayList<>();
    
    /**
     * 添加书
     * @param list
     */
    public void addBook(List<Book> list){
        mysqlData.addAll(list);
        System.out.println(mysqlData);
    }
}

1.2 编写监听器类

（easyExcel 默认是一行一行的读，所以需要编写监听器的类）

package com.lkm.easy_excel_demo.config;

import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import com.lkm.easy_excel_demo.dao.BookDao;
import com.lkm.easy_excel_demo.entity.Book;

import java.util.ArrayList;
import java.util.List;

/**
 * easyExcel 读取excel的监听器
 *
 * @author LiKunMou
 * @date 2021/7/3 16:30
 */

// 有个很重要的点 BookListener 不能被spring管理，要每次读取excel都要new,然后里面用到spring可以构造方法传进去
public class BookListener extends AnalysisEventListener<Book> {

        /**
         * 每隔5条存储数据库，实际使用中可以3000条，然后清理list ，方便内存回收
         */
        private static final int BATCH_COUNT = 5;
        List<Book> list = new ArrayList<Book>();
        /**
         * 假设这个是一个DAO，当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。
         */
        private BookDao bookDao;
        // 通过无参构造注入 dao层的对象
        public BookListener() {
            // 这里是demo，所以随便new一个。实际使用如果到了spring,请使用下面的有参构造函数
            bookDao = new BookDao();
        }
        /**
         * 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来
         *
         * @param bookDao
         */
        public BookListener(BookDao bookDao) {
            bookDao = new BookDao();
        }
        /**
         * 这个每一条数据解析都会来调用
         *
         * @param book
         *            one row value. Is is same as {@link AnalysisContext#readRowHolder()}
         * @param context
         */
        @Override
        public void invoke(Book book, AnalysisContext context) {
            list.add(book);
            // 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOM
            if (list.size() >= BATCH_COUNT) {
                saveData();
                // 存储完成清理 list
                list.clear();
            }
        }
        /**
         * 所有数据解析完成了 都会来调用
         *
         * @param context
         */
        @Override
        public void doAfterAllAnalysed(AnalysisContext context) {
            // 这里也要保存数据，确保最后遗留的数据也存储到数据库
            saveData();
        }
        /**
         * 加上存储数据库
         */
        private void saveData() {
            //调用dao持久层的方法，将数据保存进数据库
            bookDao.addBook(list);
        }
}

1.3 编写Controller层代码

@GetMapping("/export")
public void export(MultipartFile file) throws IOException {
    // 这里实际应该 通过 @AutoWired 去取出 dao 对象
    BookDao bookDao = new BookDao();
    // 第一个参数：获取上传文件的输入流 第二个参数：根据Book类去读取Excel文件
    // new BookListener(注入Dao层的对象)) 监听器 ，在监听器中进行对数据的持久化操作
    EasyExcel.read(file.getInputStream(),Book.class,new BookListener(bookDao)).sheet().doRead();
}