【Excel】使用 SpringBoot 实现 Excel 文件的导入与导出

为了大家能更好地理解这篇博文，在看之前，建议去看看我的上一篇博文：【File】使用 SpringBoot 实现文件的上传与下载。因为，这篇博文是在上一篇博文基础之上继续开发的。

这两篇博文互有联系：文件的导入就是文件的上传；文件的导出就是文件的下载。

至于为什么是 导入/导出 Excel 文件呢？因为 Excel 文件用的频率更多吧。顺便来复习下通过 EasyExcel 来操作 Excel 文件。

编码思路：

Excel 导入：

1. 浏览文件夹，选择需要上传的 Excel 文件，这里使用 POSTMAN 工具；
2. 将本地文件上传至服务器指定位置；
3. 服务器解析Excel文件；
4. 将Excel中解析的数据存入数据库中。

Excel 导出

1. 设定查询条件；
2. 数据库中查询相应的数据 ；
3. 将数据写入Excel；
4. 将 Excel 下载至本地。

导入 POM 依赖：

  com.alibaba
  easyexcel
  2.0.0-beta2



    com.alibaba
    fastjson
    1.2.5

1
2
3
4
5
6
7
8
9
10
11

1. Excel 导入

FileController：添加一个导入接口

@RestController
@RequestMapping("/file")
public class FileController {

    @Autowired
    private FileService fileService;

