摘要：我想能不能像配置文件一樣可配置的導入導出，那樣使用起來就方便許多。配置和使用下面是員工信息模型。支持多種映射，使用英文逗號進行分割。導入時它會以分割前面的作為導入時使用的值，后面的作為導出時使用的值后面值進行逆推導出時同理。

在工作時，遇到過這樣的需求，需要靈活的對工單進行導入或導出，以前自己也做過，但使用不靈活繁瑣。我想能不能像配置文件一樣可配置的導入導出，那樣使用起來就方便許多。

創建基于Maven版本管理Springmvc項目，以下是主要的依賴，用jetty作為內嵌的服務器，直接啟動。

架包相關依賴pom.xml。

    
    
        1.9.2
        3.2.1
        2.6
        3.14
        2.6.0
        4.2.6.RELEASE
        1.2.17
        1.0.11
    

    
    
        
            junit
            junit
            4.12
            test
        
        
        
            commons-beanutils
            commons-beanutils
            ${commons-beanutils.version}
        
        
            commons-collections
            commons-collections
            ${commons-collections.version}
        
        
            commons-lang
            commons-lang
            ${commons-lang.version}
        

        
            org.apache.commons
            commons-lang3
            3.3.2
        

        
            commons-io
            commons-io
            2.4
        


        
        
            org.apache.poi
            poi
            ${poi.version}
        
        
            org.apache.poi
            poi-ooxml
            ${poi.version}
        
        
            org.apache.poi
            poi-ooxml-schemas
            ${poi.version}
        
        
            org.apache.xmlbeans
            xmlbeans
            ${xmlbeans.version}
        
        
        
            org.springframework
            spring-core
            ${spring.version}
        
        
            org.springframework
            spring-beans
            ${spring.version}
        
        
            org.springframework
            spring-context
            ${spring.version}
        
        
        
            log4j
            log4j
            ${log4j.version}
        

        
        
            mysql
            mysql-connector-java
            5.1.38
            runtime
        

        
            org.mybatis
            mybatis
            3.4.0
        

        
            org.mybatis
            mybatis-spring
            1.3.0
        
        

        
        
            org.springframework
            spring-jdbc
            ${spring.version}
        

        
            org.springframework
            spring-tx
            ${spring.version}
        

        
        
            org.springframework
            spring-web
            ${spring.version}
        

        
            org.springframework
            spring-webmvc
            ${spring.version}
        
        


        
        
            org.springframework
            spring-context-support
            ${spring.version}
        

        
            org.springframework
            spring-aop
            ${spring.version}
        

        
            org.springframework
            spring-aspects
            ${spring.version}
        

        
            org.springframework
            spring-expression
            ${spring.version}
        

        
        
        
            taglibs
            standard
            1.1.2
        
        
            jstl
            jstl
            1.2
        

        
            com.fasterxml.jackson.core
            jackson-databind
            2.6.5
        
        
            javax.servlet
            javax.servlet-api
            3.1.0
        

        
        
            org.slf4j
            slf4j-api
            1.7.15
        

        
            ch.qos.logback
            logback-core
            1.1.3
        
        
        
            ch.qos.logback
            logback-classic
            1.1.3
        

        
        
        
            com.alibaba
            druid
            ${druid.version}
        
        

        
        
            org.eclipse.jetty.aggregate
            jetty-all
            8.1.16.v20140903
            test
        
        
        
            org.eclipse.jetty
            jetty-webapp
            8.1.16.v20140903
            test
        
        
        
            org.eclipse.jetty
            jetty-jsp
            8.1.16.v20140903
        
        
            org.projectlombok
            lombok
            1.16.8
        

        
        
            org.codehaus.jackson
            jackson-mapper-asl
            1.9.13
        
        
        
            commons-fileupload
            commons-fileupload
            1.2.2
        
        
        
            com.google.guava
            guava
            18.0
        


        
            org.mongodb
            mongo-java-driver
            3.2.2
        

        
            org.springframework.data
            spring-data-mongodb
            1.8.4.RELEASE
        

        
            org.springframework.data
            spring-data-commons
            1.11.4.RELEASE
        

    

其它相關配置沒啥特別，詳見源碼。

下面是員工信息模型。

    //員工模型
    public class EmployeeModel {

    /**
     * ID
     */
    protected Integer id;
    /**
     * 創建時間
     */
    protected Date createTime;
    /**
     * 姓名
     */
    private String name;
    /**
     * 性別 0:男 1:女
     */
    private Integer sex;
    /**
     * 年齡
     */
    private Integer age;
    /**
     * 手機號
     */
    private String mobile;
    /**
     * 狀態 0:在職
     *     1:離職
     */
    private Integer status;
    //省略getter setter
    
    }
     

