1 Star 0 Fork 2.7K

开发团队 / easypoi

forked from 悟耘开源 / easypoi 
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

EasyPoi - Easy utility classes of Excel and Word

Easypoi, as is clear from the name, it's easy for a developer who never even used poi to export/import Excel, export Excel Template and Word Template, and export PDF. We encapsulate Apache poi in the upper layers. With simple annotations and templates Language (familiar expression syntax) to accomplish previously complex coding.

Website:http://www.wupaas.com/
Email: qrb.jueyue@foxmail.com
Developer:Jueyue qrb.jueyue@foxmail.com
Excellent Team, undertake project development

Support Spring Boot https://gitee.com/lemur/easypoi-spring-boot-starter

Official website

中文介绍

The Dev Guide

http://doc.wupaas.com/docs/easypoi/easypoi-1c0u4mo8p4ro8

Next steps

  • Internationalization, translate documents and code-commenting
  • Change all PDF export to Template export
  • Synchronise Word tmplate function with the Excel

User feedback

cn.afterturn:easypoi for enterprise

Available as part of the Tidelift Subscription

The maintainers of cn.afterturn:easypoi and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

Display in order of registration. If you are using Easypoi, please register on https://gitee.com/lemur/easypoi/issues/IFDX7 which is only as a reference for the open source, no other purposes.

Version introduction

history.md

Basic demo

basedemo.md

Demo project: http://git.oschina.net/lemur/easypoi-test


Advantages of EasyPoi

1.Exquisite Design, easy to use
2.Various Interfaces, easy to extend
3.Coding less do more
4.Support Spring MVC, easy for WEB export

Main Features

For Excel, self-adapt xls and xlsx format. For Word, only docx.

1.Excel Import

  • Annotation Import
  • Map Import
  • Big data Import, sax mode
  • Save file
  • File validation
  • Field validation

2.Excel Export

  • Annotation Export
  • Template Export
  • HTML Export

3.Excel convert to HTML

4.Word Export

5.PDF Export


which methods for which scenarios

- Export
    1. Normal excel export (simple format, moderate amount of data, within 50,000)
        annotation way:  ExcelExportUtil.exportExcel(ExportParams entity, Class<?> pojoClass,Collection<?> dataSet) 
    2. uncertain columns, but also with simple format and small amount of data
        customize way: ExcelExportUtil.exportExcel(ExportParams entity, List<ExcelExportEntity> entityList,Collection<?> dataSet)
    3. big data(greater than 50,000, less than one million) 
        annotation way ExcelExportUtil.exportBigExcel(ExportParams entity, Class<?> pojoClass,IExcelExportServer server, Object queryParams)
        customize way: ExcelExportUtil.exportBigExcel(ExportParams entity, List<ExcelExportEntity> excelParams,IExcelExportServer server, Object queryParams)
    4. complex style, the amount of data not too large
        Template: ExcelExportUtil.exportExcel(TemplateExportParams params, Map<String, Object> map)
    5. Export multiple sheets with different styles at one time
        Template ExcelExportUtil.exportExcel(Map<Integer, Map<String, Object>> map,TemplateExportParams params) 
    6. One template but many copies to export
        Template ExcelExportUtil.exportExcelClone(Map<Integer, List<Map<String, Object>>> map,TemplateExportParams params)
    7. If Template can't satisfy your customization, try HTML
        Build your own html, and then convert it to excel:  ExcelXorHtmlUtil.htmlToExcel(String html, ExcelType type)
    8. Big data(Over millions), please use CSV
        annotation way: CsvExportUtil.exportCsv(CsvExportParams params, Class<?> pojoClass, OutputStream outputStream)
        customize way: CsvExportUtil.exportCsv(CsvExportParams params, List<ExcelExportEntity> entityList, OutputStream outputStream)
    9. Word Export
        Template: WordExportUtil.exportWord07(String url, Map<String, Object> map)
    10. PDF Export
        Template: TODO 
