SpringStarter快速实现Excel导入导出的方法

自我介绍

IT 果果

一个普通的技术宅，欢迎点赞、关注和转发，请多关照。

入门和安装

简介

为了满足项目中快速实现 excel 导入导出的功能，将 excel 开源工具 easypoi 整合成 spring-boot-starter 的方式，在做到对 easypoi 无侵入的同时减少了一些重复代码。例如:

这些场景也是我在平时项目上经常会用到的功能点，为了避免重复造轮子，减少冗余代码，所以写了一个 easypoix-spring-boot-starter 扩展 jar 包。

安装


    com.itguoguo
    easypoix-spring-boot-starter
    1.0.0.RELEASE

itguoguo.easypoix.dictPrefix=basic:dict:

工具

spring-boot-starter

SpringBoot 核心就是几个注解：SpringBootConfiguration、EnableAutoConfiguration、ComponentScan，依赖这几个注解完成了所谓自动装配的功能，这个自动装配说简单点就是把你需要的 Bean 注入到 Spring 容器里面。（SpringBootApplication 启动类上的注解，只是简单的组合了 SpringBootConfiguration、EnableAutoConfiguration、ComponentScan 几个注解，避免开发者一个一个的去加）。

SpringBoot 程序在启动过程中会解析 SpringBootConfiguration、EnableAutoConfiguration、ComponentScan 三个注解：

Spring Boot 在启动的时候会干这几件事情：

总结：

SpringBoot 并没有想象那么神秘，就是这么几件事情：

1.提供了一个配置类，该配置类定义了我们需要的对象的实例化过程；

2.提供了一个 spring.factories 文件，包含了配置类的全限定名；

3.将配置类和 spring.factories 文件打包为一个启动器 starter；

4.程序启动时通过加载 starter.jar 包的 spring.factories 文件信息，然后通过反射实例化文件里面的类。

easypoi

独特的功能

使用

Maven 坐标


    cn.afterturn
    easypoi-base
    4.1.0


    cn.afterturn
    easypoi-web
    4.1.0


    cn.afterturn
    easypoi-annotation
    4.1.0


使用场景

我们的目标是尽可能使用一个工具类方法就能实现简单的导出和导入 Excel 的功能，以下列出了几个常见的场景供参考。

简单导出 Excel

实现步骤

新建一个导出实体模型，@ExcelFileAttr 注解提供导出 Excel 的文件名，@Excel 注解提供表头的字段，其中 name 属性是字段名称，dict 属性是字典的关键字常量

@Data
@ExcelFileAttr(fileName = "导出.xls")
public class ExportPersonExcelModal implements Serializable {
    @Excel(name = "姓名")
    private String name;
    @Excel(name = "性别", dict = DICT_XB)
    private String sex;
    @Excel(name = "民族", dict = DICT_MZ)
    private String mz;
}

使用工具类 EasyPoiUtil 的 exportExcel 方法即可实现 excel 导出功能，只需要传递两个参数 。

EasyPoiUtil.exportExcel(list, response);

比较 EasyPoi 和 EasyPoiX

相对于 EasyPoi 官方的导出方式，EasyPoiX 对于导出时字典的处理更加方便，不需要额外提供

IExcelDictHandler 实现，EasyPoi 的 IExcelDictHandler 接口两个实现方法如下：

/**
 * 从值翻译到名称
 * @param dict  字典 Key
 * @param obj   对象
 * @param name  属性名称
 * @param value 属性值
 * @return
 */
public String toName(String dict, Object obj, String name, Object value);

/**
 * 从名称翻译到值
 * @param dict  字典 Key
 * @param obj   对象
 * @param name  属性名称
 * @param value 属性值
 * @return
 */
public String toValue(String dict, Object obj, String name, Object value);

toName 方法用于导出时字典值到字典名称的转换；toValue 方法用于导入时字典名称到字典值的转换。如果使用 EasyPoi，则多个字典公用一个 IExcelDictHandler 接口时需要多个 if-else 判断，并且在 Excel 导入导出时重复查询同一个字典时会有效率问题，另外在项目中多个字典的查询接口往往是同一个方法，所以显得代码重复不美观。

为了解决以上问题，EasyPoiX 在导出时提供了字典转换的默认字典转换接口，且不需要在工具类中传参指定（如果有特殊要求也可以指定自定义的字典转换接口）。那么问题来了，字典的取值方法在哪里定义呢？EasyPoiX 提供了一个@ExcelDictDataType 注解和一个 ExcelDictDataService 接口，代码示例如下：

