SpringBoot整合EasyExcel实现导入导出

最新推荐文章于 2024-04-26 15:41:09 发布
最新推荐文章于 2024-04-26 15:41:09 发布
阅读量1k 收藏 11
点赞数 7
分类专栏： Java SpringBoot 文章标签： spring boot 后端 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_52191385/article/details/135480092
版权

1、EasyExcel是什么

EasyExcel是一个基于Java的、快速、简洁、解决大文件内存溢出的Excel处理工具。
他能让你在不用考虑性能、内存的等因素的情况下，快速完成Excel的读、写等功能。

2、相关网站

官网icon-default.png?t=N7T8https://easyexcel.opensource.alibaba.com/

GitHubicon-default.png?t=N7T8https://github.com/alibaba/easyexcel

3、实现导入

pom依赖导入

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

excel数据

一共包含姓名，手机号，性别，地址，状态，注册时间6列，共50条数据

数据库表结构

实体类User

package com.example.springbootdemo.entity;

import com.baomidou.mybatisplus.annotation.*;
import com.example.springbootdemo.enums.GenderEnum;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.experimental.Accessors;

import java.io.Serializable;
import java.time.LocalDateTime;

/**
 * <p>
 *  用户实体类
 * </p>
 *
 * @author yurenwei
 * @since 2023/9/7
 */
@ApiModel(value = "用户参数", description = "用户参数")
@Data
@Accessors(chain = true)
@TableName("user")
public class User implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 主键id
     */
    @ApiModelProperty(value = "主键id")
    @TableId(value = "id", type = IdType.ASSIGN_ID)
    private Long id;

    /**
     * 姓名
     */
    @ApiModelProperty(value = "姓名")
    private String userName;

    /**
     * 手机号
     */
    @ApiModelProperty(value = "手机号")
    private String phone;

    /**
     * 性别
     */
    @ApiModelProperty(value = "性别")
    private GenderEnum gender;

    /**
     * 地址
     */
    @ApiModelProperty(value = "地址")
    private String address;

    /**
     * 状态(0、禁用1、启用)
     */
    @ApiModelProperty(value = "状态(0、禁用1、启用)")
    private Boolean status;

    /**
     * 注册时间
     */
    @ApiModelProperty(value = "注册时间")
    @JsonDeserialize(using = LocalDateTimeDeserializer.class)
    @JsonSerialize(using = LocalDateTimeSerializer.class)
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    private LocalDateTime registerTime;

    /**
     * 创建人
     */
    @ApiModelProperty(value = "创建人")
    private Long createBy;

    /**
     * 创建时间
     */
    @ApiModelProperty(value = "创建时间")
    @JsonDeserialize(using = LocalDateTimeDeserializer.class)
    @JsonSerialize(using = LocalDateTimeSerializer.class)
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createTime;

    /**
     * 修改人
     */
    @ApiModelProperty(value = "修改人")
    private Long updateBy;

    /**
     * 修改时间
     */
    @ApiModelProperty(value = "修改时间")
    @JsonDeserialize(using = LocalDateTimeDeserializer.class)
    @JsonSerialize(using = LocalDateTimeSerializer.class)
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime updateTime;

    /**
     * 是否删除(0、否1、是)
     */
    @ApiModelProperty(value = "是否删除(0、否1、是)")
    private Boolean isDeleted;
}

controller导入方法

@ApiOperation("导入")
@PostMapping("/importUser")
public Result importUser(@RequestParam(value = "file") MultipartFile file){
    userService.importUser(file);
    return Result.ok();
}

service导入方法

/**
 * 导入excel
 *
 * @param file excel文件
 */
public void importUser(MultipartFile file) {
    try {
        EasyExcel.read(file.getInputStream(), UserExcelDTO.class, new UserExcelListener(iUserService))
                .sheet(0)
                .headRowNumber(1)
                .doRead();
    } catch (IOException e) {
        log.error("导入用户数据异常：{}",e.getMessage());
        e.printStackTrace();
    }
}

excel对应实体类

package com.example.springbootdemo.dto;

import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.annotation.format.DateTimeFormat;
import lombok.Data;

