通过注解方式实现excel导入校验的方法与流程

通过注解方式实现excel导入校验的方法
【技术领域】
1.本发明涉及excel导入数据的校验技术领域，特别涉及通过注解方式实现excel导入校验的方法。


背景技术：

2.在项目开发中，我们会有excel的导入，在导入excel时我们需要去校验导入的数据正确性，比如格式、是否为空等。现有的检验方案是在导入时，读取每一个单元格然后进行一一校验，不具备通用性，需要针对每一个excel去做处理，不具备拓展性。


技术实现要素：

3.为了克服上述问题，本发明提出一种可有效解决上述问题的通过注解方式实现excel导入校验的方法。
4.本发明解决上述技术问题提供的一种技术方案是：提供一种通过注解方式实现excel导入校验的方法，包括如下步骤：
5.步骤s1，对excel创建一个表头对象，表头对象的字段为导入列表的表头；
6.步骤s2，创建自定义注解，对需要校验的列的表头字段设置注解；
7.步骤s3，创建一个通用的导入工具类，导入时，识别表头和行数据；
8.步骤s4，获取每个单元格对应的表头字段，再获取这个表头字段定义的注解；
9.步骤s5，通过注解配置的校验方式，去校验单元格。
10.优选地，所述步骤s1中，表头对象包括字段、excelproperty注解和excelemptycheck自定义校验注解。
11.优选地，所述步骤s2中，自定义注解中可以设置行、列以及报错信息。
12.优选地，所述步骤s3中，导入工具类基于poi。
13.优选地，所述步骤s5中，注解配置的校验方式有非空校验和格式校验。
14.优选地，所述步骤s5中，校验单元格包括如下步骤：
15.步骤s51，poi读取表格行数据；
16.步骤s52，将行数据设置到行数据中，并通过excelproperty注解将行数据的单元格数据设置到对应的字段中；
17.步骤s53，单元格在设置数据到字段时，通过代理机制拦截，读取字段的自定义校验注解，根据注解的处理器去对字段进行校验；
18.步骤s54，如果校验不通过，则抛出异常。
19.与现有技术相比，本发明的通过注解方式实现excel导入校验的方法简单方便，只需要创建导入的表头对象，设置注解；通用性强，适用大部分导入excel场景；拓展性高，excel增加一列时，只需要在表头对象中增加一个字段。
【附图说明】
20.图1为本发明通过注解方式实现excel导入校验的方法的步骤流程图；
21.图2为本发明通过注解方式实现excel导入校验的校验单元格步骤流程图。
【具体实施方式】
22.为了使本发明的目的、技术方案及优点更加清楚明白，以下结合附图及实施实例，对本发明进行进一步详细说明。应当理解，此处所描述的具体实施例仅用于解释本发明，并不用于限定本发明。
23.需要说明，本发明实施例中所有方向性指示(诸如上、下、左、右、前、后
……
)仅限于指定视图上的相对位置，而非绝对位置。
24.另外，在本发明中如涉及“第一”、“第二”等的描述仅用于描述目的，而不能理解为指示或暗示其相对重要性或者隐含指明所指示的技术特征的数量。由此，限定有“第一”、“第二”的特征可以明示或者隐含地包括至少一个该特征。在本发明的描述中，“多个”的含义是至少两个，例如两个，三个等，除非另有明确具体的限定。
25.请参阅图1和图2，本发明的通过注解方式实现excel导入校验的方法，包括如下步骤：
26.步骤s1，对excel创建一个表头对象，表头对象的字段为导入列表的表头。
27.所述步骤s1中，表头对象包括字段、excelproperty注解和excelemptycheck自定义校验注解，字段用于存放对应行中相应列的数据，所述excelproperty注解用于映射excel表中的表头名称。所述excelemptycheck自定义校验注解例如可创建一个空校验，表示该字段不允许为空，如果为空会在导入时自动校验。
28.步骤s2，创建自定义注解，对需要校验的列的表头字段设置注解。
29.所述步骤s2中，自定义注解中可以设置行、列以及报错信息。
30.步骤s3，创建一个通用的导入工具类，导入时，识别表头和行数据。
31.所述步骤s3中，导入工具类是基于poi，目前采用比较方便的easyexcel工具。
32.步骤s4，获取每个单元格对应的表头字段，再获取这个表头字段定义的注解。
33.步骤s5，通过注解配置的校验方式，去校验单元格。
34.所述步骤s5中，注解配置的校验方式有非空校验，格式校验等。
35.所述步骤s5中，校验单元格包括如下步骤：
36.步骤s51，poi读取表格行数据；
37.步骤s52，将行数据设置到行数据(表头类所定义的对象)中，并通过excelproperty注解将行数据的单元格数据设置到对应的字段中；
38.步骤s53，单元格在设置数据到字段时，通过代理机制拦截，读取字段的自定义校验注解，根据注解的处理器去对字段进行校验；
39.步骤s54，如果校验不通过，则抛出异常。
40.与现有技术相比，本发明的通过注解方式实现excel导入校验的方法简单方便，只需要创建导入的表头对象，设置注解；通用性强，适用大部分导入excel场景；拓展性高，excel增加一列时，只需要在表头对象中增加一个字段。
41.以上所述仅为本发明的较佳实施例，并非因此限制本发明的专利范围，凡是在本
发明的构思之内所作的任何修改，等同替换和改进等均应包含在本发明的专利保护范围内。