@ExcelDictDataType({DICT_XB, DICT_MZ, DICT_COMMUNITY})
@Component
public class BasicDictDataService implements ExcelDictDataService {
    public static final String DICT_XB = "XB";
    public static final String DICT_MZ = "MZ";

    @Override
    public Map getData(DataParam params) {
        // 获取字典值的实现代码
        // 不论是字典的名称转值还是值转名称，都会从这里取值
        // 返回的 Map 类型，key 是字典值，value 是字典名称
        return map;
    }
}

大数据导出 Excel

实现步骤

使用工具类 EasyPoiUtil 的 exportBigExcel 方法即可实现 excel 大数据导出功能，传参：

DefaultBigExcelExportServer ser = new DefaultBigExcelExportServer((queryParams, page) -> findPage(queryParams, page));
EasyPoiUtil.exportBigExcel(ExportPersonExcelModal.class, ser, param, response);

比较 EasyPoi 和 EasyPoiX

EasyPoi 需要实现 IExcelExportServer 接口，EasyPoiX 不需要实现，而是传递一个 DefaultBigExcelExportServer 对象，构造对象时提供一个分页查询的 lamda 表达式

或者叫分页查询方法。这样的好处是不需要为每一个 Excel 都单独新建一个 IExcelExportServer 接口实现类。

/**
 * 导出数据接口
 */
public interface IExcelExportServer {
    /**
     * 查询数据接口
     * @param queryParams 查询条件
     * @param page        当前页数从 1 开始
     * @return
     */
    public List selectListForExcelExport(Object queryParams, int page);
}
导入 Excel
导入 Excel 场景相对于导出场景要复杂一些，除了调用工具类的导入方法和字典转换取值实现以外，还额外增加了两个场景 ：1、数据校验；2、数据处理。这两个场景都不是导入时的必选步骤，但都很常见。下面就对这两个场景详细说明一下。
数据校验
EasyPoi 提供了一个数据校验接口 IExcelVerifyHandler
/**
 * 导入校验接口
 * @author JueYue
 *  2014 年 6 月 23 日 下午 11:08:21
 */
public interface IExcelVerifyHandler {
    /**
     * 导入校验方法
     * @param obj
     *            当前对象
     * @return
     */
    public ExcelVerifyHandlerResult verifyHandler(T obj);
}
EasyPoiX 对其进行了一个小优化，增加了数据重复的校验功能，比如导入人员名单时，出现了相同的身份证号会提示后面出现的那个身份证号重复。使用方法也很简单，只需要继承一个 DefaultExcelVerifyHandler 类即可，示例代码如下：
@Component
public class ImportPersonExcelVerifyHandler extends DefaultExcelVerifyHandler {
    @Override
    public ExcelVerifyHandlerResult verifyHandler(ImportPersonExcelModal obj) {
        Set idCards = getRepeatTmp("idCard");
        if (idCards.contains(obj.getIdCard())) {
            return new ExcelVerifyHandlerResult(false, "证件号重复");
        }
        idCards.add(obj.getIdCard());
        return new ExcelVerifyHandlerResult(true);
    }
}
这里要特别指出一下，返回的 ExcelVerifyHandlerResult 类型构造时如果 success 参数传 true 就表示校验通过；如果传 false，就会在导入方法返回的导入数据中校验不通过的那个元素中，errorMsg 设置为校验错误的提示信息。所以导入的实体类需要继承 ImportExcelModel 类。
public class ImportExcelModel implements Serializable, IExcelDataModel, IExcelModel {
    /**
     * 行号
     */
    private int rowNum;
    /**
     * 错误消息
     */
    @Excel(name = "错误信息")
    private String errorMsg;

