合作企业：

开源库地址（同步更新）：

功能简介

功能强大

组件特色

组件需知

导入&导出

导入

导出

扩展

/*** HttpServletResponse 通用导出Excel构造器*/ExportBuilder(HttpServletResponseresponse,StringfileName,ClassexcelClass,IntegerpageSize,IntegerrowAccessWindowSize,IntegerrecordCountPerSheet,BooleanopenAutoColumWidth)/*** OutputStream 通用导出Excel构造器*/ExportBuilder(OutputStreamoutputStream,StringfileName,ClassexcelClass,IntegerpageSize,IntegerrowAccessWindowSize,IntegerrecordCountPerSheet,BooleanopenAutoColumWidth)

/**     * Excel自动刷新到磁盘的数量     */publicstaticfinalintDEFAULT_ROW_ACCESS_WINDOW_SIZE =2000;/**     * 分页条数     */publicstaticfinalintDEFAULT_PAGE_SIZE =3000;/**     * 分Sheet条数     */publicstaticfinalintDEFAULT_RECORD_COUNT_PEER_SHEET =80000;/**     * 是否开启自动适配宽度     */publicstaticfinalbooleanOPEN_AUTO_COLUM_WIDTH =true;

版本

使用手册

POM.xml

<dependency><groupId>io.github.magic-core</groupId><artifactId>excel-boot</artifactId><version>2.0</version></dependency>

导出导入实体对象

/*** 导出导入实体对象** 导出注解说明* columnName:导出Excel列名* scale:导出BigDecimal类型格式化精度* roundingMode:导出BigDecimal类型舍入规则* dateFormat:导出Data类型格式化模式* defaultCellValue:导出模板默认值** 导入注解说明* required:是否非空校验* regex:正则校验规则* regexMessage:正则校验失败信息* scale:导出BigDecimal类型格式化精度* roundingMode:导出BigDecimal类型舍入规则* dateFormat:导出Data类型格式化模式*/publicclassUserEntity {/*** Integer类型字段*/@ExportField(columnName ="ID",defaultCellValue ="1")@ImportField(required =true)privateIntegerid;/*** String类型字段*/@ExportField(columnName ="姓名",defaultCellValue ="张三")@ImportField(regex =IDCARD_REGEX,regexMessage="身份证校验失败")privateStringname;/*** BigDecimal类型字段*/@ExportField(columnName ="收入金额",defaultCellValue ="100",scale =2,roundingMode=BigDecimal.ROUND_HALF_EVEN)@ImportField(scale =2,roundingMode=BigDecimal.ROUND_HALF_EVEN)privateBigDecimalmoney;/*** Date类型字段*/@ExportField(columnName ="创建时间",dateFormat="yyyy-MM-dd",defaultCellValue ="2019-01-01")@ImportField(dateFormat="yyyy-MM-dd")privateDatebirthDayTime;}

导入Demo