技术特征：
1.通过注解方式实现excel导入校验的方法，其特征在于，包括如下步骤：步骤s1，对excel创建一个表头对象，表头对象的字段为导入列表的表头；步骤s2，创建自定义注解，对需要校验的列的表头字段设置注解；步骤s3，创建一个通用的导入工具类，导入时，识别表头和行数据；步骤s4，获取每个单元格对应的表头字段，再获取这个表头字段定义的注解；步骤s5，通过注解配置的校验方式，去校验单元格。2.如权利要求1所述的通过注解方式实现excel导入校验的方法，其特征在于，所述步骤s1中，表头对象包括字段、excelproperty注解和excelemptycheck自定义校验注解。3.如权利要求1所述的通过注解方式实现excel导入校验的方法，其特征在于，所述步骤s2中，自定义注解中可以设置行、列以及报错信息。4.如权利要求1所述的通过注解方式实现excel导入校验的方法，其特征在于，所述步骤s3中，导入工具类基于poi。5.如权利要求1所述的通过注解方式实现excel导入校验的方法，其特征在于，所述步骤s5中，注解配置的校验方式有非空校验和格式校验。6.如权利要求2所述的通过注解方式实现excel导入校验的方法，其特征在于，所述步骤s5中，校验单元格包括如下步骤：步骤s51，poi读取表格行数据；步骤s52，将行数据设置到行数据中，并通过excelproperty注解将行数据的单元格数据设置到对应的字段中；步骤s53，单元格在设置数据到字段时，通过代理机制拦截，读取字段的自定义校验注解，根据注解的处理器去对字段进行校验；步骤s54，如果校验不通过，则抛出异常。

技术总结
本发明涉及excel导入数据的校验技术领域，特别涉及通过注解方式实现excel导入校验的方法，对excel创建一个表头对象，表头对象的字段为导入列表的表头，创建自定义注解，对需要校验的列的表头字段设置注解，创建一个通用的导入工具类，导入时，识别表头和行数据，获取每个单元格对应的表头字段，再获取这个表头字段定义的注解，通过注解配置的校验方式，去校验单元格。与现有技术相比，本发明的通过注解方式实现excel导入校验的方法简单方便，只需要创建导入的表头对象，设置注解，通用性强，适用大部分导入excel场景，拓展性高，excel增加一列时，只需要在表头对象中增加一个字段。只需要在表头对象中增加一个字段。只需要在表头对象中增加一个字段。


技术研发人员：冯锴 李如先 蔡剑葛 郝德生 贾雪艳 刘宇明 郑谷城 娄凯琦 林立鹏 胡长桥 王植培
受保护的技术使用者：深圳前海环融联易信息科技服务有限公司
技术研发日：2021.11.30
技术公布日：2022/3/1