克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

介绍

这是一个依赖 apache poi实现的 excel 导入工具

优点

  1. 可以实现转换器接口ExcelDataConvertTo,读取单元格任何格式的数据
  2. 可以使用注解@ExcelRegex校验数据格式是否正确,可以严格校验,也可以宽松校验
  3. 可以读取为List数据,也可以读取Bean数据

使用

拉取项目
git clone https://gitee.com/uidoer/rish-excel.git 
使用maven 安装
 mvn install

或者: 使用idea安装 Maven ==> Lifecycle ==> install

在pom中引入工具
<dependency>
    <groupId>top.rish</groupId>
    <artifactId>get-excel-data</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>
创建bean / list的bean
/**
 * 回单明细 bean
 */
public class HdmxBean {
    /**
     * 开始日期
     */
    @ExcelCell(descript = "开始日期",required = true, row = 1, col = 1, convert = ConvertToDate.class,
     regex = {
      @ExcelRegex(value = "\\d{4}-\\d{1,2}-\\d{1,2} \\d{1,2}:\\d{1,2}:\\d{1,2}",strict = true,message = "开始日期格式错误!")
    })
    Date ksrq;
    /**
     * 结束日期
     */
    @ExcelCell(descript = "结束日期",required = true, row = 1, col = 3, convert = ConvertToDate.class)
    Date jsrq;
    /**
     * 银行类别编码
     */
    @ExcelCell(descript = "银行类别编码",required = true, row = 1, col = 5)
    String yhlbbm;

    // setter/getter ... toString
}
获取bean数据
 // HDMX EXCEL文件绝对路径
 RishExcel rishExcel = new RishExcel(HDMX);
 HdmxBean bean = rishExcel.read(HdmxBean.class,0,3);
获取List数据
// HDMX EXCEL文件绝对路径
RishExcel rishExcel = new RishExcel(HDMX);
List<HdmxList> list = rishExcel.read(HdmxList.class,"BODY",3);
说明

关于@ExcelCell


/**
 * rish.top
 * 从excel的单元格或列,获取数据
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ExcelCell {
    /**
     * 行
     * row,col为单元格坐标,
     * 如果row为-1,那按列获取[*,col]
     * 如果row>=0,那么按单元格坐标[row,col]获取
     * @return
     */
    int row() default -1;
    /**
     * 列 从0开始
     * @return
     */
    int col() default 0;

    /**
     * 转换器 默认转为String,对应字段类型需要为String
     * @return
     */
    Class<? extends ExcelDataConvertTo> convert() default ConvertToString.class;

    /**
     * 描述
     * @return
     */
    String descript() default "";

    /**
     * 是否必须
     * 如果是必须,那么没有值的时候,直接报错
     * 如果不是必须,没有值的时候就不报错
     * @return
     */
    boolean required() default  false;

    /**
     * 正则校验
     * @return
     */
    ExcelRegex[] regex() default {};
}

关于@ExcelRegex(对单元格的数据或列的数据,进行正则校验,支持严格校验和宽松校验)

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ExcelRegex  {
    /**
     * 正则表达式
     * @return
     */
    String value();

    /**
     * 校验模式 
     * true: 严格校验 , 如果不满足表达式就会直接报异常,中断
     * false: 宽松校验 ,只是会跳过本条记录的读取
     * @return
     */
    boolean strict() default true;

    /**
     * 不满足正则表达式时的报错信息
     * @return
     */
    String message() default "数据格式错误!";
}

关于转换器接口ExcelDataConvertTo只要实现一个转换器,并且放到@ExcelCell注解上,即可

/**
 * rish.top
 * @param <T> 转换成何种类型数据
 */
public interface ExcelDataConvertTo<T> {
    /**
     * 是否必填
     * @return
     */
     boolean required();

    /**
     * 转换
     * @param data
     * @return
     * @throws Exception
     */
    T convert(String data ) throws  Exception;
}  
已经实现的转换器
/**
 * 转为十进制小数
 */
public class ConvertToBigDecimal implements ExcelDataConvertTo<BigDecimal> {

    @Override
    public boolean required() {
        return false;
    }

    @Override
    public BigDecimal convert(String data ) throws Exception {

        return new BigDecimal(data);
    }
}

/**
 * 转为日期
 */
public class ConvertToDate implements ExcelDataConvertTo<Date> {


    /**
     * 日期正则和日期格式
     */
    private static final Map<String,String> REG_MAP = new ConcurrentHashMap<String,String>(){
        {
            put("\\d{1,2}\\/\\d{1,2}\\/\\d{2} \\d{1,2}:\\d{1,2}",                                 "MM/DD/yy HH:mm");
            put("\\d{1,2}-\\d{1,2}-\\d{2} \\d{1,2}:\\d{1,2}",                                     "MM-DD-yy HH:mm");
            put("\\d{4}-\\d{1,2}-\\d{1,2} \\d{1,2}:\\d{1,2}:\\d{1,2}",                            "yyyy-MM-dd HH:mm:ss");
            put("\\d{4}\\/\\d{1,2}\\/\\d{1,2} \\d{1,2}:\\d{1,2}:\\d{1,2}",                        "yyyy/MM/dd HH:mm:ss");
            put("\\d{4}-\\d{1,2}-\\d{1,2} \\d{1,2}:\\d{1,2}",                                     "yyyy-MM-dd HH:mm");
            put("\\d{4}\\/\\d{1,2}\\/\\d{1,2} \\d{1,2}:\\d{1,2}",                                 "yyyy/MM/dd HH:mm");
            put("\\d{4}\\/\\d{1,2}\\/\\d{1,2} \\d{1,2}:\\d{1,2} [^\\x00-\\xff|a-zA-Z]{2}",        "yyyy/MM/dd HH:mm aa");
            put("\\d{4}-\\d{1,2}-\\d{1,2} \\d{1,2}:\\d{1,2} [^\\x00-\\xff|a-zA-Z]{2}",            "yyyy-MM-dd HH:mm aa");
        }
    };

    @Override
    public boolean required() {
        return true;
    }

    @Override
    public Date convert(String data ) throws Exception {
        for(Map.Entry<String,String> entry:REG_MAP.entrySet()){
            String pattern = entry.getKey();
            String format = entry.getValue();
            if(Pattern.matches(pattern, data)){
               return new SimpleDateFormat(format, Locale.CHINA).parse(data);
            }
        }
        throw new Exception("暂无此日期格式 "+data);
    }
}

使用截图

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

介绍 这是一个依赖 apache poi实现的 excel 导入工具 优点 1.可以实现转换器接口ExcelDataConvertTo,读取单元格任何格式的数据 2.可以使用注解@ExcelRegex校验数据格式是否正确,可以严格校验,也可以宽松校验 3.可以读取为List数据,也可以读取Bean数据 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化