当前位置： 首页 > news >正文

Spring Boot 3 + EasyExcel 文件导入导出实现

news 2025/9/17 6:23:59

SpringBoot集成EasyExcel 3.x：高效实现Excel数据的优雅导入与导出

在现代企业应用中，Excel作为数据交换的重要工具，几乎无处不在。如何高效且优雅地实现Excel数据的导入与导出，是每个开发者都需要面对的问题。EasyExcel是阿里巴巴开源的一个高性能Excel处理库，它可以大大简化Excel操作。在本文中，我将介绍如何在SpringBoot项目中集成EasyExcel 3.x，并实现Excel数据的导入与导出。

1. 项目依赖配置 (pom.xml)

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>3.2.0</version><relativePath/></parent><groupId>com.example</groupId><artifactId>excel-demo</artifactId><version>1.0.0</version><properties><java.version>17</java.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>com.alibaba</groupId><artifactId>easyexcel</artifactId><version>3.3.2</version></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId></dependency></dependencies>
</project>

2. 实体类定义

import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.annotation.write.style.ColumnWidth;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.Pattern;
import jakarta.validation.constraints.Size;
import lombok.Data;/*** @Description: 用于Excel导入导出数据映射* @date 2025/9/15 15:34*/
@Data
public class TerminalImportVO {@ExcelProperty(value = "IMEI", index = 0)@NotBlank(message = "IMEI不能为空")@Size(min = 3, max = 20, message = "IMEI必须为3-15位数字")@Pattern(regexp = "\\d+", message = "IMEI必须为数字")@ColumnWidth(20)private String imei;
}

3. Excel监听器（用于导入数据处理）

