使用EasyExcel读取和导出Excel文件

        <!-- https://github.com/alibaba/easyexcel -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>easyexcel</artifactId>
            <version>4.0.3</version>
        </dependency>

二、编写通用导入、导出工具类

通用化的方法,适用于任意文件对象实体

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import com.study.server.easyExcel.converter.ExcelImportValid;
import com.study.server.web.exception.BaseException;

import javax.servlet.http.HttpServletResponse;
import java.io.InputStream;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.List;

/**
 * EasyExcel工具类
 *
 * @author CWW
 * @date 2024/12/18 16:46
 */
public class EasyExcelUtil {

    private static final String UTF_8 = "UTF-8";

    /**
     * 读取文件数据，并返回一个包含指定类型数据的列表。
     *
     * @param inputStream 文件对象输入流
     * @param clazz       数据对象的类型
     * @param <T>         泛型类型，表示数据对象的类型
     * @return 包含解析后数据对象的列表
     */
    public static <T> List<T> readMultipartFile(InputStream inputStream, Class<T> clazz) {
        // 用于存储解析后的数据对象
        final List<T> dataList = new ArrayList<>();

        EasyExcel.read(inputStream, clazz, new AnalysisEventListener<T>() {
            @Override
            public void invoke(T data, AnalysisContext analysisContext) {
                // 每一条数据解析都会调用此方法
                // 将解析后的数据对象添加到 dataList中
                dataList.add(data);
            }

            @Override
            public void doAfterAllAnalysed(AnalysisContext analysisContext) {
                // 读取完成后可以进行一些操作
            }
        }).sheet().doRead(); // 读取 Excel 文件中的第一个工作表

        // 返回解析后数据对象的列表
        return dataList;
    }

    /**
     * 导出 Excel文件
     *
     * @param response  HTTP 响应对象
     * @param fileName  文件名，用于在客户端保存文件时显示
     * @param sheetName 工作表名，Excel 文件中的工作表名称
     * @param list      要导出的数据列表
     * @param clazz     实体类的类对象，用于定义 Excel 文件的结构
     * @param <T>       数据列表的元素类型
     */
    public static <T> void export(HttpServletResponse response, String fileName, String sheetName, List<T> list, Class<T> clazz) {
        try {
            // 设置响应内容类型为 Excel 文件
            response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
            // 设置响应字符编码
            response.setCharacterEncoding(UTF_8);

            // 使用 URLEncoder 编码文件名，防止中文乱码
            // replaceAll("\\+", "%20") 用于将空格编码为 %20，而不是 + 号
            String fileNameEncode = URLEncoder.encode(fileName, UTF_8).replaceAll("\\+", "%20");

            // 设置响应头，告诉浏览器这是一个附件
            response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileNameEncode + ".xlsx");

            // 使用 EasyExcel 写入数据到响应的输出流
            // clazz 参数用于指定 Excel 文件的结构类
            // sheetName 参数用于指定 Excel 文件中的工作表名称
            EasyExcel.write(response.getOutputStream(), clazz)
                    .sheet(sheetName)
                    .doWrite(list);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

三、创建实体对象

import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.annotation.write.style.ColumnWidth;
import com.alibaba.excel.annotation.write.style.ContentRowHeight;
import com.alibaba.excel.annotation.write.style.HeadRowHeight;
import lombok.Data;

/**
 * 用户导入文件实体
 *
 * @author CWW
 * 2024/12/18 16:46
 */
@Data
@HeadRowHeight(20) // 头高
@ContentRowHeight(15) // 行高
@ColumnWidth(15) // 列宽
public class UserFileDataVO {

    @ExcelProperty(value = "姓名")
    private String userName;

    @ExcelProperty(value = "手机")
    private String phoneNumber;

}

四、示例方法

import com.server.common.model.ResponseResultUtil;
import com.server.common.model.ResponseResultVO;
import com.server.easyExcel.util.EasyExcelUtil;
import com.server.easyExcel.mode.UserFileDataVO;
import com.server.file.mapper.FileExportMapper;
import com.server.web.exception.BaseException;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

import javax.annotation.Resource;
import javax.servlet.http.HttpServletResponse;
import java.util.List;

/**
 * 文件导入导出控制层

 * @author CWW
 * @date 2024/12/18 11:42
 */
@Validated
@RestController
@RequestMapping("/easy/excel")
public class FileController {

    /**
     * 文件导入
     *
     * @param file excel文件
     * @return 执行结果
     */
    @PostMapping("/upload")
    public ResponseResultVO readFile1(MultipartFile file) {
        // 定义一个接收表格内容的集合
        List<UserFileDataVO> list;
        // 读取文件内容
        try {
            list = EasyExcelUtil.readMultipartFile(file.getInputStream(), UserFileDataVO.class);
        } catch (Exception e) {
            throw new BaseException(e.getMessage());
        }

        System.out.println(list.size());
        return ResponseResultUtil.success();
    }

    @Resource
    private FileExportMapper fileExportMapper;

    /**
     * 导出excel文件
     *
     * @param response 响应体
     */
    @PostMapping("/download1")
    public void downFile1(HttpServletResponse response) {
        // 获取用户信息列表
        List<UserFileDataVO> userList = fileExportMapper.getUserList();
        // 导出文件
        EasyExcelUtil.export(response, "用户名单", "用户名单", userList, UserFileDataVO.class);
    }

}