有如下的Excel文件格式，需要映射成學生實體類。

那么使用easy-excel 如何導入呢？

前一行是屬于不規則的數據，從標題行以后才是規則的數據，也就是從規則數據之后才能正常轉換成JavaBean。

具體實現代碼，首先編寫配置文件：excel-config.xml。

解釋,每個excel表示一種Excel文件到JavaBean的映射規則,該規則可以是導入和導出。

配置了一個id為employee的映射,要映射對應的JavaBean實體為 EmployeeModel。

excel文件中標題為ID的列,把它的值映射到 EmployeeModel.id屬性上。

isNull屬性,表示在excel文件中標題為【年齡】的單元格的值不能為空,并且符合正則【 regex】,當正則校驗沒有通過時,會提示【xxx行,[ 年齡 ]必須是數字,如果為空同理,xxx行[年齡]不能為空】。

pattern：不做過多解釋,SimpleDateFormat(pattern),導入數據時字符串的值如何轉換成日期。支持多種映射pattern，使用【英文逗號】進行分割。

format屬性,觀察上面的excel文件結構會發現狀態列是中文,那么導入時,可能javaBean中并不是中文,而是數字或其他,那么如何把它轉換成數字呢？format就是做這個事情的。導入時它會以【,分割:前面的作為導入時使用的值，:后面的作為導出時使用的值】:后面值進行逆推,導出時同理。思考一個問題？如果這個值不確定如何解決,或者這個值需要到數據庫校驗？比如是個城市地址，這個時候是需要查詢數據庫進行比對的，如果地址不存在則拋出錯誤提示信息的,就說這么多,easy-excel已經做好了,支持自定義的轉換器可以解決。