    @PostMapping("/importExcel")
    public ResultVo importExcel(@RequestParam("file") MultipartFile excel) {
        return fileService.importExcel(excel);
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13

FileServiceImpl：

@Service
@Slf4j
public class FileServiceImpl implements FileService {

    @Autowired
    private ExcelUtil excelUtil;

    @Override
    public ResultVo importExcel(MultipartFile file) {
        // 1.入参校验
        ResultVo checkExcelParam = checkExcelParam(file);
        if (!checkExcelParam.checkSuccess()) {
            log.error(checkExcelParam.getMsg());
            return checkExcelParam;
        }
        // 2.上传至服务器某路径下
        ResultVo resultVo = uploadFile(file);
        if (!resultVo.checkSuccess()) {
            return resultVo;
        }
        String filePath = (String)resultVo.getData();
        if (StringUtil.isBlank(filePath)) {
            return ResultVoUtil.error("【导入Excel文件】生成的Excel文件的路径为空");
        }
        // 3.读取excel文件
        List excelVos = excelUtil.simpleExcelRead(filePath, ExcelVo.class);
        if (CollectionUtil.isEmpty(excelVos) || excelVos.size() < 2) {
            log.error("【导入Excel文件】上传Excel文件{}为空", file.getOriginalFilename());
            return ResultVoUtil.error("上传Excel文件为空");
        }
        // 4.通过线程池开启一个线程去执行数据库操作，主线程继续往下执行
        // 4.1开启一个线程
        TaskCenterUtil taskCenterUtil = TaskCenterUtil.getTaskCenterUtil();
        taskCenterUtil.submitTask(() -> {
            log.info("【批量添加】批量添加数据：{}", JSON.toJSONString(excelVos));
            return null;
        });
        // 4.2删除临时文件
        boolean deleteFile = FileUtil.deleteFile(new File(filePath));
        if (!deleteFile) {
            log.error("【导入Excel文件】删除临时文件失败，临时文件路径为{}", filePath);
            return ResultVoUtil.error("删除临时文件失败");
        }
        log.info("【导入Excel文件】删除临时文件成功，临时文件路径为：{}", filePath);
        return ResultVoUtil.success(excelVos);
    }
    
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

说明：

1. List excelVos = excelUtil.simpleExcelRead(filePath, ExcelVo.class); 你给我一个Excel文件路径，和一个数据类型，我就能将这个Excel文件中的数据封装成一个集合，并返回给你；
2. TaskCenterUtil taskCenterUtil = TaskCenterUtil.getTaskCenterUtil();获取了一个线程池；taskCenterUtil.submitTask() 另开启了一个新线程去执行其它操作；原来的线程继续往下执行

checkExcelParam()：校验入参

public ResultVo checkExcelParam(MultipartFile file) {
    log.info("【上传Excel文件】进入到上传Excel文件方法...");
    if (null == file || file.isEmpty()) {
        log.error("【上传Excel文件】上传的文件为空，file={}", file);
        throw new ParamErrorException();
    }
    boolean b = ExcelUtil.checkExcelExtension(file);
    if (!b) {
        return ResultVoUtil.error("上传的不是Excel文件，请上传正确格式的Excel文件");
    }
    return ResultVoUtil.success();
}
1
2
3
4
5
6
7
8
9
10
11
12

uploadFile()：这个上传文件的方法，还是使用的上一篇博文的方法

ExcelUtil：

@Component
@Slf4j
public class ExcelUtil {

    // excel文件后缀
    private final static String EXCE_L2003 = "xls";
    private final static String EXCEL_2007 = "xlsx";

    // 校验文件后缀是否为 xls、xlsx
    public static boolean checkExcelExtension(MultipartFile excel) {
        String filename = excel.getOriginalFilename();
        if (StringUtil.isBlank(filename)) {
            log.info("【校验Excel文件后缀】Excel文件名为空");
            return false;
        }
        int index = filename.lastIndexOf(".");
        if (index == -1) {
            log.info("【校验Excel文件后缀】Excel文件名中没有点号");
            return false;
        }
        String extension = filename.substring(index + 1);
        return Arrays.asList(EXCE_L2003, EXCEL_2007).contains(extension);
    }

    // 读取excel文件
    public List simpleExcelRead(String filePath, Class clazz) {
        ExcelListener excelListener = new ExcelListener();
        EasyExcel.read(filePath, clazz, excelListener).sheet().doRead();
        List dataList = excelListener.getDataList();
        return dataList;
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

说明：

1. EasyExcel.read(filePath, clazz, excelListener).sheet().doRead(); 会调用 ExcelListener 类中的方法，将它读取到的数据存储在 dataList 集合中；
2. 这里 ExcelUtil 类用的是泛型，你要导入什么类型的数据，就传什么类型的数据。我这里导入的是 ExcelVo 类型。

ExcelListener：

@Slf4j
public class ExcelListener extends AnalysisEventListener {

    // 返回读取到的excel中的数据
    List dataList = new ArrayList<>();

    public ExcelListener() {
    }

    // 每一条数据解析都会来调用
    @Override
    public void invoke(T t, AnalysisContext analysisContext) {
        log.info("【Excel文件】解析到一条数据{}:", JSON.toJSONString(t));
        dataList.add(t);
    }

    // 所有数据解析完成了 才会来调用
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        log.info("【Excel文件】Excel所有数据解析完毕！");
    }

    public List getDataList() {
        return dataList;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

ExcelVo：Excel 中数据信息的模板

@Data
@NoArgsConstructor
@AllArgsConstructor
public class ExcelVo {
	// 姓名
    private String name;
    // 性别 1：女 0：男
    @ExcelProperty(converter = SexConvert.class)
    private Integer sex;
    // 创建时间
    @DateTimeFormat("yyyy年MM月dd日HH时mm分ss秒")
    private String createTime;

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

说明：

1. ExcelVo 中的属性和 Excel 文件对应
2. 性别 sex 属性，我们使用了一个转换器。Excel 文件中性别对应的是男、女，但我们要用整形0、1 去接收它，所以，需要自定义一个性别转换器

Excel 内容：

SexConvert：性别转换器

public class SexConvert implements Converter {

    @Override
    public Class supportJavaTypeKey() {
        return Integer.class;
    }

    @Override
    public CellDataTypeEnum supportExcelTypeKey() {
        return CellDataTypeEnum.STRING;
    }

    // 这里读的时候会调用
    @Override
    public Integer convertToJavaData(CellData cellData, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {
        switch (cellData.getStringValue()) {
            case "男":
                return 0;
            case "女":
                return 1;
            default:
                return 0;
        }
    }

    // 这里写的时候会调用
    @Override
    public CellData convertToExcelData(Integer integer, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {
        switch (integer) {
            case 1:
                return new CellData("女");
            case 0:
                return new CellData("男");
            default:
                return new CellData(String.valueOf(integer));
        }
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

TaskCenterUtil：线程池工具类

public class TaskCenterUtil {

    public static Integer CORE_POOL_SIZE = 10;
    public static Integer MAX_NUM_POOL_SIZE = 10;
    public static Integer MAX_MESSAGE_SIZE = 100;
    public static Long KEEP_ALIVE_TIME = 60L;

    private ThreadPoolExecutor poolExecutor = new ThreadPoolExecutor(CORE_POOL_SIZE, MAX_NUM_POOL_SIZE, KEEP_ALIVE_TIME,
            TimeUnit.SECONDS, new LinkedBlockingQueue<>(MAX_MESSAGE_SIZE), new ThreadPoolExecutor.CallerRunsPolicy());


    private TaskCenterUtil() {}

    private static TaskCenterUtil taskCenterUtil = new TaskCenterUtil();

    public static TaskCenterUtil getTaskCenterUtil() {
        return taskCenterUtil;
    }

    public void submitTask(Callable task) {
        poolExecutor.submit(task);
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

FileUtil.deleteFile()：删除临时文件

// 递归删除目录下的所有文件及子目录下所有文件
public static boolean deleteFile(File file) {
    if (!file.exists()) {
        return false;
    }
    if (file.isDirectory()) {
        String[] children = file.list();
        //递归删除目录中的子目录下
        for (int i=0; i