|
| 1 | +<!-- |
| 2 | +- Licensed to the Apache Software Foundation (ASF) under one or more |
| 3 | +- contributor license agreements. See the NOTICE file distributed with |
| 4 | +- this work for additional information regarding copyright ownership. |
| 5 | +- The ASF licenses this file to You under the Apache License, Version 2.0 |
| 6 | +- (the "License"); you may not use this file except in compliance with |
| 7 | +- the License. You may obtain a copy of the License at |
| 8 | +- |
| 9 | +- http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +- |
| 11 | +- Unless required by applicable law or agreed to in writing, software |
| 12 | +- distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | +- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | +- See the License for the specific language governing permissions and |
| 15 | +- limitations under the License. |
| 16 | +--> |
| 17 | + |
| 18 | +<p align="center"> |
| 19 | + <a href="https://fesod.apache.org"> |
| 20 | + <img alt="fesod" src="logo.svg" width="260"> |
| 21 | + </a> |
| 22 | +</p> |
| 23 | + |
| 24 | +<p align="center"> |
| 25 | +<b>Readme</b>: |
| 26 | +<b><a href="README.md">English</a></b> | <a href="README_CN.md">中文</a> |
| 27 | +</p> |
| 28 | + |
| 29 | +[](https://github.com/apache/fesod/actions/workflows/ci.yml) |
| 30 | +[](https://github.com/apache/fesod/actions/workflows/nightly.yml) |
| 31 | +[](https://github.com/apache/fesod/blob/main/LICENSE) |
| 32 | + |
| 33 | +[](https://fesod.apache.org/) |
| 34 | +[](https://deepwiki.com/apache/fesod) |
| 35 | + |
| 36 | +**官网: [fesod.apache.org](https://fesod.apache.org)** |
| 37 | +**邮件: < a href= "mailto:[email protected]">发送至 ```[email protected]```</ a> ** 订阅邮件列表 |
| 38 | + |
| 39 | +## 简介 |
| 40 | + |
| 41 | +**Apache Fesod (Incubating)** 是一个高性能、内存高效的 Java 库，用于读写 Excel 文件，旨在简化开发并确保可靠性。 |
| 42 | + |
| 43 | +Apache Fesod (Incubating) 可以为开发者和企业提供极大的自由度和灵活性。我们计划在未来引入更多新功能，以持续提升用户体验和工具可用性。Apache Fesod (Incubating) 致力于成为您处理 Excel 文件的最佳选择。 |
| 44 | + |
| 45 | +名称 fesod（发音为 `/ˈfɛsɒd/`），是 "fast easy spreadsheet and other documents"（快速简单的电子表格和其他文档）的首字母缩写，表达了项目的起源、背景和愿景。 |
| 46 | + |
| 47 | +### 特性 |
| 48 | + |
| 49 | +- **高性能读写**：Apache Fesod (Incubating) 专注于性能优化，能够高效处理大规模 Excel 数据。与一些传统的 Excel 处理库相比，它可以显著减少内存消耗。 |
| 50 | +- **简单易用**：该库提供了简单直观的 API，使开发者能够轻松将其集成到项目中，无论是简单的 Excel 操作还是复杂的数据处理。 |
| 51 | +- **流式操作**：Apache Fesod (Incubating) 支持流式读取，最大程度地减少一次性加载大量数据的问题。这一设计在处理数十万甚至数百万行数据时尤其重要。 |
| 52 | + |
| 53 | +## 安装 |
| 54 | + |
| 55 | +Apache Fesod (Incubating) 需要 **Java 1.8** 或更高版本。建议使用最新的 LTS 版本的 Java。我们强烈建议使用最新版本的 Apache Fesod (Incubating)，因为最新版本中的性能优化、错误修复和新功能将提升您的使用体验。 |
| 56 | + |
| 57 | +> 目前，Apache Fesod (Incubating) 使用 POI 作为底层包。如果您的项目已包含 POI 相关组件，您需要手动排除 POI 相关的 jar 文件。 |
| 58 | +
|
| 59 | +> 我们目前正在准备 Apache 孵化器下的第一个版本。当前的版本都是非 Apache 版本。您可以通过此链接查看之前的版本：https://fesod.apache.org/docs/quickstart/guide/ |
| 60 | +
|
| 61 | +### Maven |
| 62 | + |
| 63 | +如果使用 Maven 进行项目构建，请在 `pom.xml` 文件中添加以下配置： |
| 64 | + |
| 65 | +```xml |
| 66 | + |
| 67 | +<dependency> |
| 68 | + <groupId>org.apache.fesod</groupId> |
| 69 | + <artifactId>fesod</artifactId> |
| 70 | + <version>version</version> |
| 71 | +</dependency> |
| 72 | +``` |
| 73 | + |
| 74 | +### Gradle |
| 75 | + |
| 76 | +如果使用 Gradle 进行项目构建，请在 build.gradle 文件中添加以下配置： |
| 77 | + |
| 78 | +```gradle |
| 79 | +dependencies { |
| 80 | + implementation 'org.apache.fesod:fesod:version' |
| 81 | +} |
| 82 | +``` |
| 83 | + |
| 84 | +## 快速开始 |
| 85 | + |
| 86 | +### 读取 |
| 87 | + |
| 88 | +以下是读取 Excel 文档的示例： |
| 89 | + |
| 90 | +```java |
| 91 | +// 实现 ReadListener 接口以设置读取数据的操作 |
| 92 | +public class DemoDataListener implements ReadListener<DemoData> { |
| 93 | + |
| 94 | + @Override |
| 95 | + public void invoke(DemoData data, AnalysisContext context) { |
| 96 | + System.out.println("解析了一条数据" + JSON.toJSONString(data)); |
| 97 | + } |
| 98 | + |
| 99 | + @Override |
| 100 | + public void doAfterAllAnalysed(AnalysisContext context) { |
| 101 | + System.out.println("所有数据解析完成！"); |
| 102 | + } |
| 103 | +} |
| 104 | + |
| 105 | +public static void main(String[] args) { |
| 106 | + String fileName = "demo.xlsx"; |
| 107 | + // 读取 Excel 文件 |
| 108 | + Fesod.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead(); |
| 109 | +} |
| 110 | +``` |
| 111 | + |
| 112 | +### 写入 |
| 113 | + |
| 114 | +以下是创建 Excel 文档的简单示例： |
| 115 | + |
| 116 | +```java |
| 117 | +// 示例数据类 |
| 118 | +public class DemoData { |
| 119 | + |
| 120 | + @ExcelProperty("字符串标题") |
| 121 | + private String string; |
| 122 | + |
| 123 | + @ExcelProperty("日期标题") |
| 124 | + private Date date; |
| 125 | + |
| 126 | + @ExcelProperty("数字标题") |
| 127 | + private Double doubleData; |
| 128 | + |
| 129 | + @ExcelIgnore |
| 130 | + private String ignore; |
| 131 | +} |
| 132 | + |
| 133 | +// 准备要写入的数据 |
| 134 | +private static List<DemoData> data() { |
| 135 | + List<DemoData> list = new ArrayList<>(); |
| 136 | + for (int i = 0; i < 10; i++) { |
| 137 | + DemoData data = new DemoData(); |
| 138 | + data.setString("String" + i); |
| 139 | + data.setDate(new Date()); |
| 140 | + data.setDoubleData(0.56); |
| 141 | + list.add(data); |
| 142 | + } |
| 143 | + return list; |
| 144 | +} |
| 145 | + |
| 146 | +public static void main(String[] args) { |
| 147 | + String fileName = "demo.xlsx"; |
| 148 | + // 创建一个名为 "Template" 的工作表并写入数据 |
| 149 | + Fesod.write(fileName, DemoData.class).sheet("Template").doWrite(data()); |
| 150 | +} |
| 151 | +``` |
| 152 | + |
| 153 | +## 社区 |
| 154 | + |
| 155 | +### 贡献者 |
| 156 | + |
| 157 | +欢迎贡献者加入 Apache Fesod (Incubating)。请查看[贡献指南](./CONTRIBUTING.md)了解如何为该项目做出贡献。 |
| 158 | + |
| 159 | +感谢所有已经为 Apache Fesod (Incubating) 做出贡献的人们！ |
| 160 | + |
| 161 | +<a href="https://github.com/apache/fesod/graphs/contributors"> |
| 162 | + <img src="https://contrib.rocks/image?repo=apache/fesod"/> |
| 163 | +</a> |
| 164 | + |
| 165 | +> 注意：由于 GitHub 图片大小限制，仅显示前 100 名贡献者 |
| 166 | +
|
| 167 | +### 订阅邮件列表 |
| 168 | + |
| 169 | +邮件列表是 Apache 社区中最受认可的交流形式。请通过以下邮件列表联系我们。 |
| 170 | + |
| 171 | +| 名称 | 邮件列表 | |
| 172 | +|:----------------------------------------------------|:--------------------------------------------------------------------------------------------------------------| |
| 173 | + |
| 174 | + |
| 175 | +### Star 历史 |
| 176 | + |
| 177 | +[](https://www.star-history.com/#apache/fesod&Date) |
| 178 | + |
| 179 | +## 许可证 |
| 180 | + |
| 181 | +Apache Fesod (Incubating) 项目采用 [Apache License 2.0](LICENSE) 许可证。 |
| 182 | + |
0 commit comments