39 Star 101 Fork 19

mofum / mofum-msdom

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
Apache-2.0

mofum-msdom

项目介绍

Microsoft 文档操作工具类...

本工具类基于Apache POI 4.0 SAX 用户模式实现。 

操作简单但是不失灵活性。基于Sax模式实现,消耗内存相对较少,有效避免OOM(OutOfMemoryError)内存溢错误。

读取原理:读数据是基于事件模式,读一条数据,释放一条数据,整个解析过程只占用一条数据解析的内存。

写入原理:写数据则是将部分数据放入内存中,msdom-excel称这样的操作叫做缓存,超过缓存的写入数据部分则根据时间先后存于硬盘上。


Excel部分:

    愿景:简单、高效、自由、轻松是我们要达成的项目目标。

    简单:使用简单,无需深度学习,开箱即用。
    
    高效:无需担心性能、担心数据量过大等技术问题,而专心于业务需求开发。
    
    自由:灵活的配置,你可以修改每一处你能想象到的地方。我们不会限制死,但是我们会提供一套默认的方案给你。当方案不满足你的需求。你完 
          全可以自己重新定义一套方案。
    
    轻松:我们希望你在使用mofum-msdom时是感到快乐和轻松的。

MAVEN安装方式

<dependency>
    <groupId>com.mofum.msdom</groupId>
    <artifactId>mofum-msdom</artifactId>
    <version>1.0.2.3</version>
</dependency>

1.0.2.3版本功能概要

  • 目前仅支持XLSX(Excel 2007)版本的Excel导入导出。暂不支持CVS,XLS相关的格式。

  • 支持必要参数非空校验 required

  • 支持过滤器读取(DataFilter)

  • 支持自定义验证器(Validator)

  • 支持文件(File)读取模式。

  • 支持分页写入模式 (PageAnnotationExcelWriterImpl)

  • 支持注解写入模式(AnnotationExcelWriterImpl)

  • 支持多类型混合追加写入模式(MultiAnnotationExcelWriterImpl)

  • 支持自定义Excel类型转换(ExcelConvert)

  • 支持追加写入,多Sheet 混合写入模式。

  • 支持合并单元格。

  • 支持较多的样式

  • 支持导出的数据的格式化

1.0.3.0新版本功能预览

  • 支持流读取模式(√)

  • 支持模板导出并且同时支持模板的反序列化成对象(-)

  • 支持模板注解相关配置(-)

  • 支持初始化默认的Excel配置DataFilter,Validator,ExcelConvert,TypeConvert(√)【默认配置为全局配置,仅提供初始化功能】(该功能,你将可以根据你的业务需求来统一配置JAVA类型转换器,Excel类型转换器,验证器,过滤器。当然你仍然可以使用默认的相关配置和字段上配置的转换器,它们并不相互冲突。)

(注:“√” 表示已完成,“-”表示正在开发中。)

测试

1、Excel 测试说明
测试示例 见com.mofum.msdom.excel.demo 目录
读取测试:(ReadDemo)
JDK 版本: 1.8

系统版本: Windows 7

测试JVM : -Xms1m -Xmx5m

测试数据 :100万条数据(20列)见附件(sxxf1.xlsx)

最低JVM内存需求:5M
写入测试:(WriteDemo)
JDK 版本: 1.8

系统版本: Windows 7

测试JVM : -Xms1m -Xmx5m

最低JVM内存需求:5M

软件架构

基于POI 4.0 开发的 excel 导入导出工具类

使用教程

1.读取操作:
 /**
  * 读取测试模型
  */
public class ReadDemo {

    public static void main(String[] args) throws IOException {

        //创建Reader ,对Test模型进行解析
        IExcelReader<TestModel, TestModelCallback> reader = new AnnotationExcelReaderImpl<TestModel, TestModelCallback>();

        //POI 读取Excel 文件
        reader.read(new File("001.xlsx"), TestModel.class, new TestModelCallback());

    }

}

详细操作见WIKI文档

2.写入操作

public class WriteDemo {

    public static void main(String[] args) throws IOException {

        //数据写入器
        IExcelWriter writer = new AnnotationExcelWriterImpl<TestModel>();

        //写入数据
        writer.dataType(TestModel.class).start(out).write(datas).end();

    }

}

详细操作见WIKI文档

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 2018 mofum 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.

About

Microsoft 文档操作工具类。对Excel的操作采用SAX事件模式,用极低的内存消耗来完成大量数据的快速导入导出,有效避免大量数据导入导出产生的内存溢出(OutOfMemory)问题;并且拥有相对完善的注解功能和相对灵活的导入导出配置,以适应一些较为复杂的业务需求。 expand collapse
Java
Apache-2.0
Cancel

Contributors

All

Activities

Load More
can not load any more
Java
1
https://gitee.com/mofum/mofum-msdom.git
git@gitee.com:mofum/mofum-msdom.git
mofum
mofum-msdom
mofum-msdom
master

Search