Java Excel导入导出，基于XML和Easy-excel使用

摘要：我想能不能像配置文件一样可配置的导入导出，那样使用起来就方便许多。配置和使用下面是员工信息模型。支持多种映射，使用英文逗号进行分割。导入时它会以分割前面的作为导入时使用的值，后面的作为导出时使用的值后面值进行逆推导出时同理。

在工作时，遇到过这样的需求，需要灵活的对工单进行导入或导出，以前自己也做过，但使用不灵活繁琐。我想能不能像配置文件一样可配置的导入导出，那样使用起来就方便许多。

创建基于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();
                }
    
            }
        }
    
     }