那么核心的代碼是哪幾行？

    //導入
    public Result importExcel(@RequestParam(value = "file", required = true) MultipartFile file) throws Exception {
        Boolean excel = StringUtil.isExcel(file.getOriginalFilename());
        if (!excel){
            return Result.wrapErrorResult("該文件不是Excel格式");
        }
        InputStream fis = file.getInputStream();
        ExcelContext context = new ExcelContext("excel/config.xml");
        ExcelUtil excelUtil = new ExcelUtil(excelContext, "employee");
        List stus;
        try {
            stus = excelUtil.importExcel(1, fis);
        } catch (ExcelException e) {//這里主動返回錯誤信息
            return Result.wrapErrorResult(e.getMessage());
        }
        List list=BdUtil.e2OList(stus,Employee.class);
        return Result.wrapSuccessfulResult(list);
    }

    //導出
    public void exportExcel(HttpServletRequest request, HttpServletResponse response) throws Exception {
        ExcelUtil excelUtil = new ExcelUtil(excelContext, "employee");
        final List list = getEmployeeList();
        List specifyFields = new ArrayList(
        ExcelHeader header=new ExcelHeader() {
            public void buildHeader(Sheet sheet, ExcelDefinition excelDefinition, List beans,Workbook workbook) {
                // 設置第一行樣式
                CellStyle style1 = workbook.createCellStyle();
                // 水平居中
                style1.setAlignment(HSSFCellStyle.ALIGN_CENTER);
                // 垂直居中
                style1.setVerticalAlignment(HSSFCellStyle.VERTICAL_CENTER);
                // 設置字體 大小
                Font font1 = workbook.createFont();
                font1.setFontHeightInPoints((short) 18);
                style1.setFont(font1);

                //第一行數據
                Row row1 = sheet.createRow(0);
                Cell cell1 = row1.createCell(0);
                cell1.setCellValue("共導出【"+list.size()+"】條數據");
                // 行高
                row1.setHeight((short) 700);
                cell1.setCellStyle(style1);

                //合并單元格
                CellRangeAddress region = new CellRangeAddress(0, 0, 0, 2);
                sheet.addMergedRegion(region);
            }
        };
        excelUtil.exportExcel(response,list, header,specifyFields,"員工信息");
    }

只有準備數據、創建上下文、讀取excel。。通常在真實的常見創建上下文都可以省略了，因為它會交給spring容器管理，整個jvm中，只保持一個實例就夠了。

關于導入配置的一個很重要的屬性：resolveFieldValueConverterName。

它是一個ResolveFieldValueConverter接口的實現類：假設我們的Excel中有地址，或者結合業務中可能是其他，都是需要查詢數據庫，或者經過更復雜的業務邏輯進行校驗的，那么我們可以配置它。我們來觀察這個接口做了什么事？

    /**
     * 解析Excel值解析接口
     *
     */

    public interface ResolveFieldValueConverter {
    
    /**
     * 操作類型，導入或導出
     */
    enum Type {
        EXPORT, IMPORT
    }
    
    /**
     * 解析配置中Field元素 處理后的值
     * @param bean Excel配置的JavaBean對象
     * @param value Excel原值
     * @param fieldValue FieldValue信息
     * @param type 導入或導出
     * @param rowNum 行號
     * @return 解析結果對應的value
     * @throws Exception
     */
    public Object resolveFieldValue(Object bean,Object value, FieldValue fieldValue, Type type,int rowNum) throws Exception;
    }

核心只有一個方法resolveFieldValue。

我們可以自定義它的實現類，然后把全類名注冊到 resolveFieldValueConverterName
屬性上如：假設創建人是需要查詢用戶表進行校驗，如果沒有則不允許導入，我們則可以在自定義的實現類拋出一個異常，可以精準的提示用戶多少行，哪一個字段【標題】的值錯誤了。

直接上代碼，下面是導入導出封裝好工具類。

    /**
     * Excel 導出方法調用(主)
     */
    public class ExcelUtil {

    //創建excel上下文實例,配置文件路徑
    private ExcelContext context;
    //Excel配置文件中配置的id
    private String excelId;

    public ExcelUtil(ExcelContext context, String excelId) {
        this.context = context;
        this.excelId = excelId;
    }
    
    /**
     * @param startRow 頭部從第幾行開始導入
     * @param fis      文件流
     * @return
     * @throws Exception
     */
    public List importExcel(int startRow, InputStream fis) throws Exception {
        //第二個參數需要注意,它是指標題索引的位置,可能你的前幾行并不是標題,而是其他信息,
        //比如數據批次號之類的,關于如何轉換成javaBean,具體參考配置信息描述
        ExcelImportResult result = context.readExcel(excelId, startRow, fis);
    //        System.out.println(result.getHeader());
        List stus = result.getListBean();
        return stus;
        //這種方式和上面的沒有任何區別,底層方法默認標題索引為0
        //context.readExcel(excelId, fis);
    }
    
        /**
         * 導出Excel并下載
         * @param response
         * @param list     結果集,null默認導出模板
         * @param header   自定義表頭,null默認無
         * @param specifyFields 導出字段,null導出所有字段
         * @param fileName  下載的文件名
         */
        public void exportExcel(HttpServletResponse response, List list,ExcelHeader header, List specifyFields, String fileName) {
            File file = null;
            OutputStream ops = null;
            OutputStream out = null;
            Workbook workbook = null;
            try {
                /**
                 * Step1:創建臨時xlsx文件
                 */
                file = File.createTempFile("tmp", ".xlsx");
                /**
                 * Step2:導出數據寫入臨時xlsx文件
                 */
                String path = file.getAbsolutePath();
                ops = new FileOutputStream(path);
                //獲取POI創建結果
                if (list != null && !list.isEmpty()) {
                    workbook = context.createExcel(excelId, list, header, specifyFields);
    //                workbook = context.createExcel(excelId, list);
                } else {//查詢結果為空,導出模板
                    workbook = context.createExcelTemplate(excelId, header, specifyFields);
                }
                workbook.write(ops);
                /**
                 * Step3:下載臨時xlsx文件
                 */
                response.reset();
                response.setContentType("application/octet-stream; charset=utf-8");
                fileName = URLEncoder.encode(fileName + ".xlsx", "UTF-8");
                response.setHeader("Content-Disposition", "attachment; filename=" + fileName);
                out = response.getOutputStream();
                out.write(FileUtils.readFileToByteArray(file));
                out.flush();
    
            } catch (FileNotFoundException e) {
                e.printStackTrace();
            } catch (IOException e) {
                e.printStackTrace();
            } catch (Exception e) {
                e.printStackTrace();
            } finally {
                file.deleteOnExit();//臨時文件若存在,則刪除
                try {
                    if (ops != null) {
                        ops.close();
                    }
                    if (workbook != null) {
                        workbook.close();
                    }
                    if (out != null) {
                        out.close();
                    }
                } catch (IOException e) {
                    e.printStackTrace();
                }
    
            }
        }
    
     }