import cn.hutool.core.util.ObjectUtil;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.read.listener.ReadListener;
import com.alibaba.excel.util.ListUtils;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.cetcnav.entity.TerminalInfo;
import com.cetcnav.exception.ExcelImportException;
import com.cetcnav.service.TerminalInfoService;
import com.cetcnav.vo.TerminalImportVO;
import jakarta.validation.ConstraintViolation;
import jakarta.validation.Validation;
import jakarta.validation.Validator;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.BeanUtils;import java.util.ArrayList;
import java.util.List;
import java.util.Set;/*** @Description: Excel导入数据监听器 处理终端数据的读取和验证* @date 2025-09-15 15:37*/
@Slf4j
public class TerminalExcelListener implements ReadListener<TerminalImportVO> {/*** 每隔100条存储数据库，然后清理list，方便内存回收*/private static final int BATCH_COUNT = 100;/*** 缓存的数据*/private List<TerminalInfo> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);private final TerminalInfoService terminalInfoService;public TerminalExcelListener(TerminalInfoService terminalInfoService) {this.terminalInfoService = terminalInfoService;}/*** 验证器*/private final Validator validator = Validation.buildDefaultValidatorFactory().getValidator();/*** 错误信息收集*/private final List<String> errors = new ArrayList<>();/*** 总行数（包括表头）*/@Getterprivate int totalRowNum = 0;/*** 成功处理的数据行数* -- GETTER --* 获取成功处理的数量*/@Getterprivate int successCount = 0;/*** 是否已经抛出异常（防止重复抛出）*/private boolean hasThrownException = false;/*** 每一条数据解析都会来调用*/@Overridepublic void invoke(TerminalImportVO terminalImportVO, AnalysisContext analysisContext) {totalRowNum++;// Excel行号从1开始int currentRowNum = analysisContext.readRowHolder().getRowIndex() + 1;log.info("解析到第{}行数据: {}", currentRowNum, terminalImportVO);try {// 1. 基本数据校验if (terminalImportVO.getImei() == null) {errors.add(String.format("第%d行%s", currentRowNum, "终端imei不能为空"));return;}// 2. 数据校验 注解校验Set<ConstraintViolation<TerminalImportVO>> violations = validator.validate(terminalImportVO);if (!violations.isEmpty()) {for (ConstraintViolation<TerminalImportVO> violation : violations) {String fieldName = violation.getPropertyPath().toString();String errorMsg = violation.getMessage();errors.add(String.format("第%d行%s", currentRowNum, errorMsg));}// 校验失败，跳过该行数据return;}// 3. 业务逻辑校验if (!validateBusinessRules(terminalImportVO, currentRowNum)) {return;}// 4. 数据去重校验（防止重复导入）if (isDuplicateUser(terminalImportVO, currentRowNum)) {return;}log.info("第{}行数据校验通过", currentRowNum);// 校验通过，添加到缓存列表TerminalInfo terminalInfo = new TerminalInfo();BeanUtils.copyProperties(terminalImportVO, terminalInfo);cachedDataList.add(terminalInfo);successCount++;// 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOMif (cachedDataList.size() >= BATCH_COUNT) {saveData();// 存储完成清理 listcachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);}} catch (Exception e) {errors.add(String.format("第%d行%s", currentRowNum, "数据处理异常"));log.error("第{}行数据处理异常", currentRowNum);}}/*** 所有数据解析完成后会来调用** @param analysisContext 分析上下文*/@Overridepublic void doAfterAllAnalysed(AnalysisContext analysisContext) {try {// 这里也要保存数据，确保最后遗留的数据也存储到数据库saveData();log.info("Excel解析完成！总行数: {}, 成功: {}, 失败: {}", totalRowNum - 1, successCount, errors.size());// 如果有错误，抛出包含所有错误信息的异常if (!errors.isEmpty() && !hasThrownException) {hasThrownException = true;// 减1是排除表头行throw new ExcelImportException(errors, totalRowNum - 1);}} catch (Exception e) {log.error("数据最终处理异常：{}", e.getMessage());if (!hasThrownException) {hasThrownException = true;throw new RuntimeException("数据处理异常: " + e.getMessage());}}}/*** 保存数据到数据库*/private void saveData() {if (cachedDataList.isEmpty()) {return;}try {log.info("开始保存{}条数据到数据库", cachedDataList.size());terminalInfoService.saveBatch(cachedDataList);log.info("存储数据库成功！");} catch (Exception e) {log.error("数据保存失败:{}", e);// 记录批量保存失败的错误for (TerminalInfo terminalInfo : cachedDataList) {int estimatedRowNum = totalRowNum - cachedDataList.size() + cachedDataList.indexOf(terminalInfo) + 1;errors.add(String.format("第%d行%s", estimatedRowNum, "数据保存失败"));}// 从成功计数中减去这些失败的数据successCount -= cachedDataList.size();}}/*** 业务规则校验** @param terminalImportVO 终端数据* @param rowNum           行号* @return 是否通过校验*/private boolean validateBusinessRules(TerminalImportVO terminalImportVO, int rowNum) {LambdaQueryWrapper<TerminalInfo> queryWrapper = new LambdaQueryWrapper<>();queryWrapper.eq(TerminalInfo::getImei, terminalImportVO.getImei());queryWrapper.eq(TerminalInfo::getDelFlag, 0);TerminalInfo terminalInfo = terminalInfoService.getOne(queryWrapper);if (ObjectUtil.isNotEmpty(terminalInfo)) {errors.add(String.format("第%d行%s", rowNum,  String.format("终端imei: %s 已存在！", terminalImportVO.getImei())));return false;}return true;}/*** 检查是否重复终端imei** @param terminalImportVO 终端数据* @param rowNum           行号* @return 是否重复*/private boolean isDuplicateUser(TerminalImportVO terminalImportVO, int rowNum) {for (TerminalInfo terminalInfo : cachedDataList) {if (terminalInfo.getImei().equals(terminalImportVO.getImei())) {errors.add(String.format("第%d行%s", rowNum, "终端imei重复: " + terminalImportVO.getImei()));return true;}}return false;}/*** 获取错误信息列表** @return 错误信息列表*/public List<String> getErrors() {return new ArrayList<>(errors);}/*** 获取失败数量** @return 失败数量*/public int getFailedCount() {return errors.size();}
}

4. 控制器层

