使用SpringBoot+EasyExcel+Vue实现excel表格的导入和导出详解

来源：jb51　　时间：2022/8/23 11:26:48　　对本文有异议

一、导入和导出

导入：通过解析excel表格中的数据，然后将数据放到一个集合中，接着通过对持久层操作，将数据插入到数据库中，再加载一下页面，从而实现了数据的导入

导出：导出也是直接对数据库进行操作，获取数据库中所有的数据，将其存储在一个集中，接着使用查询出来的的数据生成一个excel表格

其中导入和导出的功能实现都是基于EasyExcel实现的

EasyExcel是阿里巴巴开源的一个基于Java的简单、省内存的读写Excel的开源项目

EasyExcel官方文档：https://www.yuque.com/easyexcel/doc/easyexcel

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>easyexcel</artifactId>
            <version>2.2.0-beta2</version>
        </dependency>

二、导出数据为excel实现过程

    @GetMapping("/down")
    public Result down(HttpServletResponse response) throws IOException {
        List<User> userList = userMapper.selectList(null);
        System.out.println(userList);
        //返回输出流_excel格式
        response.setContentType("application/octet-stream");
        String fileName = URLEncoder.encode("用户信息表", "UTF-8").replaceAll("\\+", "%20");
        response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
        EasyExcel.write(response.getOutputStream(), User.class).autoCloseStream(Boolean.FALSE).sheet("用户信息表").doWrite(userList);
        // ExcelUtil.writerExcel(response, userList);
        return Result.success();
    }

查询数据库的所有数据到一个集合useList中
设置输出流
调用EasyExcel中的write方法就会返回一个excel表格
给实体类使用注解标注实体类每一个成员变量所对应的表头（value为表头名称，index为表头位置）

package com.kang.domain;
import com.alibaba.excel.annotation.ExcelProperty;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
@Data
@TableName("user")
@NoArgsConstructor
@EqualsAndHashCode
public class User {
    /**
     * id自增
     */
    @TableId(type = IdType.AUTO)
    @ExcelProperty(value = "ID", index = 0)
    private Integer id;
    @ExcelProperty(value = "用户名", index = 1)
    private String username;
    @ExcelProperty(value = "密码", index = 2)
    private String password;
    /**
     * 数据库中的nick_name会自动转换为驼峰
     */
    @ExcelProperty(value = "昵称", index = 3)
    private String nickName;
    @ExcelProperty(value = "年龄", index = 4)
    private Integer age;
    @ExcelProperty(value = "性别", index = 5)
    private String sex;
    @ExcelProperty(value = "住址", index = 6)
    private String address;
}

当浏览器访问这个前端控制器的映射地址的时候，就会自动下载这样的一个excel文件

因此，在前端只需要给按钮添加一个点击事件，当点击这个按钮的时候，就访问前端控制器，从而实现导出功能

download(){
      window.location.href='http://localhost:9090/excel/down';
      this.$message.success("导出成功");
    },

三、将excel中的数据导入到数据库中

导出功能需要用的一个文件上传的组件，这里用的是vue3组件库中element-plus提供的el-upload组件

      <el-upload
          class="upload-demo"
          multiple=""
          method="post"
          action="api/excel/updown"
          style="margin-left: 10px"
          accept=".xlsx,.xls"
          :show-file-list="false"
          :on-success="success"
          name="files"
      >
        <el-button type="primary">导入</el-button>
      </el-upload>

当前比较重要的一个属性就是action，这里action所对应的是前端控制器的映射地址，也就是说选择文件会传送到地址对应的前端控制器，前端控制就可以获取这个文件

    @PostMapping("/updown")
    public Result  upload(@RequestParam("files") MultipartFile file) throws IOException {
        EasyExcel.read(file.getInputStream(), User.class, new DataListener(userMapper)).sheet().doRead();
        return Result.success();
    }

然后通过EasyExcel的read方法实现对excel的读取功能

在read方法中需要提供一个监视器

public class DataListener extends AnalysisEventListener<User> {
    /**
     * 每隔5条存储数据库，实际使用中可以100条，然后清理list ，方便内存回收
     */
    private static final int BATCH_COUNT = 100;
    private UserMapper userMapper;
    public DataListener(UserMapper userMapper){
        this.userMapper = userMapper;
    }
    List<User> list = new ArrayList<User>();
    //读取数据会执行这方法
    @Override
    public void invoke(User user, AnalysisContext analysisContext) {
        System.out.println(JSON.toJSONString(user));
        list.add(user);
        System.out.println(list);
        if (list.size() >= BATCH_COUNT){
            list.clear();
        }
    }
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        saveData();
        System.out.println("所有数据解析完成");
    }
    private void saveData(){
        System.out.println(this.userMapper);
        System.out.println("{" + list.size() + "}条数据，开始存储数据库" );
        for (User user : list) {
            userMapper.insert(user);
        }
        System.out.println("存储数据库成功");
    }
}