Spring Boot使用EasyExcel导入导出Excel

news2024/11/26 18:24:42

一、导入依赖

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

二、实现导出excel操作

1、对我们需要导出的实体类上加上注解，如下：

@ExcelProperty("商品编号")
private Integer gid;
@ExcelProperty("商品名称")
private String gname;
@ExcelProperty("商品价格")
private Float gprice;
@ExcelProperty("商品购买数量")
private Integer buynum;
@ExcelProperty("商品库存")
private Integer gnum;
//导出图片格式如下（照片路径一定是要真实路径，不然会报错）
//@ExcelProperty(value = {"商品图片"},converter = StringImageConverter.class)
//忽略导入
//@ExcelIgnore
@ExcelProperty("商品图片")
private String gpic;

2、编写的具类--帮助我们来实现下载excel

public class DownExcel {
    public static void download(HttpServletResponse response, Class t, List list) throws IOException, IllegalAccessException,InstantiationException {
        response.setContentType("application/vnd.ms-excel");// 设置文本内省
        response.setCharacterEncoding("utf-8");// 设置字符编码
        response.setHeader("Content-disposition", "attachment;filename=demo.xlsx"); // 设置响应头
        EasyExcel.write(response.getOutputStream(), t).sheet("模板").doWrite(list); //用io流来写入数据
    }
}

3、编写控制器

//导出为Excel
@RequestMapping("/downloadexcel.do")
public void getExcel(HttpServletResponse response) throws IllegalAccessException, IOException, 
InstantiationException {
    List<SysUser> list = sysUserService.getAll();
    DownExcel.download(response,SysUser.class,list);
}

4、直接访问接口或用postman（http://localhost:8080/userctrl/downloadexcel.do）下载excel,excel如图所示：

三、实现导入excel操作

1、在mybatis的mapper里面添加一个接口（保存集合，实现批量导入）

int saveAll(List<SysUser> sysUsers);

xml如图所示：

<insert id="saveAll" parameterType="java.util.List">
    insert into sys_user (name,nick_name,avatar,password,salt,email,mobile,status,dept_id,create_by,create_time,last_update_by,last_update_time)
    values
    <foreach collection="list" item="item" index="index" separator=",">
        (
            #{item.name},
            #{item.nickName},
            #{item.avatar},
            #{item.password},
            #{item.salt},
            #{item.email},
            #{item.mobile},
            #{item.status},
            #{item.deptId},
            #{item.createBy},
            #{item.createTime},
            #{item.lastUpdateBy},
            #{item.lastUpdateTime}
        )
    </foreach>
  </insert>

2、创建service和service实现类，如下：

void saveList(List<SysUser> list);

@Override
public void saveList(List<SysUser> list) {
    sysUserMapper.saveAll(list);
}

3、导入数据的时候需要对这个进行监听，所以也需要写一个工具类，来帮忙我们处理这些数据，代码如图：

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

    private List<SysUser> list = new ArrayList<>();
    /**
     * 每隔5条存储数据库，实际使用中可以3000条，然后清理list ，方便内存回收
     */
    private static final int BATCH_COUNT = 5;

    /**
     * 假设这个是一个DAO，当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。
     */
    private SysUserService sysUserService;

    /**
     * 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来
     */
    public ExcelListener(SysUserService sysUserService) {
        this.sysUserService = sysUserService;
    }


    /**
     * 这个每一条数据解析都会来调用
     */
    @Override
    public void invoke(SysUser goods, AnalysisContext analysisContext) {
        System.out.println("解析到一条数据:========================"+goods.toString());
        // 数据存储到datas，供批量处理，或后续自己业务逻辑处理。
        list.add(goods);
        // 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOM
        if(list.size() >= BATCH_COUNT){
            saveData();
            // 存储完成清理datas
            list.clear();
        }

    }

    /**
     * 所有数据解析完成了 都会来调用
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        saveData();//确保所有数据都能入库
    }

    /**
     * 加上存储数据库
     */
    private void saveData() {
        System.out.println("=============================="+list.size()+"条数据，开始存储到数据库");
        sysUserService.saveList(list);
    }

}

4、控制器添加导入操作代码

//导入Excel
@RequestMapping("/importexcel.do")
@ResponseBody
public String importexcel(@RequestParam(value = "excelFile") MultipartFile file) throws IOException{
    EasyExcel.read(file.getInputStream(), SysUser.class, new ExcelListener(sysUserService)).sheet().doRead();
    return "success";
}

5、使用页面导入或者使用postman调用（http://localhost:8080/userctrl/importexcel.do）

    <h2>
        <form action="../userctrl/importexcel.do" method="post" enctype="multipart/form-data">
            导入Excel：<input type="file" name="excelFile" accept=".xls,.xlsx">
            <input type="submit" value="提交">
        </form>
    </h2>