EasyExcel实现文件导入

导入

准备工作

见：https://www.cnblogs.com/wywblogs/p/16095576.html

异步导入

接口代码

public Map importMemberList(@RequestPart("file") MultipartFile file) {
        log4.info("数据导入");
        ImportTask importTask = new ImportTask();
        importTask.setCreateBy(getCurrentUser.get().getID());
        // 读取每一行的监听器
        ExcelDataListener<AreaImportDto> excelDataListener = new ExcelDataListener<>();
        // excel文件校验
        Map<String, Object> check = ExcelUtil.importCheck(file, importTask, excelDataListener, AreaImportDto.class, "导入功能模块名");
        // 保存导入记录
        importTaskMapper.save(importTask);
        // 提交事务，否则下面异步service查询不到保存的importTask
        sqlSessionTemplate.flushStatements();
        String taskCode = importTask.getCode();
        // 如果校验不通过则不进行导入
        if (!check.get("code").equals(200)) {
            check.put("taskCode",taskCode);
	    return check;
	}
        // 进行导入
        iAreaService.importMemberList(getCurrentUser.get().getID(), excelDataListener, taskCode);
        return new HashMap<String, Object>() {{
            put("msg", "数据导入成功！详情请查看导入任务列表");
            put("taskCode", taskCode);
            put("code", 200);
        }};
    }

ps:

AreaImportDto:导入的实体类

ImportTask ：保存导入任务记录的实体类（包含错误信息）

导入工具类方法

/**
     * 校验导入的数据正确性
     * @param file 上传的文件
     * @param importTask 导入任务记录
     * @param excelDataListener 导入监听器
     * @param clazz 导入的类对象
     * @param importType 导入类型（属于哪个模块的导入）
     * @param <T> 导入实体类类型
     * @return
     */
    public static <T> Map<String, Object> importCheck(MultipartFile file,ImportTask importTask, ExcelDataListener<T> excelDataListener,
                                                      Class<T> clazz, String importType) {
        SimpleDateFormat sdf = new SimpleDateFormat("yyyyMMddHHmmss");
        Date date = new Date();
        importTask.setImportType(importType);
        importTask.setCode(sdf.format(date));
        importTask.setImportTime(date);
        importTask.setFileName(file.getOriginalFilename());
        importTask.setCreateAt(date);
        importTask.setImportStart(date);
        HashMap<String, Object> result = new HashMap<String, Object>() {{
            put("code", 200);
        }};
        try {
            if (!checkExcelType(file)) {
                importTask.setErrorMessage(importType+"数据导入文件类型错误");
                importTask.setStatus(2l);
                result.put("code", 401);
                result.put("msg", importType+"数据导入文件类型错误");
            } else {
                // 异步执行上传的file临时文件会被清理掉，在异步service中会获取不到文件
                EasyExcel.read(file.getInputStream(),excelDataListener)
                        .head(clazz)
                        .sheet()
                        .doRead();
                List<String> errorCol = checkExcelHead(clazz, excelDataListener.getHeadMap());
                if (errorCol.size() > 0) {
                    importTask.setErrorMessage(importType+"数据导入文件列名错误：" + String.join(",",errorCol));
                    importTask.setStatus(2l);
                    result.put("code", 401);
                    result.put("msg", importType+"数据导入文件列名错误");
                } else {
                    // 导入的数据的正确性
                    List<String> nullFields = excelDataListener.getNullFields();
                    if (nullFields.size() > 0) {
                        importTask.setErrorMessage(importType+"数据导入文件必要列为空："+
                                String.join("；",nullFields) + "；");
                        importTask.setStatus(2l);
                        if (excelDataListener.getDataList().size() == 0) {
                            result.put("code", 401);
                            result.put("msg", importType+"数据导入文件必要列为空："+
                                    String.join("；",nullFields));
                        }
                    }
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
            log4.error(importType+"数据导入文件读取异常"+e.getMessage());
            importTask.setErrorMessage(importType+"数据导入文件读取异常"+e.getMessage());
            importTask.setStatus(2l);
            result.put("code", 401);
            result.put("msg", importType+"数据导入文件读取异常"+e.getMessage());
        }
        return result;
    }

    /**
     * excel文件类型校验
     *
     * @param file
     * @return
     */
    public static boolean checkExcelType(MultipartFile file) {
        String filename = file.getOriginalFilename();
        if (filename == null)
            return false;
        return filename.endsWith("xlsx") || filename.endsWith("xls");
    }

/**
     * excel表头校验
     * @param clazz 导入实体的类对象
     * @param headMap 导入excel的表头
     * @return
     */
    public static List<String> checkExcelHead(Class<?> clazz,Map<Integer, String> headMap) {
        Field[] fields = clazz.getDeclaredFields();
        ArrayList<String> errorCol = new ArrayList<>();
        // 实体类的head
        List<String> entityHead = new ArrayList<>();
        for (Field field : fields) {
            ExcelProperty annotation = field.getDeclaredAnnotation(ExcelProperty.class);
            if (annotation != null) {
                List<String> head = Arrays.asList(annotation.value());
                entityHead.addAll(head);
            }
        }
        for (Map.Entry<Integer, String> entry : headMap.entrySet()) {
            // 解析的表头是否在实体类中
            if (!entityHead.contains(entry.getValue()))
                errorCol.add(entry.getValue());
        }
        return errorCol;
    }

service开始进行数据导入

/**
	 * excel数据导入
	 * @param userId 当前用户id （由于异步方法执行时注入的用户信息service获取不到，因此要在controller中获取后传入）
	 * @param excelDataListener excel读取监听器
	 * @param taskCode 导入任务记录的code
	 */
	@Async
	@Transactional(rollbackFor = Exception.class)
	public void importMemberList(String userId,ExcelDataListener<AreaImportDto> excelDataListener,String taskCode) {
		// 导入任务记录
		ImportTask importTask = importTaskMapper.findByCode(taskCode);
		log4.info("开始进行数据导入");
		// 解析错误的数据
		List<Map<String, String>> errorDataList = excelDataListener.getErrorDataList();
		if (!CollectionUtils.isEmpty(errorDataList)) {
			importTask.setErrorData(errorDataList.toString() + "；");
			importTask.setErrorMessage(String.join("；",excelDataListener.getErrorMsg())+ "；");
			importTask.setStatus(2l);
		} else {
			importTask.setStatus(1l);
		}

		// 解析成功的数据
		List<AreaImportDto> dataList = excelDataListener.getDataList();

		try {
			// 将导入实体类转为数据表对应的实体类
                        // 调用service方法进行保存（其中出错或者出现异常的数据根据起行索引字段构造错误信息保存在importTask中）
		} catch (Exception e) {
			String errorMessage = importTask.getErrorMessage();
			importTask.setErrorMessage(errorMessage + ";数据导入异常");
			importTask.setStatus(2l);
		}
		importTask.setImportEnd(new Date());
		importTask.setDataNum((long)(dataList.size()) + (long)(errorDataList.size()));
		// 保存任务记录
		importTaskMapper.update(importTask);
		log4.info("数据导入完成！");
	}