    @Override
    public int getRowNum() {
        return rowNum;
    }
    @Override
    public void setRowNum(int rowNum) {
        this.rowNum = rowNum;
    }
    @Override
    public String getErrorMsg() {
        return errorMsg;
    }
    @Override
    public void setErrorMsg(String errorMsg) {
        this.errorMsg = errorMsg;
    }
}
数据处理
数据处理的场景其实和数据字典的场景非常相似，都是需要对 excel 数据做一些转换操作。但是他们的不同点在于数据字典更偏向于转换全局唯一的常量，所以@Excel 注解里的 dict 属性在不同 Excel 实体里都是共用的；而数据处理是在数据字典转换操作完成以后进行的，因为数据处理的字段在转换时可能会用到当前 Excel 行的其他字段，包括转换后的字典值。
举个例子，比如导入的 excel 行数据多个字段之间存在联动查询的关系，就需要自定义数据处理了。例如导入的一行字段里有小区和楼栋，小区名称和小区 id 的转换不需要依赖其他字段，但是楼栋名称和楼栋 id 的转换是需要根据小区 id 查询的，虽然同样可以通过字典方式转换，但是最好还是在字典转换之后，数据处理的步骤再转换更安全。
此外，字典转换做不到同一个关键字在不同实体里，使用不同的转换逻辑，因为字典的含义本身就是全局唯一的。而数据处理转换可以做到同一个关键字在不同实体里，使用不同的转换实现。下面用 EasyPoi 和 EasyPoiX 的两种代码实现来更加详细的介绍他们的区别。
EasyPoi 的数据处理
EasyPoi 提供了默认数据处理器虚类 ExcelDataHandlerDefaultImpl
public abstract class ExcelDataHandlerDefaultImpl implements IExcelDataHandler {
    /**
     * 需要处理的字段
     */
    private String[] needHandlerFields;

    // 省略部分代码.....

    @Override
    public Object importHandler(T obj, String name, Object value) {
        return value;
    }
    @Override
    public Object exportHandler(T obj, String name, Object value) {
        return value;
    }
    @Override
    public void setNeedHandlerFields(String[] needHandlerFields) {
        this.needHandlerFields = needHandlerFields;
    }
}
  • setNeedHandlerFields 方法用来指定哪些字段需要处理，参数是一个字符串数组，每个元素对应的是 Excel 实体里@Excel 注解的 name 属性，即 Excel 的表头名称
  • importHandler 接口可以重写为我们需要的转换逻辑，默认是返回原始 value，即不转换字段
  • exportHandler 接口可以重写为我们需要的转换逻辑，默认是返回原始 value，即不转换字段
现在，继承 ExcelDataHandlerDefaultImpl 类就可以实现数据处理了
@Component
public class PersonExcelDataHandler extends ExcelDataHandlerDefaultImpl {
    @PostConstruct
    public void init() {
        setNeedHandlerFields(new String[]{"小区", "楼栋"});
    }
    
    @Override
    public Object importHandler(ImportPersonExcelModal obj, String name, Object value) {
        if(Objects.isNull(value)){
            return value;
        }
        if(name.equals("楼栋")){
            //根据 obj.getCommunityId() 和 obj.getBuildingName()，查询楼栋 id
			return 楼栋 id;
        }
        return value;
    }

    @Override
    public Object exportHandler(ImportPersonExcelModal obj, String name, Object value) {
        if(Objects.isNull(value)){
            return value;
        }
        if(name.equals("楼栋")){
            //根据 obj.getCommunityId() 和 obj.getBuildingId()，查询楼栋名称
			return 楼栋名称;
        }
        return value;
    }
}
EasyPoiX 的数据处理
EasyPoiX 封装了一个 SimpleExcelDataHandler 虚类，继承这个虚类就可以免去手动调用 setNeedHandlerFields 方法的麻烦。
另外，SimpleExcelDataHandler 默认提供了 importHandler 和 exportHandler 两个接口的实现，同字典转换一样，只需要提供一个 getData 接口的实现，提供待处理数据的取值逻辑即可。
@Component
@ExcelHandleDataType(clazz = ImportPersonExcelModal.class, value = {BUILDING_NAME, UNIT_NAME})
public class PersonExcelDataHandler extends SimpleExcelDataHandler {
    public static final String BUILDING_NAME = "楼栋";
    public static final String UNIT_NAME = "单元";
    
    @Override
    public Map getData(DataParam params) {
        switch (params.getDict()) {
            case BUILDING_NAME:
                return getBuildingData(params);
            case UNIT_NAME:
                return getUnitData(params);
            default:
                return null;
        }
    }

    private Map getBuildingData(DataParam params) {
        Object row = params.getRow();
        String communityId = BeanUtil.getProperty(row, "communityId");
        //返回楼栋键值对，key 是楼栋 id，value 是楼栋名称
    }