/** * 导入Demo * * UserEntity是标注注解的类, Excel的导入映射类, onProcess的userEntity参数则是Excel每行数据的映射实体 * 需要使用本组件的开发者自己定义 * * ErrorEntity是封装了每行Excel数据常规校验后的错误信息实体, 封装了sheet号、行号、列号、单元格值、所属列名、错误信息 * * onProcess方法是用户自己实现, 当经过正则或者判空常规校验成功后执行的方法, 参数是每行数据映射的实体 * onError方法是用户自己实现, 当经过正则或者判空常规校验失败后执行的方法 */@Controller@RequestMapping("/import")publicclassTestController {@RequestMapping("/importExcel")publicvoidimportExcel()throwsIOException {ExcelBoot.ImportBuilder(newFileInputStream(newFile("C:\\Users\\导入Excel文件.xlsx")),UserEntity.class)                .importExcel(newImportFunction<UserEntity>() {/**                     * @param sheetIndex 当前执行的Sheet的索引, 从1开始                     * @param rowIndex 当前执行的行数, 从1开始                     * @param userEntity Excel行数据的实体                     */@OverridepublicvoidonProcess(intsheetIndex,introwIndex,UserEntityuserEntity) {//将读取到Excel中每一行的userEntity数据进行自定义处理//如果该行数据发生问题,将不会走本方法,而会走onError方法                    }/**                     * @param errorEntity 错误信息实体                     */@OverridepublicvoidonError(ErrorEntityerrorEntity) {//将每条数据非空和正则校验后的错误信息errorEntity进行自定义处理                    }                });    }}

导出Demo

/** * 导出Demo * * UserEntity是标注注解的类,Excel映射的导出类 * 需要使用本组件的开发者自己定义 * ParamEntity是查询的参数对象 * 需要使用本组件的开发者自己定义 * ResultEntity是查询到的结果List内部元素 * 需要使用本组件的开发者自己定义 * * UserEntity可以和ResultEntity使用同一个对象,即直接在查询的结果对象上标注注解(建议使用两个对象, 实现解耦) * * pageQuery方法是用户自己实现, 即导出Excel的数据来源, 根据查询条件和当前页数和每页条数进行数据层查询, 当返回List的条数为NULL或者小于DEFAULT_PAGE_SIZE(每页条数)时, 将视为查询结束, 反之则会发生死循环 * convert方法是用户自己实现, 参数就是您查询出来的list中的每个元素引用, 您可以对对象属性的转换或者对象的转换, 但是必须返回标注注解的对象 */@Controller@RequestMapping("/export")publicclassTestController {/**     * 浏览器导出Excel     *     * @param httpServletResponse     */@RequestMapping("/exportResponse")publicvoidexportResponse(HttpServletResponsehttpServletResponse) {ParamEntityqueryQaram =newParamEntity();ExcelBoot.ExportBuilder(httpServletResponse,"Excel文件名",UserEntity.class).exportResponse(queryQaram,newExportFunction<ParamEntity,ResultEntity>() {/**                     * @param queryQaram 查询条件对象                     * @param pageNum    当前页数,从1开始                     * @param pageSize   每页条数,默认3000                     * @return                     */@OverridepublicList<ResultEntity>pageQuery(ParamEntityqueryQaram,intpageNum,intpageSize) {//1.将pageNum和pageSize传入使用本组件的开发者自己项目的分页逻辑中//2.调用使用本组件的开发者自己项目的分页查询方法List<ResultEntity>result=dao().queryPage(queryQaram);returnresult;                    }/**                     * 将查询出来的每条数据进行转换                     *                     * @param o                     */@OverridepublicUserEntityconvert(ResultEntityo) {//用于编写开发者自定义的转换逻辑returnnewUserEntity();                    }                });    }/**     * 浏览器多sheet导出Excel     *     * @param httpServletResponse     */@RequestMapping("/exportMultiSheetResponse")publicvoidexportMultiSheetResponse(HttpServletResponsehttpServletResponse) {ParamEntityqueryQaram =newParamEntity();ExcelBoot.ExportBuilder(httpServletResponse,"Excel文件名",UserEntity.class).exportMultiSheetStream(queryQaram,newExportFunction<ParamEntity,ResultEntity>() {/**                     * @param queryQaram 查询条件对象                     * @param pageNum    当前页数,从1开始                     * @param pageSize   每页条数,默认3000                     * @return                     */@OverridepublicList<ResultEntity>pageQuery(ParamEntityqueryQaram,intpageNum,intpageSize) {//1.将pageNum和pageSize传入使用本组件的开发者自己项目的分页逻辑中//2.调用使用本组件的开发者自己项目的分页查询方法List<ResultEntity>result=dao().queryPage(queryQaram);returnresult;                    }/**                     * 将查询出来的每条数据进行转换                     *                     * @param o                     */@OverridepublicUserEntityconvert(ResultEntityo) {//用于编写开发者自定义的转换逻辑returnnewUserEntity();                    }                });    }/**     * 导出Excel到指定路径     */@RequestMapping("/exportStream")publicvoidexportStream()throwsFileNotFoundException {ParamEntityqueryQaram =newParamEntity();ExcelBoot.ExportBuilder(newFileOutputStream(newFile("C:\\Users\\Excel文件.xlsx")),"Sheet名",UserEntity.class)                .exportStream(queryQaram,newExportFunction<ParamEntity,ResultEntity>() {/**                     * @param queryQaram 查询条件对象                     * @param pageNum    当前页数,从1开始                     * @param pageSize   每页条数,默认3000                     * @return                     */@OverridepublicList<ResultEntity>pageQuery(ParamEntityqueryQaram,intpageNum,intpageSize) {//1.将pageNum和pageSize传入使用本组件的开发者自己项目的分页逻辑中//2.调用使用本组件的开发者自己项目的分页查询方法List<ResultEntity>result=dao().queryPage(queryQaram);returnresult;                    }/**                     * 将查询出来的每条数据进行转换                     *                     * @param o                     */@OverridepublicUserEntityconvert(ResultEntityo) {//用于编写开发者自定义的转换逻辑returnnewUserEntity();                    }                });    }/**     * 导出多sheet Excel到指定路径     */@RequestMapping(value ="exportMultiSheetStream")publicvoidexportMultiSheetStream()throwsFileNotFoundException {ParamEntityqueryQaram =newParamEntity();ExcelBoot.ExportBuilder(newFileOutputStream(newFile("C:\\Users\\Excel文件.xlsx")),"Sheet名",UserEntity.class)                .exportMultiSheetStream(queryQaram,newExportFunction<ParamEntity,ResultEntity>() {/**                     * @param queryQaram 查询条件对象                     * @param pageNum    当前页数,从1开始                     * @param pageSize   每页条数,默认3000                     * @return                     */@OverridepublicList<ResultEntity>pageQuery(ParamEntityqueryQaram,intpageNum,intpageSize) {//1.将pageNum和pageSize传入使用本组件的开发者自己项目的分页逻辑中//2.调用使用本组件的开发者自己项目的分页查询方法List<ResultEntity>result=dao().queryPage(queryQaram);returnresult;                    }/**                     * 将查询出来的每条数据进行转换                     *                     * @param o                     */@OverridepublicUserEntityconvert(ResultEntityo) {//用于编写开发者自定义的转换逻辑returnnewUserEntity();                    }                });    }/**     * 生成Excel OutputStream对象     */@RequestMapping(generateStream)publicvoidgenerateExcelStream()throwsFileNotFoundException {ParamEntityqueryQaram =newParamEntity();OutputStreamoutputStream =ExcelBoot.ExportBuilder(newFileOutputStream(newFile("C:\\Users\\Excel文件.xlsx")),"Sheet名",UserEntity.class)                .generateExcelStream(queryQaram,newExportFunction<ParamEntity,ResultEntity>() {/**                     * @param queryQaram 查询条件对象                     * @param pageNum    当前页数,从1开始                     * @param pageSize   每页条数,默认3000                     * @return                     */@OverridepublicList<ResultEntity>pageQuery(ParamEntityqueryQaram,intpageNum,intpageSize) {//1.将pageNum和pageSize传入使用本组件的开发者自己项目的分页逻辑中//2.调用使用本组件的开发者自己项目的分页查询方法List<ResultEntity>result=dao().queryPage(queryQaram);returnresult;                    }/**                     * 将查询出来的每条数据进行转换                     *                     * @param o                     */@OverridepublicUserEntityconvert(ResultEntityo) {//用于编写开发者自定义的转换逻辑returnnewUserEntity();                    }                });    }/**     * 生成多Sheet Excel OutputStream对象     */@RequestMapping(generateMultiSheetStream)publicvoidgenerateMultiSheetExcelStream()throwsFileNotFoundException {ParamEntityqueryQaram =newParamEntity();OutputStreamoutputStream =ExcelBoot.ExportBuilder(newFileOutputStream(newFile("C:\\Users\\Excel文件.xlsx")),"Sheet名",UserEntity.class)                .generateMultiSheetExcelStream(queryQaram,newExportFunction<ParamEntity,ResultEntity>() {/**                     * @param queryQaram 查询条件对象                     * @param pageNum    当前页数,从1开始                     * @param pageSize   每页条数,默认3000                     * @return                     */@OverridepublicList<ResultEntity>pageQuery(ParamEntityqueryQaram,intpageNum,intpageSize) {//1.将pageNum和pageSize传入使用本组件的开发者自己项目的分页逻辑中//2.调用使用本组件的开发者自己项目的分页查询方法List<ResultEntity>result=dao().queryPage(queryQaram);returnresult;                    }/**                     * 将查询出来的每条数据进行转换                     *                     * @param o                     */@OverridepublicUserEntityconvert(ResultEntityo) {//用于编写开发者自定义的转换逻辑returnnewUserEntity();                    }                });    }/**     * 导出Excel模板     */@RequestMapping("/exportTemplate")publicvoidexportTemplate(HttpServletResponsehttpServletResponse) {ExcelBoot.ExportBuilder(httpServletResponse,"Excel模板名称",UserEntity.class).exportTemplate();    }}