SpringBoot整合EasyExcel實(shí)現(xiàn)導(dǎo)入導(dǎo)出功能

更新時(shí)間：2023年09月21日 10:45:04 作者：皓月清風(fēng)

EasyExcel是一個(gè)基于Java的、快速、簡(jiǎn)潔、解決大文件內(nèi)存溢出的Excel處理工具,他能讓你在不用考慮性能、內(nèi)存的等因素的情況下,快速完成Excel的讀、寫等功能,本文就給大家介紹一下SpringBoot整合EasyExcel實(shí)現(xiàn)導(dǎo)入導(dǎo)出功能的方法,需要的朋友可以參考下

EasyExcel是什么

EasyExcel是一個(gè)基于Java的、快速、簡(jiǎn)潔、解決大文件內(nèi)存溢出的Excel處理工具。
他能讓你在不用考慮性能、內(nèi)存的等因素的情況下，快速完成Excel的讀、寫等功能。

實(shí)現(xiàn)

pom依賴導(dǎo)入

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

excel數(shù)據(jù)

一共包含姓名，手機(jī)號(hào)，性別，地址，狀態(tài)，注冊(cè)時(shí)間6列，共50條數(shù)據(jù)

數(shù)據(jù)庫(kù)表結(jié)構(gòu)

實(shí)體類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>
 *  用戶實(shí)體類
 * </p>
 *
 * @author yurenwei
 * @since 2023/9/7
 */
@ApiModel(value = "用戶參數(shù)", description = "用戶參數(shù)")
@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;
    /**
     * 手機(jī)號(hào)
     */
    @ApiModelProperty(value = "手機(jī)號(hào)")
    private String phone;
    /**
     * 性別
     */
    @ApiModelProperty(value = "性別")
    private GenderEnum gender;
    /**
     * 地址
     */
    @ApiModelProperty(value = "地址")
    private String address;
    /**
     * 狀態(tài)(0、禁用1、啟用)
     */
    @ApiModelProperty(value = "狀態(tài)(0、禁用1、啟用)")
    private Boolean status;
    /**
     * 注冊(cè)時(shí)間
     */
    @ApiModelProperty(value = "注冊(cè)時(shí)間")
    @JsonDeserialize(using = LocalDateTimeDeserializer.class)
    @JsonSerialize(using = LocalDateTimeSerializer.class)
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    private LocalDateTime registerTime;
    /**
     * 創(chuàng)建人
     */
    @ApiModelProperty(value = "創(chuàng)建人")
    private Long createBy;
    /**
     * 創(chuàng)建時(shí)間
     */
    @ApiModelProperty(value = "創(chuàng)建時(shí)間")
    @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;
    /**
     * 修改時(shí)間
     */
    @ApiModelProperty(value = "修改時(shí)間")
    @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導(dǎo)入方法

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

service導(dǎo)入方法

/**
 * 導(dǎo)入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("導(dǎo)入用戶數(shù)據(jù)異常：{}",e.getMessage());
        e.printStackTrace();
    }
}

excel對(duì)應(yīng)實(shí)體類

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實(shí)體類
 * </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;
    /**
     * 手機(jī)號(hào)
     */
    @ExcelProperty(value = "手機(jī)號(hào)",index = 1)
    private String phone;
    /**
     * 性別
     */
    @ExcelProperty(value = "性別",index = 2)
    private String gender;
    /**
     * 地址
     */
    @ExcelProperty(value = "地址",index = 3)
    private String address;
    /**
     * 狀態(tài)(0、禁用1、啟用)
     */
    @ExcelProperty(value = "狀態(tài)",index = 4)
    private String status;
    /**
     * 注冊(cè)時(shí)間
     */
    @ExcelProperty(value = "注冊(cè)時(shí)間",index = 5)
    @DateTimeFormat("yyyy-MM-dd HH:mm:ss")
    private LocalDateTime registerTime;
}

此處注意# @Accessors(chain = true)與EasyExcel不兼容，不要增加此注解，要不導(dǎo)入數(shù)據(jù)為空

創(chuàng)建讀取excel監(jiān)聽類

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監(jiān)聽類
 * </p>
 *
 * @author yurenwei
 * @since 2023/9/7
 */
@Slf4j
public class UserExcelListener implements ReadListener<UserExcelDTO> {
    /**
     * 每隔10條數(shù)據(jù)存儲(chǔ)數(shù)據(jù)庫(kù)，然后清理List,方便內(nèi)存回收
     *
     */
    private static final int BATCH_COUNT = 10;
    /**
     * 緩存的數(shù)據(jù)
     */
    private List<UserExcelDTO> cacheList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
    private IUserService iUserService;
    public UserExcelListener(IUserService iUserService){
        this.iUserService = iUserService;
    }
    /**
     * 每一條數(shù)據(jù)解析都會(huì)調(diào)用
     *
     * @param user
     * @param analysisContext
     */
    @Override
    public void invoke(UserExcelDTO user, AnalysisContext analysisContext) {
        log.info("解析到一條數(shù)據(jù)user:{}", JSON.toJSONString(user));
        cacheList.add(user);
        // 達(dá)到BATCH_COUNT了，需要去存儲(chǔ)一次數(shù)據(jù)庫(kù)，防止數(shù)據(jù)幾萬條數(shù)據(jù)在內(nèi)存，容易OOM
        if(cacheList.size()>=BATCH_COUNT){
            // 保存數(shù)據(jù)
            saveData();
            // 存儲(chǔ)完成清理list
            cacheList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
        }
    }
    /**
     * 所有數(shù)據(jù)都解析完了才會(huì)調(diào)用
     *
     * @param analysisContext
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        // 這里也要保存數(shù)據(jù)，確保最后遺留的數(shù)據(jù)也存儲(chǔ)到數(shù)據(jù)庫(kù)
        saveData();
        log.info("所有數(shù)據(jù)解析完成！");
    }
    /**
     * 保存數(shù)據(jù)
     */
    public void saveData(){
        log.info("一共{}條數(shù)據(jù)，開始存儲(chǔ)數(shù)據(jù)庫(kù)！",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("存儲(chǔ)數(shù)據(jù)庫(kù)成功！");
    }
}

啟動(dòng)項(xiàng)目測(cè)試導(dǎo)入

控制臺(tái)打印信息

查看數(shù)據(jù)庫(kù)是否成功導(dǎo)入數(shù)據(jù)

可見50條都被成功導(dǎo)入到數(shù)據(jù)庫(kù)表當(dāng)中，并且數(shù)據(jù)都是正確的。

接下來實(shí)現(xiàn)導(dǎo)出

controller導(dǎo)出方法

@ApiOperation("導(dǎo)出")
@PostMapping("/export")
public void export(HttpServletResponse response){
    userService.export(response);
}

service導(dǎo)出方法

/**
 * 導(dǎo)出
 *
 * @param response 響應(yīng)
 */
public void export(HttpServletResponse response) {
    // 查詢所有用戶
    List<User> list = iUserService.list();
    // 轉(zhuǎn)換數(shù)據(jù)
    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());
    // 調(diào)用工具類導(dǎo)出
    ExcelUtil.exportExcel("用戶數(shù)據(jù)","用戶",excelList,UserExcelDTO.class,response);
}

導(dǎo)出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 {
    /**
     * 導(dǎo)出excel
     *
     * @param fileName excel文件名稱
     * @param sheetName excel sheet名稱
     * @param list 數(shù)據(jù)
     * @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("導(dǎo)出excel異常：{}",e.getMessage());
            e.printStackTrace();
        }
    }
}