/**
|
* Copyright (c) 2013-Now http://jeesite.com All rights reserved.
|
*/
|
package com.ruoyi.common.core.excel;
|
|
|
|
import com.ruoyi.common.core.callback.MethodCallback;
|
import com.ruoyi.common.core.excel.annotation.ExcelField;
|
import com.ruoyi.common.core.excel.annotation.ExcelFields;
|
import com.ruoyi.common.core.lang.DateUtils;
|
import com.ruoyi.common.core.lang.ObjectUtils;
|
import com.ruoyi.common.core.reflect.ReflectUtils;
|
import org.apache.commons.lang3.StringUtils;
|
import org.apache.poi.hssf.usermodel.HSSFDateUtil;
|
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
|
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
|
import org.apache.poi.ss.formula.eval.ErrorEval;
|
import org.apache.poi.ss.usermodel.*;
|
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
|
import org.slf4j.Logger;
|
import org.slf4j.LoggerFactory;
|
|
import java.io.*;
|
import java.lang.reflect.Field;
|
import java.lang.reflect.Method;
|
import java.text.DecimalFormat;
|
import java.util.*;
|
|
/**
|
* 导入Excel文件（支持“XLS”和“XLSX”格式）
|
* @author ThinkGem
|
* @version 2018-08-11
|
*/
|
public class ExcelImport implements Closeable {
|
|
/**
|
* 默认标题行号
|
*/
|
public static final int HEADER_NUM = 1;
|
|
private static Logger log = LoggerFactory.getLogger(ExcelImport.class);
|
|
/**
|
* 工作薄对象
|
*/
|
private Workbook wb;
|
|
/**
|
* 工作表对象
|
*/
|
private Sheet sheet;
|
|
/**
|
* 标题行数
|
*/
|
private int headerNum;
|
|
/**
|
* 用于清理缓存
|
*/
|
private Set<Class<?>> fieldTypes = new HashSet<Class<?>>();
|
|
/**
|
* 构造函数
|
* @param file 导入文件对象，读取第一个工作表
|
* @throws InvalidFormatException
|
* @throws IOException
|
*/
|
public ExcelImport(File file) throws InvalidFormatException, IOException {
|
this(file, 0, 0);
|
}
|
|
/**
|
* 构造函数
|
* @param file 导入文件对象，读取第一个工作表
|
* @param headerNum 标题行数，数据行号=标题行数+1
|
* @throws InvalidFormatException
|
* @throws IOException
|
*/
|
public ExcelImport(File file, int headerNum)
|
throws InvalidFormatException, IOException {
|
this(file, headerNum, 0);
|
}
|
|
/**
|
* 构造函数
|
* @param file 导入文件对象
|
* @param headerNum 标题行数，数据行号=标题行数+1
|
* @param sheetIndexOrName 工作表编号或名称，从0开始
|
* @throws InvalidFormatException
|
* @throws IOException
|
*/
|
public ExcelImport(File file, int headerNum, Object sheetIndexOrName)
|
throws InvalidFormatException, IOException {
|
this(file.getName(), new FileInputStream(file), headerNum, sheetIndexOrName);
|
}
|
|
/**
|
* 构造函数
|
* @param fileName 导入文件对象
|
* @param headerNum 标题行数，数据行号=标题行数+1
|
* @param sheetIndexOrName 工作表编号或名称
|
* @throws InvalidFormatException
|
* @throws IOException
|
*/
|
public ExcelImport(String fileName, InputStream is, int headerNum, Object sheetIndexOrName)
|
throws InvalidFormatException, IOException {
|
if (StringUtils.isBlank(fileName)){
|
throw new ExcelException("导入文档为空!");
|
}else if(fileName.toLowerCase().endsWith("xls")){
|
this.wb = new HSSFWorkbook(is);
|
}else if(fileName.toLowerCase().endsWith("xlsx")){
|
this.wb = new XSSFWorkbook(is);
|
}else{
|
throw new ExcelException("文档格式不正确!");
|
}
|
this.setSheet(sheetIndexOrName, headerNum);
|
log.debug("Initialize success.");
|
}
|
|
/**
|
* 添加到 annotationList
|
*/
|
private void addAnnotation(List<Object[]> annotationList, ExcelField ef, Object fOrM, ExcelField.Type type, String... groups){
|
if (ef != null && (ef.type() == ExcelField.Type.ALL || ef.type() == type)){
|
if (groups!=null && groups.length>0){
|
boolean inGroup = false;
|
for (String g : groups){
|
if (inGroup){
|
break;
|
}
|
for (String efg : ef.groups()){
|
if (StringUtils.equals(g, efg)){
|
inGroup = true;
|
annotationList.add(new Object[]{ef, fOrM});
|
break;
|
}
|
}
|
}
|
}else{
|
annotationList.add(new Object[]{ef, fOrM});
|
}
|
}
|
}
|
|
/**
|
* 获取当前工作薄
|
* @author ThinkGem
|
*/
|
public Workbook getWorkbook() {
|
return wb;
|
}
|
|
/**
|
* 设置当前工作表和标题行数
|
* @author ThinkGem
|
*/
|
public void setSheet(Object sheetIndexOrName, int headerNum) {
|
if (sheetIndexOrName instanceof Integer || sheetIndexOrName instanceof Long){
|
this.sheet = this.wb.getSheetAt(ObjectUtils.toInteger(sheetIndexOrName));
|
}else{
|
this.sheet = this.wb.getSheet(ObjectUtils.toString(sheetIndexOrName));
|
}
|
if (this.sheet == null){
|
throw new ExcelException("没有找到‘"+sheetIndexOrName+"’工作表!");
|
}
|
this.headerNum = headerNum;
|
}
|
|
/**
|
* 获取行对象
|
* @param rownum
|
* @return 返回Row对象，如果空行返回null
|
*/
|
public Row getRow(int rownum){
|
Row row = this.sheet.getRow(rownum);
|
if (row == null){
|
return null;
|
}
|
// 验证是否是空行，如果空行返回null
|
short cellNum = 0;
|
short emptyNum = 0;
|
Iterator<Cell> it = row.cellIterator();
|
while (it.hasNext()) {
|
cellNum++;
|
Cell cell = it.next();
|
if (StringUtils.isBlank(cell.toString())) {
|
emptyNum++;
|
}
|
}
|
if (cellNum == emptyNum) {
|
return null;
|
}
|
return row;
|
}
|
|
/**
|
* 获取数据行号
|
* @return
|
*/
|
public int getDataRowNum(){
|
return headerNum;
|
}
|
|
/**
|
* 获取最后一个数据行号
|
* @return
|
*/
|
public int getLastDataRowNum(){
|
return this.sheet.getLastRowNum() + 1;
|
}
|
|
/**
|
* 获取最后一个列号
|
* @return
|
*/
|
public int getLastCellNum(){
|
Row row = this.getRow(headerNum);
|
return row == null ? 0 : row.getLastCellNum();
|
}
|
|
/**
|
* 获取单元格值
|
* @param row 获取的行
|
* @param column 获取单元格列号
|
* @return 单元格值
|
*/
|
public Object getCellValue(Row row, int column){
|
if (row == null){
|
return row;
|
}
|
Object val = "";
|
try{
|
Cell cell = row.getCell(column);
|
if (cell != null){
|
if (cell.getCellType() == Cell.CELL_TYPE_NUMERIC){
|
val = cell.getNumericCellValue();
|
if (HSSFDateUtil.isCellDateFormatted(cell)) {
|
val = DateUtil.getJavaDate((Double) val); // POI Excel 日期格式转换
|
}else{
|
if ((Double) val % 1 > 0){
|
val = new DecimalFormat("0.00").format(val);
|
}else{
|
val = new DecimalFormat("0").format(val);
|
}
|
}
|
}else if (cell.getCellType() == Cell.CELL_TYPE_STRING) {
|
val = cell.getStringCellValue();
|
}else if (cell.getCellType() == Cell.CELL_TYPE_FORMULA){
|
try {
|
val = cell.getStringCellValue();
|
} catch (Exception e) {
|
FormulaEvaluator evaluator = cell.getSheet().getWorkbook()
|
.getCreationHelper().createFormulaEvaluator();
|
evaluator.evaluateFormulaCell(cell);
|
CellValue cellValue = evaluator.evaluate(cell);
|
switch (cellValue.getCellType()) {
|
case Cell.CELL_TYPE_NUMERIC:
|
val = cellValue.getNumberValue();
|
break;
|
case Cell.CELL_TYPE_STRING:
|
val = cellValue.getStringValue();
|
break;
|
case Cell.CELL_TYPE_BOOLEAN:
|
val = cellValue.getBooleanValue();
|
break;
|
case Cell.CELL_TYPE_ERROR:
|
val = ErrorEval.getText(cellValue.getErrorValue());
|
break;
|
default:
|
val = cell.getCellFormula();
|
}
|
}
|
}else if (cell.getCellType() == Cell.CELL_TYPE_BOOLEAN){
|
val = cell.getBooleanCellValue();
|
}else if (cell.getCellType() == Cell.CELL_TYPE_ERROR){
|
val = cell.getErrorCellValue();
|
}
|
}
|
}catch (Exception e) {
|
return val;
|
}
|
return val;
|
}
|
|
/**
|
* 获取导入数据列表
|
* @param cls 导入对象类型
|
* @param groups 导入分组
|
*/
|
public <E> List<E> getDataList(Class<E> cls, String... groups) throws InstantiationException, IllegalAccessException{
|
return getDataList(cls, false, groups);
|
}
|
|
/**
|
* 获取导入数据列表
|
* @param cls 导入对象类型
|
* @param isThrowException 遇见错误是否抛出异常
|
* @param groups 导入分组
|
*/
|
public <E> List<E> getDataList(Class<E> cls, final boolean isThrowException, String... groups) throws InstantiationException, IllegalAccessException{
|
return getDataList(cls, new MethodCallback() {
|
@Override
|
public Object execute(Object... params) {
|
if (isThrowException){
|
Exception ex = (Exception)params[0];
|
int rowNum = (int)params[1];
|
int columnNum = (int)params[2];
|
throw new ExcelException("Get cell value ["+rowNum+","+columnNum+"]", ex);
|
}
|
return null;
|
}
|
}, groups);
|
}
|
/**
|
* 获取导入数据列表
|
* @param cls 导入对象类型
|
* @param exceptionCallback 遇见错误是否抛出异常
|
* @param groups 导入分组
|
*/
|
public <E> List<E> getDataList(Class<E> cls, MethodCallback exceptionCallback, String... groups) throws InstantiationException, IllegalAccessException{
|
List<Object[]> annotationList = new ArrayList<Object[]>();
|
// Get annotation field
|
Field[] fs = cls.getDeclaredFields();
|
for (Field f : fs){
|
ExcelFields efs = f.getAnnotation(ExcelFields.class);
|
if (efs != null && efs.value() != null){
|
for (ExcelField ef : efs.value()){
|
addAnnotation(annotationList, ef, f, ExcelField.Type.IMPORT, groups);
|
}
|
}
|
ExcelField ef = f.getAnnotation(ExcelField.class);
|
addAnnotation(annotationList, ef, f, ExcelField.Type.IMPORT, groups);
|
}
|
// Get annotation method
|
Method[] ms = cls.getDeclaredMethods();
|
for (Method m : ms){
|
ExcelFields efs = m.getAnnotation(ExcelFields.class);
|
if (efs != null && efs.value() != null){
|
for (ExcelField ef : efs.value()){
|
addAnnotation(annotationList, ef, m, ExcelField.Type.IMPORT, groups);
|
}
|
}
|
ExcelField ef = m.getAnnotation(ExcelField.class);
|
addAnnotation(annotationList, ef, m, ExcelField.Type.IMPORT, groups);
|
}
|
// Field sorting
|
Collections.sort(annotationList, new Comparator<Object[]>() {
|
@Override
|
public int compare(Object[] o1, Object[] o2) {
|
return new Integer(((ExcelField)o1[0]).sort()).compareTo(
|
new Integer(((ExcelField)o2[0]).sort()));
|
};
|
});
|
//log.debug("Import column count:"+annotationList.size());
|
// Get excel data
|
List<E> dataList = new ArrayList<E>();
|
for (int i = this.getDataRowNum(); i < this.getLastDataRowNum(); i++) {
|
E e = (E)cls.newInstance();
|
Row row = this.getRow(i);
|
if (row == null){
|
continue;
|
}
|
StringBuilder sb = new StringBuilder();
|
for (int j = 0; j < annotationList.size(); j++){//Object[] os : annotationList){
|
Object[] os = annotationList.get(j);
|
ExcelField ef = (ExcelField)os[0];
|
int column = (ef.column() != -1) ? ef.column() : j;
|
Object val = this.getCellValue(row, column);
|
if (val != null){
|
// If is dict type, get dict value
|
if (StringUtils.isNotBlank(ef.dictType())){
|
try{
|
Class<?> dictUtils = Class.forName("com.jeesite.modules.sys.utils.DictUtils");
|
val = dictUtils.getMethod("getDictValue", String.class, String.class,
|
String.class).invoke(null, ef.dictType(), val.toString(), "");
|
} catch (Exception ex) {
|
log.info("Get cell value ["+i+","+column+"] error: " + ex.toString());
|
val = null;
|
}
|
//val = DictUtils.getDictValue(val.toString(), ef.dictType(), "");
|
//log.debug("Dictionary type value: ["+i+","+colunm+"] " + val);
|
}
|
// Get param type and type cast
|
Class<?> valType = Class.class;
|
if (os[1] instanceof Field){
|
valType = ((Field)os[1]).getType();
|
}else if (os[1] instanceof Method){
|
Method method = ((Method)os[1]);
|
if ("get".equals(method.getName().substring(0, 3))){
|
valType = method.getReturnType();
|
}else if("set".equals(method.getName().substring(0, 3))){
|
valType = ((Method)os[1]).getParameterTypes()[0];
|
}
|
}
|
//log.debug("Import value type: ["+i+","+column+"] " + valType);
|
try {
|
if (StringUtils.isNotBlank(ef.attrName())){
|
if (ef.fieldType() != Class.class){
|
fieldTypes.add(ef.fieldType()); // 先存起来，方便完成后清理缓存
|
val = ef.fieldType().getMethod("getValue", String.class).invoke(null, val);
|
}
|
}else{
|
if (val != null){
|
if (valType == String.class){
|
String s = String.valueOf(val.toString());
|
if(StringUtils.endsWith(s, ".0")){
|
val = StringUtils.substringBefore(s, ".0");
|
}else{
|
val = String.valueOf(val.toString());
|
}
|
}else if (valType == Integer.class){
|
val = Double.valueOf(val.toString()).intValue();
|
}else if (valType == Long.class){
|
val = Double.valueOf(val.toString()).longValue();
|
}else if (valType == Double.class){
|
val = Double.valueOf(val.toString());
|
}else if (valType == Float.class){
|
val = Float.valueOf(val.toString());
|
}else if (valType == Date.class){
|
if (val instanceof String){
|
val = DateUtils.parseDate(val);
|
}else if (val instanceof Double){
|
val = DateUtil.getJavaDate((Double)val); // POI Excel 日期格式转换
|
}
|
}else{
|
if (ef.fieldType() != Class.class){
|
fieldTypes.add(ef.fieldType()); // 先存起来，方便完成后清理缓存
|
val = ef.fieldType().getMethod("getValue", String.class).invoke(null, val.toString());
|
}else{
|
// 如果没有指定 fieldType，切自行根据类型查找相应的转换类（com.jeesite.common.utils.excel.fieldtype.值的类名+Type）
|
Class<?> fieldType2 = Class.forName(this.getClass().getName().replaceAll(this.getClass().getSimpleName(),
|
"fieldtype."+valType.getSimpleName()+"Type"));
|
fieldTypes.add(fieldType2); // 先存起来，方便完成后清理缓存
|
val = fieldType2.getMethod("getValue", String.class).invoke(null, val.toString());
|
}
|
}
|
}
|
}
|
} catch (Exception ex) {
|
log.info("Get cell value ["+i+","+column+"] error: " + ex.toString());
|
val = null;
|
// 参数：Exception ex, int rowNum, int columnNum
|
exceptionCallback.execute(ex, i, column);
|
}
|
// set entity value
|
if (StringUtils.isNotBlank(ef.attrName())){
|
ReflectUtils.invokeSetter(e, ef.attrName(), val);
|
}else{
|
if (os[1] instanceof Field){
|
ReflectUtils.invokeSetter(e, ((Field)os[1]).getName(), val);
|
}else if (os[1] instanceof Method){
|
String mthodName = ((Method)os[1]).getName();
|
if ("get".equals(mthodName.substring(0, 3))){
|
mthodName = "set"+StringUtils.substringAfter(mthodName, "get");
|
}
|
ReflectUtils.invokeMethod(e, mthodName, new Class[] {valType}, new Object[] {val});
|
}
|
}
|
}
|
sb.append(val+", ");
|
}
|
dataList.add(e);
|
log.debug("Read success: ["+i+"] "+sb.toString());
|
}
|
return dataList;
|
}
|
|
@Override
|
public void close() {
|
Iterator<Class<?>> it = fieldTypes.iterator();
|
while(it.hasNext()){
|
Class<?> clazz = it.next();
|
try {
|
clazz.getMethod("clearCache").invoke(null);
|
} catch (Exception e) {
|
// 报错忽略，有可能没实现此方法
|
}
|
}
|
}
|
|
}
|
