SpringBoot中如何优雅导入Excel记录并自动转为对象列表

本文阅读量: 2021-03-16

一背景

业务需求，经常会有一些导入数据的需求，如果每次都需要针对不同导入excel一一去解析，开发起来费时费力，效率还会很低。

那么有没有什么办法可以提高这个开发效率，比如可以直接把excel的行记录直接转换为对象，每次只需要维护好列的顺序和字典的顺序即可，答案是肯定的，下面我们就来介绍一下如何做。

二引入依赖

1
2
3

# 版本可替换为最新版本
'org.jxls:jxls:2.8.1',
'org.jxls:jxls-poi:2.8.1',

jxls的官网请参考：http://jxls.sourceforge.net/index.html

三通用工具类

专门写一个通用工具类，完成行记录到对象列表的转换工作，工具类如下：

import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellType;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.usermodel.WorkbookFactory;
  
import javax.validation.ConstraintViolation;  
import javax.validation.Validation;  
import javax.validation.Validator;  
import javax.validation.ValidatorFactory;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;

/**
 * 导入excel
 * @author mafgwo
 * @since 2021/03/28
 */
public class ReadExcelUtils {

    /**
     * 解析excel文件为java对象列表 默认从第二行开始 因为正常情况下 excel的头部都有一行说明
     * @param fileInputStream
     * @param type
     * @param <T>
     * @return
     * @throws IOException
     * @throws InstantiationException
     * @throws IllegalAccessException
     */
    public static <T> List<T> parseExcel(InputStream fileInputStream, Class<T> type) throws IOException, InstantiationException, IllegalAccessException {
        Workbook workBook = WorkbookFactory.create(fileInputStream);
        List<T> result = new ArrayList<>();
        Sheet sheet = workBook.getSheetAt(0);

        for(int ri = sheet.getFirstRowNum() + 1 ; ri <= sheet.getLastRowNum(); ri++) {
            Row row = sheet.getRow(ri);
            if (row == null) {
                break;
            }
            T object = type.newInstance();
            Field[] fields = object.getClass().getDeclaredFields();
            Field.setAccessible(fields, true);
            boolean hasData = false;
            for(int ci = row.getFirstCellNum(); ci < row.getLastCellNum(); ci++) {
                Cell cell = row.getCell(ci);
                Object value = null;
                try {
                    value = getCellValue(cell, fields[ci]);
                } catch (Exception e) {
                    throw new RuntimeException("第" + (ri + 1) + "行第" + (ci + 1) + "列单元格数据解析异常");
                }
                fields[ci].set(object, value);
                if (value != null) {
                    hasData = true;
                }
            }
            if (hasData) {
                // 对对象属性进行校验 如果有问题 则直接抛出异常
                Set<ConstraintViolation<T>> errorMsg = validator.validate(object);
                if (!CollectionUtils.isEmpty(errorMsg)) {
                    String failMsg = "第" + (ri + 1) + "行" + errorMsg.stream().map(ConstraintViolation::getMessage).collect(Collectors.joining(","));
                    throw new RuntimeException(failMsg);
                }
                result.add(object);
            }
            Field.setAccessible(fields, false);
        }
        return result;
    }

    /**
     * 读取单元格数据 可以根据需要补充其他类型与java类型的映射
     * @param cell
     * @param field
     * @return
     */
    private static Object getCellValue(Cell cell, Field field) {
        CellType type = cell.getCellType();
        if (CellType.BLANK == type) {
            return null;
        }
        else if (CellType.BOOLEAN == type && field.getType().equals(Boolean.class)) {
            return cell.getBooleanCellValue();
        }
        else if (CellType.ERROR == type) {
            return null;
        }
        else if (CellType.NUMERIC == type || CellType.FORMULA == type) {
            if (field.getType().equals(Integer.class)) {
                return (int) cell.getNumericCellValue();
            } else if (field.getType().equals(Long.class)) {
                return (long) cell.getNumericCellValue();
            } else if (field.getType().equals(Double.class)) {
                return cell.getNumericCellValue();
            }
        }
        else if (CellType.STRING == type && field.getType().equals(String.class)) {
            return cell.getStringCellValue();
        }
        return null;
    }
}

四使用工具类示例

定义一个UserVO如下：

import lombok.Data;
import javax.validation.constraints.NotBlank;

@Data
public class UserVO {
	
    @NotBlank(message = "名称不能为空")
    private String name;

    private Integer age;

    private String addr;

}

Controller类如下：

import lombok.extern.slf4j.Slf4j;
import org.springframework.http.ResponseEntity;
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 java.io.IOException;
import java.util.List;

@Slf4j
@RestController
@RequestMapping("/test/")
public class ReadExcelController {

    @PostMapping("/import")
    public ResponseEntity<?> batchImport(MultipartFile file) throws IOException, IllegalAccessException, InstantiationException {
        if (file == null || file.isEmpty()) {
            throw new RuntimeException("请选择上传的excel");
        }
        List<UserVO> userVOList = ReadExcelUtils.parseExcel(file.getInputStream(), UserVO.class);
        log.info("user infos: {}", userVOList);
        // TODO 自己的业务处理
        return ResponseEntity.ok().build();
    }

}

excel数据如下

通过postman测试

后台日志如下

2021-03-28 03:40:13.470  INFO 98472 --- [nio-8082-exec-1] c.e.p.z.d.c.api.v1.ReadExcelController   : user infos: [UserVO(name=张三, age=29, addr=广州市黄埔区xx小区xx栋xxxx1号房), UserVO(name=李四, age=20, addr=广州市黄埔区xx小区xx栋xxxx2号房), UserVO(name=王五, age=25, addr=广州市黄埔区xx小区xx栋xxxx3号房)]

从以上测试可见，完全实现了我们想要的结果。

五结论

通过以上工具类的做法，我们确实是方便了从excel到对象的转换，但是此处也有一个点是特别需要注意的，那就是excel列的顺序一定要严格与定义VO字段的顺序是一致的，否则会报错。这个VO定义好之后，正常情况下是不允许随便增删字典或者调整字段顺序的，如果变了，excel列也得随之改变。
并且该工具类还支持了Spring的validation校验，可以给属性加上@NotBlank、@NotNull等等validation相关注解就能同时对字段进行校验，避免了解析出来之后还需要在代码层面再做一次校验的麻烦。
另外，该工具类，还可以根据自己的业务需求做进一步的调整，可以做的更通用以满足多样的导入需求。

一 背景

二 引入依赖

三 通用工具类

四 使用工具类示例

五 结论

一背景

二引入依赖

三通用工具类

四使用工具类示例

五结论