import java.io.Serializable;
import java.time.LocalDateTime;

/**
 * <p>
 *  用户excel实体类
 * </p>
 *
 * @author yurenwei
 * @since 2023/9/7
 */
@Data
public class UserExcelDTO implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 姓名
     */
    @ExcelProperty(value = "姓名",index = 0)
    private String userName;

    /**
     * 手机号
     */
    @ExcelProperty(value = "手机号",index = 1)
    private String phone;

    /**
     * 性别
     */
    @ExcelProperty(value = "性别",index = 2)
    private String gender;

    /**
     * 地址
     */
    @ExcelProperty(value = "地址",index = 3)
    private String address;

    /**
     * 状态(0、禁用1、启用)
     */
    @ExcelProperty(value = "状态",index = 4)
    private String status;

    /**
     * 注册时间
     */
    @ExcelProperty(value = "注册时间",index = 5)
    @DateTimeFormat("yyyy-MM-dd HH:mm:ss")
    private LocalDateTime registerTime;

}

此处注意# @Accessors(chain = true)与EasyExcel不兼容，不要增加此注解，要不导入数据为空

创建读取excel监听类

package com.example.springbootdemo.listener;

import cn.hutool.core.util.IdUtil;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.read.listener.ReadListener;
import com.alibaba.excel.util.ListUtils;
import com.alibaba.fastjson.JSON;
import com.example.springbootdemo.dto.UserExcelDTO;
import com.example.springbootdemo.entity.User;
import com.example.springbootdemo.enums.GenderEnum;
import com.example.springbootdemo.mybatisplus.IUserService;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.collections4.CollectionUtils;

import java.util.List;
import java.util.stream.Collectors;

/**
 * <p>
 *  用户excel监听类
 * </p>
 *
 * @author yurenwei
 * @since 2023/9/7
 */
@Slf4j
public class UserExcelListener implements ReadListener<UserExcelDTO> {

    /**
     * 每隔10条数据存储数据库，然后清理List,方便内存回收
     *
     */
    private static final int BATCH_COUNT = 10;

    /**
     * 缓存的数据
     */
    private List<UserExcelDTO> cacheList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);


    private IUserService iUserService;

    public UserExcelListener(IUserService iUserService){
        this.iUserService = iUserService;
    }

    /**
     * 每一条数据解析都会调用
     *
     * @param user
     * @param analysisContext
     */
    @Override
    public void invoke(UserExcelDTO user, AnalysisContext analysisContext) {
        log.info("解析到一条数据user:{}", JSON.toJSONString(user));
        cacheList.add(user);
        // 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOM
        if(cacheList.size()>=BATCH_COUNT){
            // 保存数据
            saveData();
            // 存储完成清理list
            cacheList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
        }
    }

    /**
     * 所有数据都解析完了才会调用
     *
     * @param analysisContext
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        // 这里也要保存数据，确保最后遗留的数据也存储到数据库
        saveData();
        log.info("所有数据解析完成！");
    }

    /**
     * 保存数据
     */
    public void saveData(){
        log.info("一共{}条数据，开始存储数据库！",cacheList.size());
        if(CollectionUtils.isNotEmpty(cacheList)){
            List<User> userList = cacheList.stream().map(item -> new User()
                    .setId(IdUtil.getSnowflakeNextId())
                    .setUserName(item.getUserName())
                    .setPhone(item.getPhone())
                    .setGender("男".equals(item.getGender())? GenderEnum.MALE:GenderEnum.FEMALE)
                    .setAddress(item.getAddress())
                    .setRegisterTime(item.getRegisterTime())
                    .setStatus("启用".equals(item.getStatus())))
                    .collect(Collectors.toList());

            // 批量保存
            iUserService.saveBatch(userList);
        }
        log.info("存储数据库成功！");
    }
}

启动项目测试导入

控制台打印信息

查看数据库是否成功导入数据

可见50条都被成功导入到数据库表当中，并且数据都是正确的。

4、接下来实现导出

controller导出方法

@ApiOperation("导出")
@PostMapping("/export")
public void export(HttpServletResponse response){
    userService.export(response);
}

