Skip to content

Commit 1e5c481

Browse files
authored
chore: reorder READMEs (#495)
Signed-off-by: tison <[email protected]>
1 parent eaa944e commit 1e5c481

File tree

4 files changed

+329
-329
lines changed

4 files changed

+329
-329
lines changed

README.md

Lines changed: 102 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
</p>
44

55
<p align="center">
6-
<a href="README.md">中文</a> | <a href="README_EN.md">English</a> | <a href="README_JP.md">日本語</a>
6+
<a href="README.md">English</a> | <a href="README_ZH.md">中文</a> | <a href="README_JP.md">日本語</a>
77
</p>
88

99
<p align="center">
@@ -19,114 +19,159 @@
1919
<a href="https://readmex.com/fast-excel/fastexcel"><img src="https://raw.githubusercontent.com/CodePhiliaX/resource-trusteeship/main/readmex.svg" alt="ReadmeX"></a>
2020
</p>
2121

22-
## 什么是 FastExcel
22+
## What is FastExcel
2323

24-
FastExcel 是由原 EasyExcel 作者创建的新项目。2023 年我已从阿里离职,近期阿里宣布停止更新 EasyExcel,我决定继续维护和升级这个项目。在重新开始时,我选择为它起名为 FastExcel,以突出这个框架在处理 Excel 文件时的高性能表现,而不仅仅是简单易用。
24+
FastExcel is the latest work created by the original author of EasyExcel. After I left Alibaba in 2023, and with Alibaba announcing the cessation of EasyExcel updates, I decided to continue maintaining and upgrading this project. When restarting, I chose the name FastExcel to emphasize the high performance of this framework when handling Excel files, not just its simplicity and ease of use.
2525

26-
FastExcel 将始终坚持免费开源,并采用商业友好的 Apache 协议,使其适用于任何商业化场景。这为开发者和企业提供了极大的自由度和灵活性。其一些显著特点包括:
26+
FastExcel will always be free and open source , use the business-friendly Apache license., making it suitable for any commercial scenarios. This provides developers and enterprises with great freedom and flexibility. Some notable features of FastExcel include:
2727

28-
- 完全兼容原 EasyExcel 的所有功能和特性,这使得用户可以无缝过渡。
29-
- 从 EasyExcel 迁移到 FastExcel 只需简单地更换包名和 Maven 依赖即可完成升级。
30-
- 在功能上,比 EasyExcel 提供更多新的特性和改进。
28+
- Full compatibility with all functionalities and features of the original EasyExcel, allowing users to transition seamlessly.
29+
- Migrating from EasyExcel to FastExcel only requires a simple change of package name and Maven dependency to complete the upgrade.
30+
- Functionally, it offers more innovations and improvements than EasyExcel.
31+
- The FastExcel 1.0.0 version introduced the ability to read a specified number of Excel rows and convert Excel to PDF.
3132

32-
我们计划在未来推出更多新特性,以不断提升用户体验和工具实用性。欢迎大家持续关注 FastExcel 的发展,FastExcel 致力于成为您处理 Excel 文件的最佳选择。
33+
We plan to introduce more new features in the future to continually enhance user experience and tool usability. Stay tuned to "Programmer Xiao Lan's" public account for updates on the development of FastExcel. FastExcel is committed to being your best choice for handling Excel files.
3334

34-
## 主要特性
35+
## Features
3536

36-
- **高性能读写**FastExcel 专注于性能优化,能够高效处理大规模的 Excel 数据。相比一些传统的 Excel 处理库,它能显著降低内存占用。
37-
- **简单易用**:该库提供了简洁直观的 API,使得开发者可以轻松集成到项目中,无论是简单的 Excel 操作还是复杂的数据处理都能快速上手。
38-
- **流式操作**FastExcel 支持流式读取,将一次性加载大量数据的问题降到最低。这种设计方式在处理数十万甚至上百万行的数据时尤为重要。
37+
- **High-performance Reading and Writing**: FastExcel focuses on performance optimization, capable of efficiently handling large-scale Excel data. Compared to some traditional Excel processing libraries, it can significantly reduce memory consumption.
38+
- **Simplicity and Ease of Use**: The library offers a simple and intuitive API, allowing developers to easily integrate it into projects, whether for simple Excel operations or complex data processing.
39+
- **Stream Operations**: FastExcel supports stream reading, minimizing the problem of loading large amounts of data at once. This design is especially important when dealing with hundreds of thousands or even millions of rows of data.
3940

40-
## 安装
41+
## Installation
4142

42-
下表列出了各版本 FastExcel 基础库对 Java 语言版本最低要求的情况:
43+
The following table lists the minimum Java language version requirements for each version of the FastExcel library:
4344

44-
| 版本 | jdk版本支持范围 | 备注 |
45-
|-------|:------------:|---------------|
46-
| 1.2.x | jdk8 - jdk21 | 完全兼容easyexcel |
47-
| 1.1.x | jdk8 - jdk21 | 完全兼容easyexcel |
48-
| 1.0.x | jdk8 - jdk21 | 完全兼容easyexcel |
45+
| Version | JDK Version Support Range | Notes |
46+
|---------|:-------------------------:|--------------------------------|
47+
| 1.2.x | JDK8 - JDK21 | Current master branch, fully compatible with EasyExcel |
48+
| 1.1.x | JDK8 - JDK21 | Current master branch, fully compatible with EasyExcel |
49+
| 1.0.x | JDK8 - JDK21 | Current master branch, fully compatible with EasyExcel |
4950

50-
我们强烈建议您使用最新版本的 FastExcel,因为最新版本中的性能优化、BUG修复和新功能都会让您的使用更加方便。
51+
We strongly recommend using the latest version of FastExcel, as performance optimizations, bug fixes, and new features in the latest version will enhance your experience.
5152

52-
> 当前 FastExcel 底层使用 poi 作为基础包,如果您的项目中已经有 poi 相关组件,需要您手动排除 poi 的相关 jar 包。
53+
> Currently, FastExcel uses POI as its underlying package. If your project already includes POI-related components, you will need to manually exclude POI-related jar files.
5354
54-
### 版本更新
55+
### Version Update
56+
For detailed update logs, refer to [Details of version updates](./CHANGELOG.md). You can also find all available versions in the [Maven Central Repository](https://mvnrepository.com/artifact/cn.idev.excel/fastexcel).
5557

56-
您可以在 [版本升级详情](./CHANGELOG.md) 中查询到具体的版本更新细节。您也可以在[Maven 中心仓库](https://mvnrepository.com/artifact/cn.idev.excel/fastexcel)中查询到所有的版本。
5758

5859
### Maven
5960

60-
如果您使用 Maven 进行项目构建,请在 `pom.xml` 文件中引入以下配置:
61-
61+
If you are using Maven for project building, add the following configuration in the `pom.xml` file:
6262
```xml
6363
<dependency>
6464
<groupId>cn.idev.excel</groupId>
6565
<artifactId>fastexcel</artifactId>
66-
<version>版本号</version>
66+
<version>version</version>
6767
</dependency>
6868
```
69-
7069
### Gradle
71-
72-
如果您使用 Gradle 进行项目构建,请在 `build.gradle` 文件中引入以下配置:
70+
If you are using Gradle for project building, add the following configuration in the build.gradle file:
7371

7472
```gradle
7573
dependencies {
76-
implementation 'cn.idev.excel:fastexcel:版本号'
74+
implementation 'cn.idev.excel:fastexcel:version'
7775
}
7876
```
7977

80-
## 示例
78+
## EasyExcel and FastExcel
79+
80+
### Differences
81+
82+
- FastExcel supports all the features of EasyExcel but with better performance and stability.
83+
- FastExcel has an identical API to EasyExcel, allowing seamless switching.
84+
- FastExcel will continue to update, fix bugs, optimize performance, and add new features.
85+
86+
### How to Upgrade from EasyExcel to FastExcel
87+
88+
#### Update Dependencies
89+
Replace the EasyExcel dependency with the FastExcel dependency, as follows:
90+
91+
```xml
92+
<!-- EasyExcel dependency -->
93+
<dependency>
94+
<groupId>com.alibaba</groupId>
95+
<artifactId>easyexcel</artifactId>
96+
<version>xxx</version>
97+
</dependency>
98+
```
99+
Replace with:
100+
```xml
101+
<dependency>
102+
<groupId>cn.idev.excel</groupId>
103+
<artifactId>fastexcel</artifactId>
104+
<version>xxx</version>
105+
</dependency>
106+
```
107+
#### Update Code
108+
Replace the EasyExcel package name with the FastExcel package name, as follows:
109+
110+
```java
111+
// Replace EasyExcel package name with FastExcel package name
112+
import com.alibaba.excel.*;
113+
```
114+
115+
Replace with:
116+
117+
```java
118+
import cn.idev.excel.*;
119+
```
81120

82-
### 读取 Excel 文件
121+
### Import FastExcel Without Modifying Code
122+
If you do not want to modify the code for various reasons, you can directly depend on FastExcel by directly adding the dependency in the pom.xml file. EasyExcel and FastExcel can coexist, but long-term switching to FastExcel is recommended.
83123

84-
下面是读取 Excel 文档的例子:
124+
### Future Use of FastExcel Classes Recommended
125+
To maintain compatibility, EasyExcel classes are retained, but using FastExcel classes in the future is recommended. FastExcel classes are the entry classes for FastExcel and encompass all features of EasyExcel. New features will only be added to FastExcel classes.
85126

127+
## Example
128+
129+
### Reading Excel Files
130+
131+
Below is an example of reading an Excel document:
86132
```java
87-
// 实现 ReadListener 接口,设置读取数据的操作
133+
// Implement the ReadListener interface to set up operations for reading data
88134
public class DemoDataListener implements ReadListener<DemoData> {
89135
@Override
90136
public void invoke(DemoData data, AnalysisContext context) {
91-
System.out.println("解析到一条数据" + JSON.toJSONString(data));
137+
System.out.println("Parsed a data entry" + JSON.toJSONString(data));
92138
}
93139

94140
@Override
95141
public void doAfterAllAnalysed(AnalysisContext context) {
96-
System.out.println("所有数据解析完成!");
142+
System.out.println("All data parsed!");
97143
}
98144
}
99145

100146
public static void main(String[] args) {
101147
String fileName = "demo.xlsx";
102-
// 读取 Excel 文件
148+
// Read Excel file
103149
FastExcel.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
104150
}
105151
```
106152

107-
### 创建 Excel 文件
108-
109-
下面是一个创建 Excel 文档的简单例子:
153+
### Creating Excel Files
110154

155+
Below is a simple example of creating an Excel document:
111156
```java
112-
// 示例数据类
157+
// Sample data class
113158
public class DemoData {
114-
@ExcelProperty("字符串标题")
159+
@ExcelProperty("String Title")
115160
private String string;
116-
@ExcelProperty("日期标题")
161+
@ExcelProperty("Date Title")
117162
private Date date;
118-
@ExcelProperty("数字标题")
163+
@ExcelProperty("Number Title")
119164
private Double doubleData;
120165
@ExcelIgnore
121166
private String ignore;
122167
}
123168

124-
// 填充要写入的数据
169+
// Prepare data to write
125170
private static List<DemoData> data() {
126171
List<DemoData> list = new ArrayList<>();
127172
for (int i = 0; i < 10; i++) {
128173
DemoData data = new DemoData();
129-
data.setString("字符串" + i);
174+
data.setString("String" + i);
130175
data.setDate(new Date());
131176
data.setDoubleData(0.56);
132177
list.add(data);
@@ -136,91 +181,27 @@ private static List<DemoData> data() {
136181

137182
public static void main(String[] args) {
138183
String fileName = "demo.xlsx";
139-
// 创建一个名为“模板”的 sheet 页,并写入数据
140-
FastExcel.write(fileName, DemoData.class).sheet("模板").doWrite(data());
184+
// Create a "Template" sheet and write data
185+
FastExcel.write(fileName, DemoData.class).sheet("Template").doWrite(data());
141186
}
142187
```
143188

144-
## EasyExcel 与 FastExcel
145-
146-
### 区别
147-
148-
- FastExcel 支持所有 EasyExcel 的功能,但是 FastExcel 的性能更好,更稳定。
149-
- FastExcel 与 EasyExcel 的 API 完全一致,可以无缝切换。
150-
- FastExcel 会持续的更新,修复 bug,优化性能,增加新功能。
151-
152-
### 如何升级到 FastExcel
153-
154-
#### 替换依赖
155-
156-
将 EasyExcel 的依赖替换为 FastExcel 的依赖,如下:
157-
158-
```xml
159-
<!-- easyexcel 依赖 -->
160-
<dependency>
161-
<groupId>com.alibaba</groupId>
162-
<artifactId>easyexcel</artifactId>
163-
<version>版本号</version>
164-
</dependency>
165-
```
166-
167-
的依赖替换为
168-
169-
```xml
170-
171-
<dependency>
172-
<groupId>cn.idev.excel</groupId>
173-
<artifactId>fastexcel</artifactId>
174-
<version>版本号</version>
175-
</dependency>
176-
```
177-
178-
#### 替换包名
179-
180-
将 EasyExcel 的包名替换为 FastExcel 的包名,如下:
181-
182-
```java
183-
// 将 easyexcel 的包名替换为 FastExcel 的包名
184-
185-
import com.alibaba.excel.*;
186-
```
187-
188-
替换为
189-
190-
```java
191-
import cn.idev.excel.*;
192-
```
193-
194-
### 直接依赖 FastExcel
195-
196-
如果由于种种原因您不想修改代码,可以直接在 `pom.xml` 文件中直接依赖 FastExcel。EasyExcel 与 FastExcel 可以共存,但是长期建议替换为 FastExcel。
189+
## Contributing
190+
Contributors are welcomed to join the FastExcel project. Please check [Contributing Guide](./CONTRIBUTING.md) about how to contribute to this project.
197191

198-
### 使用建议
199-
200-
为了兼容性考虑保留了 EasyExcel 类,但是建议以后使用 FastExcel 类,FastExcel 类是 FastExcel 的入口类,功能包含了 EasyExcel 类的所有功能,以后新特性仅在 FastExcel 类中添加。
201-
202-
## 参与贡献
203-
204-
欢迎社区的每一位用户和开发者成为贡献者。无论是报告问题、改进文档、提交代码,还是提供技术支持,您的参与都将帮助 FastExcel 变得更好。请查阅[贡献指南](./CONTRIBUTING.md)来参与贡献。
205-
206-
感谢所有的贡献者们!
192+
Thank you to all the people who already contributed to FastExcel!
207193

208194
<a href="https://github.com/fast-excel/fastexcel/graphs/contributors">
209-
<img src="https://contrib.rocks/image?repo=fast-excel/fastexcel" />
195+
<img src="https://contrib.rocks/image?repo=fast-excel/fastexcel"/>
210196
</a>
211197

212-
> 备注: 由于图片大小的限制,我们默认暂只显示前100名贡献者
213-
214-
## 关注我们
198+
> Note: Showing the first 100 contributors only due to GitHub image size limitations
215199
216-
### 公众号
217-
218-
关注作者“程序员小懒“的公众号加入技术交流群,获取更多技术干货和最新动态。
219-
220-
<a><img src="https://github.com/user-attachments/assets/b40aebe8-0552-4fb2-b184-4cb64a5b1229" width="30%"/></a>
221-
222-
### Star History
200+
## Star History
223201

224202
[![Star History Chart](https://api.star-history.com/svg?repos=fast-excel/fastexcel&type=Date)](https://www.star-history.com/#fast-excel/fastexcel&Date)
225203

204+
## License
205+
206+
The project is licensed under the [Apache License 2.0](LICENSE).
226207

0 commit comments

Comments
 (0)