- Import
    If you want to improve the performance, the concurrentTask of ImportParams will help with concurrent imports;Only support single line, minimum 1000. 
	For some special reading for single cell, you can use the  readSingleCell parameter
    1. no need verification, moderate amount of data, within 50,000
        annotation or map: ExcelImportUtil.importExcel(File file, Class<?> pojoClass, ImportParams params)
    2. the amount of data not too large
        annotation or map: ExcelImportUtil.importExcelMore(InputStream inputstream, Class<?> pojoClass, ImportParams params)
    3. For big data or with lots of importing operations; Less memory, only support single line
       SAX: ExcelImportUtil.importExcelBySax(InputStream inputstream, Class<?> pojoClass, ImportParams params, IReadHandler handler)
    4. Big data(Over millions), please use CSV
        small data: CsvImportUtil.importCsv(InputStream inputstream, Class<?> pojoClass,CsvImportParams params)
        big data: CsvImportUtil.importCsv(InputStream inputstream, Class<?> pojoClass,CsvImportParams params, IReadHandler readHandler)

The difference between XLS and XLSX for Excel Export

1. For export time, XLS is 2-3 times faster than xlsx.
2. For export size, XLS is 2-3 or more times than xlsx.
3. Export need to consider both network speed and local speed.

Packages Guide

1.easypoi -- Parent package
2.easypoi-annotation -- Basic annotation package, action on entity objects, 
                        it's convenient for Maven multi-project management after splitting
3.easypoi-base -- Import and export package, realize Excel Import/Export, Word Export
4.easypoi-web  -- Based on AbstractView, Coupled with spring MVC, greatly simplifies the export function 
5.sax -- Optional, Export uses xercesImpl, Word Export uses poi-scratchpad

If you don't use spring MVC, only easypoi-base is enough.

maven

https://oss.sonatype.org/content/groups/public/

		 <dependency>
              <groupId>cn.afterturn</groupId>
              <artifactId>easypoi-spring-boot-starter</artifactId>
              <version>4.2.0</version>
         </dependency>
		 <dependency>
			<groupId>cn.afterturn</groupId>
			<artifactId>easypoi-base</artifactId>
			<version>4.2.0</version>
		</dependency>
		<dependency>
			<groupId>cn.afterturn</groupId>
			<artifactId>easypoi-web</artifactId>
			<version>4.2.0</version>
		</dependency>
		<dependency>
			<groupId>cn.afterturn</groupId>
			<artifactId>easypoi-annotation</artifactId>
			<version>4.2.0</version>
		</dependency>
		

pom

			<!-- sax: optional, using for import -->
			<dependency>
				<groupId>xerces</groupId>
				<artifactId>xercesImpl</artifactId>
				<version>${xerces.version}</version>
				<optional>true</optional>
			</dependency>
			<dependency>
				<groupId>org.apache.poi</groupId>
				<artifactId>poi-scratchpad</artifactId>
				<version>${poi.version}</version>
				<optional>true</optional>
			</dependency>
			
			<!-- Word: optional, using for export  -->
            <dependency>
                <groupId>org.apache.poi</groupId>
                <artifactId>ooxml-schemas</artifactId>
                <version>1.3</version>
                <optional>true</optional>
            </dependency>
			
			<!-- Verification: optional -->
			<dependency>
				<groupId>org.hibernate</groupId>
				<artifactId>hibernate-validator</artifactId>
				<version>5.1.3.Final</version>
				<optional>true</optional>
			</dependency>
			
			<dependency>
				<groupId>org.apache.bval</groupId>
				<artifactId>org.apache.bval.bundle</artifactId>
				<version>1.1.0</version>
			</dependency>
			
			<!-- PDF: optional, using for export-->
			<dependency>
				<groupId>com.itextpdf</groupId>
				<artifactId>itextpdf</artifactId>
				<version>5.5.6</version>
				<optional>true</optional>
			</dependency>

			<dependency>
				<groupId>com.itextpdf</groupId>
				<artifactId>itext-asian</artifactId>
				<version>5.2.0</version>
				<optional>true</optional>
			</dependency>

