Java導入Excel工具類使用教程

前言：

本工具類提供了Excel導入功能，通過反射機制將Excel中數據映射到實體類中，從而獲取Excel數據，工具類依賴org.apache.poi包。支持RESTful API，支持Spring MVC中使用。

一.本工具類支持功能：

• 支持File類型導入
• 支持MultipartFile類型導入
• 支持Excel2003及以上版本

二.工具類

本工具類，可直接在項目中使用。

package com.excel.util;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.poi.ss.usermodel.Cell;
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 org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.multipart.MultipartFile;

/**
 * Excel導入工具類
 */
public class ImportExcelUtil {

    // 正則表達式 ,用於判斷是get還是set方法
    private static final String REGEX = "[a-zA-Z]";

    private static final Logger log = LoggerFactory.getLogger(ImportExcelUtil.class);

    /**
     * @param multipartFile
     * @param startRow      開始行
     * @param endRow        結束行（0表示到最後一行結束）
     * @param clazz
     * @return
     * @throws Exception
     */
    public static List<List<Object>> importExcelMultipartFile(MultipartFile multipartFile, int startRow, int endRow,
                                                              Class<?> clazz) throws Exception {
        // 判斷文件是否存在
        if (multipartFile == null || multipartFile.isEmpty()) {
            throw new IOException("Excel文件內容爲空或不存在！");
        }
        String name = "Excel" + System.currentTimeMillis();
        File file = File.createTempFile(name, null);
        multipartFile.transferTo(file);
        if (!file.exists()) {
            throw new IOException("文件名爲" + file.getName() + "Excel文件不存在！");
        }
        return importExcelFile(file, startRow, endRow, clazz);
    }

    /**
     * 根據文件導入Excel，僅導入數據，去除校驗
     *
     * @param file     文件
     * @param startRow 開始行，從0開始
     * @param endRow   結束行，0表示所有行; 正數表示到第幾行結束; 負數表示到倒數第幾行結束
     * @param clazz    sheet需要映射的對象類型
     * @return List<List < Object>>
     * @throws Exception
     */
    public static List<List<Object>> importExcelFile(File file, int startRow, int endRow, Class<?> clazz)
            throws Exception {
        List<List<Object>> sheetsData = new ArrayList<>();
        // 判斷文件是否存在
        if (!file.exists()) {
            throw new IOException("文件名爲" + file.getName() + "Excel文件不存在！");
        }
        Workbook wb = null;
        FileInputStream inputStream = null;
        try {
            inputStream = new FileInputStream(file);
            // 工廠模式，根據Excel版本（2003版以前版本，或其他版本），創建對應的工作薄處理類
            wb = WorkbookFactory.create(inputStream);
            for (int sheetNumber = 0; sheetNumber < wb.getNumberOfSheets(); sheetNumber++) {
                List<Row> rowList = new ArrayList<Row>();
                Sheet sheet = wb.getSheetAt(sheetNumber);
                // 獲取最後行號
                int lastRowNum = sheet.getLastRowNum();
                Row row = null;
                Pattern p = Pattern.compile("\\s*|\t|\r|\n");
                // 循環讀取
                for (int i = startRow; i <= lastRowNum + endRow; i++) {
                    // 是否全部單元格都爲空
                    boolean isEmptyRow = true;
                    row = sheet.getRow(i);
                    if (row != null) {
                        // 獲取每一單元格的值
                        for (int j = 0; j < row.getLastCellNum(); j++) {
                            String value = p.matcher(getCellValue(row.getCell(j))).replaceAll("");
                            if (!value.trim().equals("")) {
                                isEmptyRow = false;
                            }
                        }
                        // 校驗規則：如果是空白行，沒有數據，僅有空格符、製表符等字符（用戶無意間輸入的字符），則應該過濾掉。
                        if (!isEmptyRow) {
                            // 該行數據中存在非空單元格，則返回該行
                            rowList.add(row);
                        }
                    }
                }
                sheetsData.add(returnObjectList(rowList, clazz));
            }
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (wb != null) {
                wb.close();
            }
        }
        return sheetsData;
    }

