1 Star 0 Fork 216

yongxinlu / ExcelKit

forked from 吴汶泽 / ExcelKit 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

ExcelKit

简单、好用且轻量级的海量Excel文件导入导出解决方案。

更新日志:

  • 2017-9-14:下拉框,流上传,行尾空单元格,导出单元格格式(maxcess)

  • 2017-9-11:修复:补全行尾可能缺失的单元格,待修复: 补全行首可能缺失的单元格

  • 2017-7-8: 修复读取Excel文件后,临时文件一直占用的问题

  • 2017-6-25: 修复解决导入以及导出单元格空值的问题

  • 2017-4-11: 代码重构,不再兼容1.x。

    1. @ExportConfig重构,支持convert简单转换器.
    1. Excel读取性能优化,由usermodel包下的API重构为eventusermode包下的API,以SAX的方式,边读边处理,性能得到了极大的提升,可轻松实现百万级别的海量数据处理.
    1. 写Excel文件的API重构为streaming包下的API,同时支持多sheet导出.
    1. 取消了对Excel2003以及以下版本的excel文件支持.
    1. 包结构重构,便于以后的版本扩展和升级,不再兼容1.x版本.

编译环境:

使用jdk1.6.0_45maven-3.2.5进行项目构建,理论上支持jdk6+

使用效果:

ExcelKit-Example完整示例程序 (https://github.com/wuwz/ExcelKit-Example)

image

如何使用?

1.引入Maven依赖或下载jar包

使用本工具无需关注poi依赖问题(只需引入以下相关jar包)。

    <dependency>
        <groupId>org.wuwz</groupId>
        <artifactId>ExcelKit</artifactId>
        <version>2.0.4</version>
        //(近期由于中央Maven仓库上传数次皆不完整,请clone本项目后install到本地使用,后续版本解决后启用)
    </dependency>

注:非maven项目如何下载jar包?参考:http://blog.csdn.net/itmyhome1990/article/details/50233773

ExcelKit集成的jar:

	<poi-version>3.8</poi-version>
	<beanutils-version>1.9.3</beanutils-version>
	<dom4j-version>1.6.1</dom4j-version>
	<jaxen-version>1.1.6</jaxen-version>
	<xerces-version>2.11.0</xerces-version>
	<xml-apis-version>1.4.01</xml-apis-version>

2.导出项配置(通过注解):


	public class User {
	
	    @ExportConfig("UID")
	    private Integer uid;
	    
	    @ExportConfig("用户名")
	    private String username;
	    
	    @ExportConfig(value = "密码", replace = "******", color = HSSFColor.RED.index)
	    private String password;
	
	    @ExportConfig(value = "性别", width = 50, convert = "s:1=男,2=女")
	    private Integer sex;
	
	    @ExportConfig(value = "年级", convert = "c:org.wuwz.poi.test.GradeIdConvert")
	    private Integer gradeId;
	    
	    @ExportConfig(value = "下拉框", range="c:examples.RangeConvert")
		private String gendex;
	    
	    // getter setter...
	    
	 }

2.1.实现ExportConvert(如果配置了convert属性,参考gradeId字段):

convert属性说明:

将单元格值进行转换后再导出: 目前支持以下几种场景:

  1. 固定的数值转换为字符串值(如:1代表男,2代表女)

    表达式: "s:1=男,2=女"

  2. 数值对应的值需要查询数据库才能进行映射 (用的机会不多,一般这种情况直接在DAO处理)

    需要实现org.wuwz.poi.convert.ExportConvert接口

    表达式: "c:org.wuwz.poi.test.GradeIdConvert"


	public class GradeIdConvert implements ExportConvert {
	
	    static Map<Integer, String> records;
	    static {
	        //默认数据库字典查询 select * from tb_grades
	        records = new HashMap<Integer, String>();
	        records.put(1, "一年级学生");
	        records.put(2, "二年级学生");
	        records.put(3, "三年级学生");
	    }
	    
	    @Override
	    public String handler(Integer val) {
	        return records.get(val) != null ? records.get(val) : "无记录";
	    }
	
	}

3.一行代码执行浏览器导出:

注意:导出数量有内存限制,这取决于你的设备可用内存、JVM内存,建议适当的调大一点

	@RequestMapping("/export");
	public void export(HttpServletResponse response) {
	    List<User> users = dao.getUsers();
	    // 生成Excel并使用浏览器下载
	    ExcelKit.$Export(User.class, response).toExcel(users, "用户信息");
	}

常用例子:

1.海量数据Excel文件读取、导入(边读边处理):

		/*1. 海量数据导入 (伪代码)*/
		
		// 获取上传文件
		File upload = null;
		
		// 读取并解析文件
		final List<Object> exportData = new ArrayList<Object>();
		ExcelKit.$Import().readExcel(upload, new ReadHandler() {
			
			@Override
			public void handler(int sheetIndex, int rowIndex, List<String> row) {
				try {
					// 排除表头
					if(rowIndex == 0) return;
					
					// 验证行数据
					if(!validRow(row)) {
						// TODO: 行数据rowIndex验证失败,记录
						
					} else {
						// 解析行数据
						
						// 方案1:记录行数据,读取完成后批量入库
						exportData.add(analysisRow(row));
						
						// 方案2:单行直接入库
						// xxx.save(analysisRow(row));
					} 
					
				} catch (Exception e) {
					e.printStackTrace();
					// 读取行:rowIndex发生异常,记录
				}
			}

			private Object analysisRow(List<String> row) {
				// TODO 解析行数据为对象
				return null;
			}

			private boolean validRow(List<String> row) {
				// TODO 验证行数据
				return true;
			}
		});
		
		// 方案1: 文件读取解析完毕, 批量入库。
		xxx.batchSave(exportData);
		
		// TODO 响应结果,成功条数、失败条数(行、原因)

2.生成Excel文件到本地:

	ExcelKit.$Builder(User.class)
	    .setMaxSheetRecords(10000) //设置每个sheet的最大记录数,默认为10000,可不设置
	    .toExcel(records, "用户数据", new FileOutputStream(new File("c:/test001.xlsx")));
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.

简介

Excel导入导出工具(简单、好用且轻量级的海量Excel文件导入导出解决方案.)https://github.com/wuwz/ExcelKit 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/yongxinlu2017/ExcelKit.git
git@gitee.com:yongxinlu2017/ExcelKit.git
yongxinlu2017
ExcelKit
ExcelKit
master

搜索帮助

14c37bed 8189591 565d56ea 8189591