service导出方法

/**
 * 导出
 *
 * @param response 响应
 */
public void export(HttpServletResponse response) {
    // 查询所有用户
    List<User> list = iUserService.list();
    // 转换数据
    List<UserExcelDTO> excelList = list.stream().map(item ->
            {
                UserExcelDTO user = new UserExcelDTO();
                user.setUserName(item.getUserName());
                user.setPhone(item.getPhone());
                user.setGender(GenderEnum.MALE.equals(item.getGender())?"男":"女");
                user.setAddress(item.getAddress());
                user.setStatus(item.getStatus()?"启用":"禁用");
                user.setRegisterTime(item.getRegisterTime());

                return user;
            })
            .collect(Collectors.toList());
    // 调用工具类导出
    ExcelUtil.exportExcel("用户数据","用户",excelList,UserExcelDTO.class,response);
}

导出excel工具类

package com.example.springbootdemo.util;

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.support.ExcelTypeEnum;
import lombok.extern.slf4j.Slf4j;

import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import java.util.List;

/**
 * <p>
 * excel工具类
 * </p>
 *
 * @author yurenwei
 * @since 2023/9/14
 */
@Slf4j
public class ExcelUtil {

    /**
     * 导出excel
     *
     * @param fileName excel文件名称
     * @param sheetName excel sheet名称
     * @param list 数据
     * @param clazz
     * @param response
     */
    public static void exportExcel(String fileName, String sheetName, List list, Class clazz, HttpServletResponse response){
        ServletOutputStream outputStream;
        try {
            response.setContentType("application/vnd.ms-excel");
            response.setCharacterEncoding("utf8");
            response.setHeader("Content-Disposition", "attachment; filename=" + fileName + ".xlsx");
            outputStream = response.getOutputStream();
            EasyExcel.write(outputStream)
                    .head(clazz)
                    .excelType(ExcelTypeEnum.XLSX)
                    .sheet(sheetName)
                    .doWrite(list);
            outputStream.flush();
        } catch (Exception e) {
            log.error("导出excel异常：{}",e.getMessage());
            e.printStackTrace();
        }
    }
}

测试导出

下载excel文件查看

通过测试导出excel 列名和数据都正确

5、总结

至此，SpringBoot整合EasyExcel实现导入导出完成了，通过整合测试发现，使用EasyExcel还是挺方便的。