@GetMapping("/template")@Operation(summary = "下载导入模板")public void downloadTemplate(HttpServletResponse response) throws IOException {try {// 设置响应头setExcelResponseHeader(response, "终端导入模板");// 创建一个空的用户列表（只有表头）List<TerminalImportVO> emptyList = List.of();// 写入ExcelEasyExcel.write(response.getOutputStream(), TerminalImportVO.class).excelType(ExcelTypeEnum.XLSX).sheet("终端数据").doWrite(emptyList);log.info("模板下载成功");} catch (Exception e) {log.error("模板下载失败", e);response.reset();response.setContentType("application/json");response.setCharacterEncoding("utf-8");response.getWriter().println("{\"code\":500,\"message\":\"模板下载失败:\" + e.getMessage() + \"\"}");}}/*** 导入Excel数据*/@PostMapping("/import")@Operation(summary = "导入Excel数据")public ApiResponse<ExcelImportResponse> importExcel(@RequestParam("file") MultipartFile file) throws IOException {if (file.isEmpty()) {return ApiResponse.error("文件为空！");}// 检查文件类型String filename = file.getOriginalFilename();if (filename == null || (!filename.endsWith(".xlsx") && !filename.endsWith(".xls"))) {return ApiResponse.error("请上传Excel文件(.xlsx或.xls)");}TerminalExcelListener listener = new TerminalExcelListener(terminalInfoService);try {// 读取Excel文件EasyExcel.read(file.getInputStream(), TerminalImportVO.class, listener).sheet().doRead();// 如果没有错误，返回成功响应ExcelImportResponse response = new ExcelImportResponse(listener.getTotalRowNum(), listener.getSuccessCount(), listener.getFailedCount(), listener.getErrors());return ApiResponse.success(response.getSummaryMessage(), response);} catch (ExcelImportException e) {// 捕获自定义异常，返回详细的错误信息ExcelImportResponse response = new ExcelImportResponse(e.getTotalRows(), e.getSuccessRows(), e.getFailedRows(), e.getErrors());return ApiResponse.error(response.getSummaryMessage(), HttpStatusConstant.ERROR, response);} catch (Exception e) {log.error("导入失败", e);return ApiResponse.error("导入失败: " + e.getMessage());}}/*** 导出Excel数据*/@GetMapping("/export")@Operation(summary = "导出Excel数据")public void exportExcel(HttpServletResponse response) throws IOException {try {// 设置响应头setExcelResponseHeader(response, "终端数据导出");// 获取数据List<TerminalInfo> terminalInfoList = terminalInfoService.list();// 写入ExcelEasyExcel.write(response.getOutputStream(), TerminalInfo.class).excelType(ExcelTypeEnum.XLSX).sheet("终端数据").doWrite(terminalInfoList);log.info("导出成功，共{}条数据", terminalInfoList.size());} catch (Exception e) {log.error("导出失败", e);response.reset();response.setContentType("application/json");response.setCharacterEncoding("utf-8");response.getWriter().println("{\"code\":500,\"message\":\"导出失败:\" + e.getMessage() + \"\"}");}}/*** 设置Excel响应头*/private void setExcelResponseHeader(HttpServletResponse response, String rawFileName) throws IOException {String fileName = URLEncoder.encode(rawFileName, StandardCharsets.UTF_8).replaceAll("\\+", "%20");response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");response.setCharacterEncoding("utf-8");response.setHeader("Content-Disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");}

5. 全局异常处理

import com.cetcnav.dto.ApiResponse;
import com.cetcnav.dto.ExcelImportResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.multipart.MaxUploadSizeExceededException;import java.util.List;
import java.util.stream.Collectors;/*** @Description: 全局异常处理器* @date 2025-09-15 14:59*/
@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {/*** 处理Excel导入异常*/@ExceptionHandler(ExcelImportException.class)public ApiResponse<Object> handleExcelImportException(ExcelImportException e) {log.warn("Excel导入数据校验失败: {}", e.getErrorSummary());return ApiResponse.error(e.getMessage(), 400);}/*** 处理文件大小超过限制异常*/@ExceptionHandler(MaxUploadSizeExceededException.class)public ApiResponse<Object> handleMaxUploadSizeExceededException(MaxUploadSizeExceededException e) {log.warn("文件大小超过限制", e);return ApiResponse.error("文件大小不能超过10MB");}/*** 处理所有其他异常*/@ExceptionHandler(Exception.class)public ApiResponse<Object> handleException(Exception e) {log.error("系统异常", e);return ApiResponse.error("系统异常: " + e.getMessage());}
}

6.Excel导入响应对象

import lombok.Getter;
import java.util.List;/*** @Description: Excel导入响应对象* @date 2025-09-15 16:24*/
@Getter
public class ExcelImportException extends RuntimeException {private final List<String> errors;private final int totalRows;private final int successRows;private final int failedRows;public ExcelImportException(List<String> errors, int totalRows) {super("Excel导入完成，但有部分数据校验失败，请查看详细信息");this.errors = errors;this.totalRows = totalRows;this.successRows = totalRows - errors.size();this.failedRows = errors.size();}/*** 获取简化的错误摘要信息（用于日志等）*/public String getErrorSummary() {if (errors.isEmpty()) {return "无错误";}StringBuilder summary = new StringBuilder();summary.append("共").append(errors.size()).append("处错误：");// 按错误类型统计errors.forEach(message -> summary.append(message).append("; "));return summary.toString();}
}

文章转载自：

http://AmZ5zEHL.qrzqd.cn
http://SrdzPeQB.qrzqd.cn
http://KyyqrVdW.qrzqd.cn
http://U5mfcT3f.qrzqd.cn
http://Xni3D2R6.qrzqd.cn
http://mUINDVM0.qrzqd.cn
http://IkR1lCxb.qrzqd.cn
http://1dpifyWB.qrzqd.cn
http://nw43ToCj.qrzqd.cn
http://Sjbug5qT.qrzqd.cn
http://8Osh4HaN.qrzqd.cn
http://L2b8f6gr.qrzqd.cn
http://x3YzI9KK.qrzqd.cn
http://S1rLm4KB.qrzqd.cn
http://kjAWkHaL.qrzqd.cn
http://gZvVbT03.qrzqd.cn
http://OCzU1roL.qrzqd.cn
http://LNxCko0R.qrzqd.cn
http://iDCkQeWy.qrzqd.cn
http://8f6VCqLk.qrzqd.cn
http://2mxB0yVr.qrzqd.cn
http://SzPdVSy1.qrzqd.cn
http://ZuDMsx8K.qrzqd.cn
http://GYaOLryk.qrzqd.cn
http://O5k81Oef.qrzqd.cn
http://kGmdMfJr.qrzqd.cn
http://ZSydl2a1.qrzqd.cn
http://ddyTAV9t.qrzqd.cn
http://Vvre68Es.qrzqd.cn
http://pWTKuahD.qrzqd.cn
http://www.dtcms.com/a/386016.html

相关文章：

  • 9.16总结
  • Android开机时间查看
  • 探针水平的表达矩阵转换为基因水平的表达矩阵是芯片数据分析中关键的一步
  • PHP基础-语法初步（第七天）
  • 奥威BI与ChatBI：自然语言交互赋能企业数据分析新体验
  • Vue: 组件基础
  • 亚马逊云科技 EC2 服务终端节点：安全高效访问云服务的利器
  • 2026届计算机毕业设计选题 大数据毕业设计选题推荐 题目新颖 数据分析 可视化大屏 通过率高
  • html实现文字横向对齐以及margin的解释
  • 如何轻松找到并畅玩Edge浏览器隐藏的冲浪小游戏
  • K8S中的神秘任务Job与CronJob
  • go grpc开发使用
  • [论文阅读] 人工智能 + 软件工程 | 告别冗余HTML与高算力消耗：EfficientUICoder如何破解UI2Code的token难题
  • Golang语言入门篇004_Go命令详解
  • K8S的Pod状态处理指南
  • Gin框架：构建高性能Go Web应用
  • Golang中的NaN（Not a Number）
  • golang 做webrtc开发核心
  • Go语言中 error 接口与自定义错误类型的深入解析
  • D008 vue+django+neo4j基于知识图谱的政务服务搜索推荐系统
  • 一个高精度通用模板
  • Flink 1.17.2 集群安装部署
  • Git 本地分支推送多个远程分支
  • JVM性能监控与调优（一）：命令行工具
  • 协方差——————
  • Node.js 框架 Express 介绍
  • Node.js 文件上传中文文件名乱码问题，为什么只有Node会有乱码问题，其他后端框架少见？
  • Redis 线上遍历 Key 的正确姿势：SCAN 命令详解
  • 【软考】笔记总结二
  • gemini cli 一个可以参考的prompt