    private Map getUnitData(DataParam params) {
        Object row = params.getRow();
        String buildingId = BeanUtil.getProperty(row, "buildingId");
        //返回单元键值对，key 是单元 id，value 是单元名称
    }

}
DataParam.java
@Data
@Accessors(chain = true)
public class DataParam {
    private String dict;
    private String key;
    private Object row;
}
如果实际业务不需要默认的数据处理实现，也可以在继承 SimpleExcelDataHandler 虚类之后，重写 importHandler 和 exportHandler 接口，就像 EasyPoi 的数据处理方式一样，这样更加灵活。
总结
EasyPoiX 是为了能够快速导入导出 Excel，而对 EasyPoi 进行的一个无侵入的二次封装，同时利用了 spring-boot-starter 的原理，使其在 spring-boot 项目中可以以 jar 模块的形式复用 EasyPoiX 的功能。如果有小伙伴在实际的使用中遇到了其他场景，也可以联系我。
我叫 IT果果，下面有我的联系方式，谢谢！
请联系我
IT 果果
一个普通的技术宅，欢迎点赞、关注和转发，请多关照。

以上场景都有对应的测试代码示例，如果想更进一步了解请访问地址：
https://gitee.com/chenzhaoplus/easypoix-spring-boot-starter
https://github.com/chenzhaoplus/easypoix-spring-boot-starter
https://blog.csdn.net/cz285933169?spm=1010.2135.3001.5421






展开阅读全文



页面更新：2024-03-05



标签：方法   数据处理   注解   字段   字典   场景   接口   名称   快速   功能   数据





1
2
3
4
5







	

		

		
		

		

			

			
中国高科技产品出口额全球第一

			

			

			@中国产业名片近期德国《焦点周刊》报道，我国2022年高新科技产品出口额排名全球第一，这些高新科技产品主要是手机、通信设备、电视、PC等产品。比美国、日本和德国的总和相近。中国制造了全球70%的手机，强大的产业链优势
			

		

	

	

		

		
		

		

			

			
稍不注意就进不了仓，卸不了货？非亚马逊地址仓库派送攻略来袭！

			

			

			跨境卖家发物流头程不仅需要配送到对应的亚马逊仓库，同时根据业务的需要也会配送到一部分的非亚马逊地址仓库。 近期小编听说了这么一件事情：有位卖家根据业务需要发了一批产品到美国的一个私人地址，本以为接收地址是仓
			

		

	

	

		

		
		

		

			

			
国难将至看你决定

			

			

			可知华为与苹果两者之间操作分别不大，但美国为何千方百计都要打压华为，因为华为很多方面都比苹果优秀，不久将来甚至可把苹果拿下，美国政府眼见中国科技发展上升太快，所以决心要把我们拉下，只要留意国情便知道我们现在處境已
			

		

	

	

		

		
		

		

			

			
美日荷这芯片三大玩家联手封杀，中国的科技树要被连根拔起？

			

			

			美日荷已经成功联手，对向中国芯片技术出口进行全方位封杀。三位掌握核心技术的大玩家勾搭在一起，这暧昧地一笑，确实够狠够阴了，荷兰阿斯麦尔、日本尼康等等统统要挥挥衣袖离开中国市场了，半片云彩也带不走。我是树干，天天国
			

		

	

	

		

		
		

		

			

			
国产超高性价比推荐手机，趁春节入手

			

			

			 因为性能过剩的时代来临，千元机在当下不再是低端的代名词，因为很多手机上市几个月后加个开始出现松动，也出现了能捡漏的机会，今天就为大家盘点几款高性价比手机，最高只需1969元。iQOO Neo6 SEiQOO Neo6 SE采用的是一块高
			

		

	

	

		

		
		

		

			

			
化石花粉"防晒"能力证据的出现让大灭绝事件追溯至臭氧消耗

			

			

			由中国科学院南京地质古生物研究所（NIGPAS）的刘峰教授领导的来自中国、德国和英国的科学家们发现，保存在2.5亿年前岩石中的花粉含有丰富的化合物，其功能类似于防晒霜，但由植物产生，以保护自己免受有害紫外线（UV-B）辐射。这些
			

		

	

	

		

		
		

		

			

			
中国再一次突破了1块晶片的缺口，美国晶片将会再次被压低价格

			

			

			随着5G的来临，中国的芯片行业也迎来了春天，因为在5G时代，美国已经领先全球多年，所以国内芯片制造商的技术并不是很成熟。如果美国芯片想要进入到中国市场的话，就必须对国内的制造企业进行降价销售。这对国内企业来说是一件
			

		

	

	

		

		
		

		

			

			
多数欧洲人支持改变新基因组技术政策

			

			

			图片来源于网络据ISAAA网站报道，欧盟委员会公布了一项关于“使用新基因组技术（NGTs）培育植物的立法”的公众咨询结果。结果显示，在2200名参与者中，约80%的人认为转基因生物立法的现有规定不适用于通过靶向诱变或同源转基因
			

		

	

	

		

		
		

		

			

			