_江屿_
关注
  • 7
    点赞
  • 踩
  • 11
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
案例实战-SpringBoot整合EasyExcel实现列表导出功能
06-03
【案例实战】SpringBoot整合EasyExcel实现列表导出功能源码包
SpringBoot整合EasyExcel进行报表导入导出实例Demo
11-19
SpringBoot整合EasyExcel进行报表导入导出代码实例
EasyExcel详解（结合官方文档）
热门推荐
Bananaaay的博客
12-27 1万+
EasyExcel的学习分享
EasyExcel的导入导出使用
weimenglala的博客
01-18 9130
EasyExcel导入导出的使用
JAVA实现easyExcel批量导入
m0_46300599的博客
04-26 497
注解 类型 描述 ExcelProperty 导入 指定当前字段对应excel中的那一列。可以根据名字或者Index去匹配。当然也可以不写，默认第一个字段就是index=0，以此类推。千万注意，要么全部不写，要么全部用index，要么全部用名字去匹配。千万别三个混着用，除非你非常了解源代码中三个混着用怎么去排序的。 ExcelIgnore 导入 默认所有字段都会和excel去匹配，加了这个注解会忽略该字段 DateTimeFormat 导入 日期转换，用String去接收excel日
Alibaba EasyExcel介绍和简单使用
m0_62946761的博客
03-24 7535
学习Alibaba EasyExcel的简单使用
EasyExcel 导出简单应用，简单模板导出
a____l的博客
12-15 4601
EasyExcel 导出简单应用，简单模板导出
SpringBoot集成EasyExcel实现文件导入导出
灏的博客
03-05 1543
SpringBoot整合EasyExcel详细讲解。
springboot整合easyexcel实现excel文件上传解析，下载导出简单实例.zip
11-10
best20182022-10-17 14:55:20原证springboot整合easyexcel实现excel文件上传解析，下载导出简单实例 项目描述 springboot整合easyexcel，上传解析Excel，下载导出Excel 运行环境 jdk8+tomcat9+IntelliJ IDEA+...
SpringBoot整合EasyExcel+MyBatis-Plus实现Excel批量导入和导出
最新发布
05-03
SpringBoot整合EasyExcel+MyBatis-Plus实现Excel批量导入和导出
springboot easyexcel实现数据导出成excel表格功能
10-26
Java使用springboot、easyexcel实现数据导出成excel表格功能，适用于刚入门的Java程序员或想提高知识面的朋友，该功能常用于项目数据导出，此demo通俗易懂，可以简单修改后在项目中直接使用。
Spring Boot集成EasyExcel实现数据导出
Ascend1977的博客
09-13 1119
在开发Web应用中，经常需要将数据导出为Excel文件。EasyExcel是一款功能强大的Java开发库，它提供了简单易用的API来帮助我们实现数据的导出功能，并支持一些高级特性，在EasyExcel的基础上，自定义实现如列下拉列表、自定义单元格样式、自适应列宽和行高、动态表头以及多个sheet页的数据导出。本篇博客将介绍如何使用Spring Boot集成EasyExcel库来实现这些高级数据导出功能。
Springboot整合EasyExcel用于导入
m0_46360888的博客
02-01 1312
EasyExce导入
Spring Boot + EasyExcel导入导出
s_j_z_ll的博客
06-07 559
基于SpringBoot实现EasyExcel的集成
SpringBoot整合EasyExcel实现导入功能
weixin_53818213的博客
03-02 494
springboot整合EasyExcel实现导入功能
Springboot 基于EasyPoi的excel导入导出
baidu_38945557的博客
02-20 1522
EasyPoi功能如同名字easy一样，主打的就是容易，让一个没见过也没接触过poi的人员就可以方便的写出Excel导出，Excel模板导出，Excel导入，Word模板导出，通过简单的注解和模板于洋，完成以前复杂的写法。EasyPoi起因就是Excel的导入导出，最初的模板时实体和Excel的对应。model-row,filed-col这样利用注解我们可以容易做到excel的导入导出。经过一段时间发展，现在注解有5个，分别是：@Excel作用到filed上面，是对Excel一列描述。
Excel工具类
叶
12-23 2687
Excel导入导出
springboot基础(65):导出和导入Excel文件
不积跬步，无以至千里
08-26 2121
web开发项目，经常会有导出和导出excel文件的需求。如何导出(下载到excel文件)和导入excel(从excel向系统导入数据)?excel文件的类型有.xlsexcel 2007之前的格式，包含2007.xlsxexcel 2007之后的格式，内存占用更小。.csv该文件可以以txt形式读取，内容之间用英文逗号隔开。注意:本文只涉及到xls和xlsx文件的导入和导出。csv文件的实质就是txt，所以本文不做介绍。.....................
springboot中使用EasyExcel实现Excel 导入导出
weixin_43949112的博客
08-28 806
EasyExcel 是一款基于 Java 的简单易用的 Excel 文件操作工具。它提供了丰富的 API，可以方便地读取、写入和操作 Excel 文件，支持常见的 Excel 操作，如读取/写入单元格数据、合并单元格、设置样式、处理大数据量等。EasyExcel能大大减少占用内存的主要原因是在解析Excel时没有将文件数据一次性全部加载到内存中，而是从磁盘上一行行读取数据，逐个解析。
Springboot使用EasyExcel实现导入导出代码
03-04
好的，我可以回答这个问题。Springboot使用EasyExcel实现导入导出代码可以参考以下步骤： 1. 在pom.xml文件中添加EasyExcel依赖： ``` <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>2.2.10</version> </dependency> ``` 2. 创建Excel导入导出的实体类，使用@ExcelProperty注解标注每个属性对应的Excel列名。 3. 创建Excel导入导出的工具类，使用EasyExcel提供的API实现导入导出功能。 4. 在Controller中调用工具类实现导入导出功能。 希望这个回答能够帮到你。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值