    /**
     * 功能:返回指定的對象集合
     */
    private static List<Object> returnObjectList(List<Row> rowList, Class<?> clazz) {
        List<Object> objectList = null;
        Object obj = null;
        String attribute = null;
        String value = null;
        int j = 0;
        try {
            objectList = new ArrayList<Object>();
            Field[] declaredFields = clazz.getDeclaredFields();
            for (Row row : rowList) {
                j = 0;
                obj = clazz.newInstance();
                for (Field field : declaredFields) {
                    try {
                        attribute = field.getName().toString();
                        value = getCellValue(row.getCell(j));
                        setAttrributeValue(obj, attribute, value.trim());
                        j++;
                    } catch (Exception e) {
                        log.info("屬性映射出錯，屬性名：" + attribute + "屬性值：" + value);
                        e.printStackTrace();
                    }
                }
                // 僅提取沒有非空字段的對象
                objectList.add(obj);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return objectList;
    }

    /**
     * 功能:獲取單元格的值
     */
    @SuppressWarnings("deprecation")
    private static String getCellValue(Cell cell) {
        Object result = "";
        if (cell != null) {
            switch (cell.getCellType()) {
                case Cell.CELL_TYPE_STRING:
                    result = cell.getStringCellValue();
                    break;
                case Cell.CELL_TYPE_NUMERIC:
                    result = cell.getNumericCellValue();
                    break;
                case Cell.CELL_TYPE_BOOLEAN:
                    result = cell.getBooleanCellValue();
                    break;
                case Cell.CELL_TYPE_FORMULA:
                    result = cell.getCellFormula();
                    break;
                case Cell.CELL_TYPE_ERROR:
                    result = cell.getErrorCellValue();
                    break;
                case Cell.CELL_TYPE_BLANK:
                    break;
                default:
                    break;
            }
        }
        return result.toString();
    }

    /**
     * 功能:給指定對象的指定屬性賦值
     */
    private static void setAttrributeValue(Object obj, String attribute, String value) {
        if (value == null || value.trim().equals("")) {
            return;
        }
        // 得到該屬性的set方法名
        String method_name = convertToMethodName(attribute, obj.getClass(), true);
        Method[] methods = obj.getClass().getMethods();
        for (Method method : methods) {
            /**
             * 因爲這裏只是調用bean中屬性的set方法，屬性名稱不能重複 所以set方法也不會重複，所以就直接用方法名稱去鎖定一個方法 （注：在java中，鎖定一個方法的條件是方法名及參數）
             */
            if (method.getName().equals(method_name)) {
                Class<?>[] parameterC = method.getParameterTypes();
                try {
                    /**
                     * 如果是(整型,浮點型,布爾型,字節型,時間類型), 按照各自的規則把value值轉換成各自的類型 否則一律按類型強制轉換(比如:String類型)
                     */
                    if (parameterC[0] == int.class || parameterC[0] == java.lang.Integer.class) {
                        int index = value.lastIndexOf(".");
                        if (index != -1) {
                            value = value.substring(0, index);
                        }
                        try {
                            method.invoke(obj, Integer.valueOf(value));
                        } catch (Exception e) {
                            System.out.println(value);
                            e.printStackTrace();
                        }
                        break;
                    } else if (parameterC[0] == float.class || parameterC[0] == java.lang.Float.class) {
                        method.invoke(obj, Float.valueOf(value));
                        break;
                    } else if (parameterC[0] == double.class || parameterC[0] == java.lang.Double.class) {
                        method.invoke(obj, Double.valueOf(value));
                        break;
                    } else if (parameterC[0] == byte.class || parameterC[0] == java.lang.Byte.class) {
                        method.invoke(obj, Byte.valueOf(value));
                        break;
                    } else if (parameterC[0] == boolean.class || parameterC[0] == java.lang.Boolean.class) {
                        method.invoke(obj, Boolean.valueOf(value));
                        break;
                    } else if (parameterC[0] == java.util.Date.class) {
                        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
                        Date date = null;
                        try {
                            date = sdf.parse(value);
                        } catch (Exception e) {
                            e.printStackTrace();
                        }
                        method.invoke(obj, date);
                        break;
                    } else {
                        method.invoke(obj, parameterC[0].cast(value));
                        break;
                    }
                } catch (IllegalArgumentException e) {
                    e.printStackTrace();
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                } catch (InvocationTargetException e) {
                    e.printStackTrace();
                } catch (SecurityException e) {
                    e.printStackTrace();
                }
            }
        }
    }

    /**
     * 功能:根據屬性生成對應的set/get方法
     */
    private static String convertToMethodName(String attribute, Class<?> objClass, boolean isSet) {
        /** 通過正則表達式來匹配第一個字符 **/
        Pattern p = Pattern.compile(REGEX);
        Matcher m = p.matcher(attribute);
        StringBuilder sb = new StringBuilder();
        /** 如果是set方法名稱 **/
        if (isSet) {
            sb.append("set");
        } else {
            /** get方法名稱 **/
            try {
                Field attributeField = objClass.getDeclaredField(attribute);
                /** 如果類型爲boolean **/
                if (attributeField.getType() == boolean.class || attributeField.getType() == Boolean.class) {
                    sb.append("is");
                } else {
                    sb.append("get");
                }
            } catch (SecurityException e) {
                e.printStackTrace();
            } catch (NoSuchFieldException e) {
                e.printStackTrace();
            }
        }
        /** 針對以下劃線開頭的屬性 **/
        if (attribute.charAt(0) != '_' && m.find()) {
            sb.append(m.replaceFirst(m.group().toUpperCase()));
        } else {
            sb.append(attribute);
        }
        return sb.toString();
    }

}

三.如何使用：

1.導入MultipartFile類型(推薦)

應用場景： Web頁面中通過MultipartFile上傳文件，可直接轉爲List<List<Object>>。

使用示例：

 @PostMapping(value = "/project/import")
    public ResultObject importAlarmEvents(@RequestParam MultipartFile file) {
      
        try {
            // 從Excel第一行起到最後一行結束,
            List<List<Object>> excelData = ImportExcelUtil.importExcelMultipartFile(file, 1, 0, EventDTO.class);
            if (excelData == null || excelData.isEmpty()) {
                result.setMessage("導入失敗,Excel內容爲空");
                return result;
            }
            //將Excel中數據，轉爲你的實體類
            List<List<EventDTO>> alarmList = new ArrayList<>();
            for (List<?> list : excelData) {
                alarmList.add((List<EventDTO>) list);
            }
            Map<String, Object> res = eventService.importEvent(alarmList);
        } catch (Exception e) {
            result.setMessage(e.getMessage());
        }
        return result;
    }

2.導入文件格式爲File

應用場景： Web頁面中通過File上傳文件，可直接轉爲List<List<Object>>。

使用示例：

 @PostMapping(value = "/project/import")
    public ResultObject importAlarmEvents(@RequestParam File file) {
      
        try {
            // 從Excel第一行起到最後一行結束,
            List<List<Object>> excelData = ImportExcelUtil.importExcelFile(file, 1, 0, EventDTO.class);
            if (excelData == null || excelData.isEmpty()) {
                result.setMessage("導入失敗,Excel內容爲空");
                return result;
            }
            //將Excel中數據，轉爲你的實體類
            List<List<EventDTO>> alarmList = new ArrayList<>();
            for (List<?> list : excelData) {
                alarmList.add((List<EventDTO>) list);
            }
            Map<String, Object> res = eventService.importEvent(alarmList);
        } catch (Exception e) {
            result.setMessage(e.getMessage());
        }
        return result;
    }

實體類示例：

注意：實體類的屬性聲明順序，必須跟Excel列頭順序保持一致，否則會出現列數據和屬性名對應不上問題

package com.entity.dto;

import java.io.Serializable;

/**
 * 數據轉Excel對象 注：屬性名的順序和Excel列順序必須相同
 */
@SuppressWarnings("serial")
public class EventDTO implements Serializable {
	// 列字段1
	private String name;
	// 列字段2
	private String code;

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getCode() {
		return code;
	}

	public void setCode(String code) {
		this.code = code;
	}
}