中国科学家首次观测到地球等离子体层中存在月球潮汐信号

			

			

			据中国科学院地质与地球物理研究所消息，近日，山东大学肖超博士后（共同一作）、中国科学院地质与地球物理研究所地球与行星物理院重点实验室何飞研究员（共同一作）和魏勇研究员与山东大学、北京航空航天大学等国内外多个单位科
			

		

	

	

		

		
		

		

			

			
冲击高端的路上，骁龙888的负面影响很大，小米11系列真的可惜了

			

			

			华为被制裁后，其手机业务遭受重创，空出了大量市场，其中最吸引人的无疑是华为的高端市场，国内的安卓厂家也是摩拳擦掌准备大干一场，结果理想很丰满，现实很骨感，华为空出来的高端市场主要还是被苹果抢走了。这个过程中，骁龙888
			

		

	

	

		

		
		

		

			

			
ChatGPT日活破千万，为何火爆全球？我们亲身体验ChatGPT能做什么：解答深奥的物理概念，写财经新闻……

			

			

			每经记者：文巧 每经编辑：兰素英在去年11月底横空出世之后，火爆全球的聊天机器人ChatGPT掀起了新的风浪。据《纽约时报》1月中旬报道，北密歇根大学的哲学教授Antony Aumann在为自己任教的一门世界宗教课程评分时，惊喜地读到
			

		

	

	

		

		
		

		

			

			
《点对万物》- 应对乌卡时代的“以太坊”经验

			

			

			乌卡时代的复杂性、模糊性、不稳定性、不确定性已经成为当下每个人都必须面对的重要难题。这个时代的一切都处于未知之中，不能利用现有的理论进行推演，也不能采取目前的思维进行分析，更没有现成的经验可以借鉴。应对乌卡
			

		

	

	

		

		
		

		

			

			
中国茶事！智慧赋能婺源绿

			

			

			　　中国小康网 独家专稿　　文|《小康》·中国小康网记者 刘彦华　　5G、区块链、物联网……这些新鲜事物，正在逐步进入婺源，改变着传统茶业，改变着婺源茶农。　　抢占制高点 近年来，婺源抓住江西省“四绿一红”茶叶品牌
			

		

	

	

		

		
		

		

			

			
新能源车置换补贴是否延续

			

			

			2023年是政策大年，预计全国两会3月份前后将会密集出台。上海市刚刚出台《上海市提信心扩需求稳增长促发展行动方案》，提出延续新能源车置换补贴，给予每辆车1万元的财政补贴。任泽平老师提出“全力拼经济”，上海、广东率先
			

		

	

	

		

		
		

		

			

			
我用普朗克常数来解释太阳光为什么是黄色的

			

			

			让我们从问一个简单的问题开始：为什么太阳会发光？图片来自维基共享资源前几天，我7岁的侄子问我为什么太阳是黄色的。我笑着告诉他这是一个很好的问题。科学的迷人之处在于，简单的问题往往是通往自然界一些最深刻和最基本
			

		

	


上滑加载更多 ↓






	

	
推荐阅读：


	

		

			

			
两条宽带如何合并在一起，路由器合用两条宽带方法ip-com

			

		

	


	

		

			

			
有什么好的方法可以有助睡眠呢？

			

		

	


	

		

			

			
大数据算法的应用

			

		

	


	

		

			

			
奥迪发布全场景跨界车 自带AR设备可自动驾驶

			

		

	


	

		

			

			
SpringBoot进阶-SpringBoot如何对接口返回数据进行脱

			

		

	


	

		

			

			
“内容+场景”，凤凰不夜城走出一条特色文旅新路径

			

		

	


	

		

			

			
保护前列腺的几个方法，男人们一定要知道！尤其是年过50的

			

		

	


	

		

			

			
强电智能开关是怎样实现智能客控系统的功能的

			

		

	


	

		

			

			
春节你出游了吗？文旅数据发布，消费复苏强劲！

			

		

	


	

		

			

			
阳康后持续低热的解决方法

			

		

	


	

	
	

	
友情链接：

	

		
	

	


	

	
更多：

	

		
本站资料均由网友自行发布提供，仅用于学习交流。如有版权问题，请与我联系，QQ：4156828  

		
© CopyRight 2008-2024 All Rights Reserved. Powered By bs178.com  闽ICP备11008920号-3
闽公网安备35020302034844号

	

	

	




Top