Current test coverage

Package Class Method Line
cn 100% (0/0) 100% (0/0) 100% (0/0)
cn.afterturn 100% (0/0) 100% (0/0) 100% (0/0)
cn.afterturn.easypoi 0% (0/1) 0% (0/1) 0% (0/3)
cn.afterturn.easypoi.cache 100% (6/6) 83% (10/12) 60% (40/66)
cn.afterturn.easypoi.cache.manager 100% (3/3) 62% (5/8) 54% (29/53)
cn.afterturn.easypoi.configuration 0% (0/2) 0% (0/1) 0% (0/5)
cn.afterturn.easypoi.entity 100% (1/1) 83% (15/18) 66% (26/39)
cn.afterturn.easypoi.entity.vo 100% (0/0) 100% (0/0) 100% (0/0)
cn.afterturn.easypoi.excel 100% (3/3) 73% (19/26) 59% (44/74)
cn.afterturn.easypoi.excel.annotation 100% (0/0) 100% (0/0) 100% (0/0)
cn.afterturn.easypoi.excel.entity 83% (5/6) 66% (85/127) 63% (185/290)
cn.afterturn.easypoi.excel.entity.enmus 100% (3/3) 88% (8/9) 92% (13/14)
cn.afterturn.easypoi.excel.entity.params 100% (6/6) 84% (94/111) 75% (160/211)
cn.afterturn.easypoi.excel.entity.result 100% (2/2) 76% (16/21) 65% (26/40)
cn.afterturn.easypoi.excel.entity.sax 100% (1/1) 33% (2/6) 45% (5/11)
cn.afterturn.easypoi.excel.entity.vo 100% (1/1) 100% (1/1) 100% (3/3)
cn.afterturn.easypoi.excel.export 100% (2/2) 94% (17/18) 84% (202/238)
cn.afterturn.easypoi.excel.export.base 100% (2/2) 97% (33/34) 88% (353/399)
cn.afterturn.easypoi.excel.export.styler 100% (4/4) 86% (19/22) 97% (122/125)
cn.afterturn.easypoi.excel.export.template 100% (3/3) 95% (43/45) 92% (422/457)
cn.afterturn.easypoi.excel.graph 100% (0/0) 100% (0/0) 100% (0/0)
cn.afterturn.easypoi.excel.graph.builder 0% (0/1) 0% (0/8) 0% (0/92)
cn.afterturn.easypoi.excel.graph.constant 100% (0/0) 100% (0/0) 100% (0/0)
cn.afterturn.easypoi.excel.graph.entity 0% (0/3) 0% (0/26) 0% (0/49)
cn.afterturn.easypoi.excel.html 100% (2/2) 92% (24/26) 84% (242/287)
cn.afterturn.easypoi.excel.html.css 100% (2/2) 100% (10/10) 94% (166/175)
cn.afterturn.easypoi.excel.html.css.impl 100% (6/6) 60% (9/15) 74% (111/149)
cn.afterturn.easypoi.excel.html.entity 100% (0/0) 100% (0/0) 100% (0/0)
cn.afterturn.easypoi.excel.html.entity.style 100% (3/3) 100% (53/53) 100% (87/87)
cn.afterturn.easypoi.excel.html.helper 80% (4/5) 77% (24/31) 67% (154/228)
cn.afterturn.easypoi.excel.imports 100% (2/2) 92% (26/28) 79% (361/454)
cn.afterturn.easypoi.excel.imports.base 100% (1/1) 100% (9/9) 89% (102/114)
cn.afterturn.easypoi.excel.imports.sax 100% (2/2) 100% (8/8) 70% (56/80)
cn.afterturn.easypoi.excel.imports.sax.parse 100% (1/1) 77% (7/9) 58% (44/75)
cn.afterturn.easypoi.exception 100% (0/0) 100% (0/0) 100% (0/0)
cn.afterturn.easypoi.exception.excel 50% (1/2) 20% (3/15) 18% (6/32)
cn.afterturn.easypoi.exception.excel.enums 50% (1/2) 44% (4/9) 40% (9/22)
cn.afterturn.easypoi.exception.word 0% (0/1) 0% (0/3) 0% (0/6)
cn.afterturn.easypoi.exception.word.enmus 0% (0/1) 0% (0/4) 0% (0/10)
cn.afterturn.easypoi.handler 100% (0/0) 100% (0/0) 100% (0/0)
cn.afterturn.easypoi.handler.impl 100% (1/1) 33% (2/6) 44% (4/9)
cn.afterturn.easypoi.handler.inter 100% (0/0) 100% (0/0) 100% (0/0)
cn.afterturn.easypoi.hanlder 0% (0/1) 0% (0/1) 0% (0/17)
cn.afterturn.easypoi.pdf 100% (1/1) 50% (1/2) 33% (1/3)
cn.afterturn.easypoi.pdf.entity 100% (1/1) 52% (10/19) 47% (17/36)
cn.afterturn.easypoi.pdf.export 100% (1/1) 100% (14/14) 85% (131/153)
cn.afterturn.easypoi.pdf.styler 100% (1/1) 100% (4/4) 56% (9/16)
cn.afterturn.easypoi.test 100% (0/0) 100% (0/0) 100% (0/0)
cn.afterturn.easypoi.test.en 100% (3/3) 93% (15/16) 93% (31/33)
cn.afterturn.easypoi.test.entity 91% (11/12) 50% (62/122) 57% (117/202)
cn.afterturn.easypoi.test.entity.check 100% (2/2) 50% (8/16) 69% (18/26)
cn.afterturn.easypoi.test.entity.groupname 75% (3/4) 46% (25/54) 52% (48/92)
cn.afterturn.easypoi.test.entity.img 100% (1/1) 100% (8/8) 100% (16/16)
cn.afterturn.easypoi.test.entity.samename 100% (1/1) 100% (6/6) 100% (10/10)
cn.afterturn.easypoi.test.entity.statistics 100% (1/1) 100% (12/12) 100% (19/19)
cn.afterturn.easypoi.test.entity.temp 80% (4/5) 94% (32/34) 38% (52/134)
cn.afterturn.easypoi.test.web 100% (0/0) 100% (0/0) 100% (0/0)
cn.afterturn.easypoi.test.web.cfg 0% (0/1) 0% (0/1) 0% (0/4)
cn.afterturn.easypoi.tohtml 0% (0/1) 0% (0/4) 0% (0/13)
cn.afterturn.easypoi.util 100% (11/11) 85% (84/98) 73% (668/908)
cn.afterturn.easypoi.view 0% (0/13) 0% (0/27) 0% (0/376)
cn.afterturn.easypoi.word 100% (1/1) 33% (1/3) 20% (1/5)
cn.afterturn.easypoi.word.entity 100% (2/2) 44% (4/9) 45% (27/60)
cn.afterturn.easypoi.word.entity.params 50% (1/2) 22% (5/22) 14% (8/56)
cn.afterturn.easypoi.word.parse 100% (1/1) 91% (11/12) 94% (97/103)
cn.afterturn.easypoi.word.parse.excel 100% (2/2) 90% (10/11) 70% (95/135)
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: You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and 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 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 2014 jueyue 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

POI 工具类,Excel的快速导入导出,Excel模板导出,Word模板导出,可以仅仅5行代码就可以完成Excel的导入导出,修改导出格式简单粗暴,快速有效,easypoi值得你尝试 expand collapse
Java
Apache-2.0
Cancel

Releases

No release

Contributors

All

Activities

Load More
can not load any more
Java
1
https://gitee.com/OAGroup/easypoi.git
git@gitee.com:OAGroup/easypoi.git
OAGroup
easypoi
easypoi
master

Search