Skip to content

Commit c8dcda2

Browse files
authored
chore:update doc files. (#530)
* chore:update doc files. * chore:update doc files. * chore:update doc files.
1 parent c796073 commit c8dcda2

File tree

11 files changed

+123
-349
lines changed

11 files changed

+123
-349
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## 1.1.0
44

5-
此次升级主要修复 [EasyExcel](https://github.com/alibaba/easyexcel) 历史 BUG,同时剔除了部分依赖库,符合 MIT 协议的相关规范。
5+
此次升级主要修复历史 BUG,同时剔除了部分依赖库,符合 MIT 协议的相关规范。
66

77
具体更新内容如下:
88
- 【改进】移除 `itext` 依赖库,将 `转换PDF` 功能迁移至新项目;
@@ -16,7 +16,7 @@
1616
## 1.2.0
1717

1818
此次升级主要内容:
19-
1. 修复[EasyExcel](https://github.com/alibaba/easyexcel) 历史 BUG;
19+
1. 修复历史 BUG;
2020
2. 将项目的开源协议修改为Apache-2.0 license;
2121
3. 修复测试模块中一些无法本地运行的测试用例;
2222
4. 更新并增加相关API文档和说明。

README.md

Lines changed: 40 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -21,52 +21,60 @@
2121

2222
## What is FastExcel
2323

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.
24+
Fast, Concise, Java tool for processing Excel files that solves memory overflow issues with large files.
2525

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:
27-
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.
32-
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.
26+
FastExcel will always be free and open source, use the business-friendly Apache license, making it suitable for any
27+
commercial scenarios. This provides developers and enterprises with great freedom and flexibility.
28+
We plan to introduce more new features in the future to continually enhance user experience and tool usability. Stay
29+
tuned to "Programmer Xiao Lan's" public account for updates on the development of FastExcel. FastExcel is committed to
30+
being your best choice for handling Excel files.
3431

3532
## Features
3633

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.
34+
- **High-performance Reading and Writing**: FastExcel focuses on performance optimization, capable of efficiently
35+
handling large-scale Excel data. Compared to some traditional Excel processing libraries, it can significantly reduce
36+
memory consumption.
37+
- **Simplicity and Ease of Use**: The library offers a simple and intuitive API, allowing developers to easily integrate
38+
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
40+
once. This design is especially important when dealing with hundreds of thousands or even millions of rows of data.
4041

4142
## Installation
4243

4344
The following table lists the minimum Java language version requirements for each version of the FastExcel library:
4445

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 |
46+
| Version | JDK Version Support Range | Notes |
47+
|---------|:-------------------------:|-------|
48+
| 1.2.x | JDK8 - JDK21 | |
49+
| 1.1.x | JDK8 - JDK21 | |
50+
| 1.0.x | JDK8 - JDK21 | |
5051

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.
52+
We strongly recommend using the latest version of FastExcel, as performance optimizations, bug fixes, and new features
53+
in the latest version will enhance your experience.
5254

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.
55+
> Currently, FastExcel uses POI as its underlying package. If your project already includes POI-related components, you
56+
> will need to manually exclude POI-related jar files.
5457
5558
### 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).
5759

60+
For detailed update logs, refer to [Details of version updates](./CHANGELOG.md). You can also find all available
61+
versions in the [Maven Central Repository](https://mvnrepository.com/artifact/cn.idev.excel/fastexcel).
5862

5963
### Maven
6064

6165
If you are using Maven for project building, add the following configuration in the `pom.xml` file:
66+
6267
```xml
68+
6369
<dependency>
6470
<groupId>cn.idev.excel</groupId>
6571
<artifactId>fastexcel</artifactId>
6672
<version>version</version>
6773
</dependency>
6874
```
75+
6976
### Gradle
77+
7078
If you are using Gradle for project building, add the following configuration in the build.gradle file:
7179

7280
```gradle
@@ -75,68 +83,21 @@ dependencies {
7583
}
7684
```
7785

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-
```
120-
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.
123-
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.
126-
12786
## Example
12887

129-
### Reading Excel Files
88+
### Reading Excel Files
13089

13190
Below is an example of reading an Excel document:
91+
13292
```java
13393
// Implement the ReadListener interface to set up operations for reading data
13494
public class DemoDataListener implements ReadListener<DemoData> {
95+
13596
@Override
13697
public void invoke(DemoData data, AnalysisContext context) {
13798
System.out.println("Parsed a data entry" + JSON.toJSONString(data));
13899
}
139-
100+
140101
@Override
141102
public void doAfterAllAnalysed(AnalysisContext context) {
142103
System.out.println("All data parsed!");
@@ -153,15 +114,20 @@ public static void main(String[] args) {
153114
### Creating Excel Files
154115

155116
Below is a simple example of creating an Excel document:
117+
156118
```java
157119
// Sample data class
158120
public class DemoData {
121+
159122
@ExcelProperty("String Title")
160123
private String string;
124+
161125
@ExcelProperty("Date Title")
162126
private Date date;
127+
163128
@ExcelProperty("Number Title")
164129
private Double doubleData;
130+
165131
@ExcelIgnore
166132
private String ignore;
167133
}
@@ -187,7 +153,9 @@ public static void main(String[] args) {
187153
```
188154

189155
## Contributing
190-
Contributors are welcomed to join the FastExcel project. Please check [Contributing Guide](./CONTRIBUTING.md) about how to contribute to this project.
156+
157+
Contributors are welcomed to join the FastExcel project. Please check [Contributing Guide](./CONTRIBUTING.md) about how
158+
to contribute to this project.
191159

192160
Thank you to all the people who already contributed to FastExcel!
193161

README_JP.md

Lines changed: 30 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -21,103 +21,73 @@
2121

2222
## FastExcelとは
2323

24-
FastExcelは、元EasyExcelの作者によって作成された最新の作品です。2023年に私がアリババを退職した後、アリババがEasyExcelの更新を停止することを発表したことに伴い、このプロジェクトを引き続きメンテナンスおよびアップグレードすることを決定しました。再び始める際に、私はこのフレームワークの名前をFastExcelとし、Excelファイルの処理における高性能を強調しました。その使いやすさだけではありません。
25-
26-
FastExcelは常にフリーでオープンソースであり、ビジネスに適したApacheオープンソースプロトコルを使用しています。。これにより、開発者や企業に大きな自由度と柔軟性が提供されます。FastExcelのいくつかの顕著な特徴は以下の通りです:
27-
28-
- 1. 元のEasyExcelのすべての機能と特性との完全な互換性があるため、ユーザーはシームレスに移行できます。
29-
- 2. EasyExcelからFastExcelへの移行は、パッケージ名とMaven依存関係を単純に変更するだけでアップグレードが完了します。
30-
- 3. 機能的には、EasyExcelよりも多くの革新と改善を提供します。
31-
- 4. FastExcel 1.0.0バージョンでは、指定行数のExcelを読み取り、ExcelをPDFに変換する機能を新たに追加しました。
24+
FastExcelは常にフリーでオープンソースであり、ビジネスに適したApacheオープンソースプロトコルを使用しています。。これにより、開発者や企業に大きな自由度と柔軟性が提供されます。
3225

3326
私たちは、将来的にさらなる新機能を導入し続けて、ユーザーエクスペリエンスとツールの実用性を継続的に向上させる計画です。開発の進捗を追い、FastExcelの発展をサポートするため、「プログラマー・シャオラン」の公式アカウントをお見逃しなく。FastExcelは、Excelファイルの処理におけるお客様の最良の選択肢となることに専念しています。
3427

3528
## 主な機能
3629

37-
- 1. 高性能な読み書き:FastExcelはパフォーマンスの最適化に重点を置き、大規模なExcelデータを効率的に処理することができます。いくつかの伝統的なExcel処理ライブラリと比較して、メモリ消費を大幅に削減できます。
38-
- 2. 簡単で使いやすい:このライブラリは簡潔で直感的なAPIを提供しており、開発者がプロジェクトに簡単に統合でき、簡単なExcel操作から複雑なデータ処理まで迅速に習得できます。
39-
- 3. ストリーム操作:FastExcelはストリーム読み取りをサポートしており、大量のデータを一度にロードする問題を最小限に抑えます。この設計方式は数十万行、または数百万行のデータを処理する際に特に重要です。
30+
-
31+
1. 高性能な読み書き:FastExcelはパフォーマンスの最適化に重点を置き、大規模なExcelデータを効率的に処理することができます。いくつかの伝統的なExcel処理ライブラリと比較して、メモリ消費を大幅に削減できます。
32+
-
33+
2. 簡単で使いやすい:このライブラリは簡潔で直感的なAPIを提供しており、開発者がプロジェクトに簡単に統合でき、簡単なExcel操作から複雑なデータ処理まで迅速に習得できます。
34+
-
35+
3. ストリーム操作:FastExcelはストリーム読み取りをサポートしており、大量のデータを一度にロードする問題を最小限に抑えます。この設計方式は数十万行、または数百万行のデータを処理する際に特に重要です。
4036

4137
## インストール
4238

4339
以下の表は、各バージョンのFastExcel基礎ライブラリのJava言語バージョンの最低要件を一覧にしたものです:
4440

45-
| バージョン | JDKバージョンサポート範囲 | 備考 |
46-
|--------------|:--------------------------:|----------------------------------|
47-
| 1.0.0+ | JDK8 - JDK21 | 現在のマスターブランチ、EasyExcelと完全互換 |
41+
| バージョン | JDKバージョンサポート範囲 | 備考 |
42+
|--------|:--------------:|----|
43+
| 1.0.0+ | JDK8 - JDK21 | |
4844

4945
最新のFastExcelバージョンを使用することを強くお勧めします。最新バージョンのパフォーマンス最適化、バグ修正、および新機能は、使用の利便性を向上させます。
5046

5147
> 現在、FastExcelの基盤としてPOIを使用しています。プロジェクトに既にPOI関連のコンポーネントが含まれている場合、POI関連のjarファイルを手動で除外する必要があります。
5248
5349
### Maven
50+
5451
Mavenでプロジェクトを構築する場合、`pom.xml`ファイルに次の構成を含めてください:
52+
5553
```xml
54+
5655
<dependency>
5756
<groupId>cn.idev.excel</groupId>
5857
<artifactId>fastexcel</artifactId>
5958
<version>1.2.0</version>
6059
</dependency>
6160
```
61+
6262
### Gradle
6363

6464
Gradleでプロジェクトを構築する場合、build.gradleファイルに次の構成を含めてください:
65+
6566
```gradle
6667
dependencies {
6768
implementation 'cn.idev.excel:fastexcel:1.2.0'
6869
}
6970
```
71+
7072
## 更新する
71-
具体的なバージョンアップ内容は[バージョンアップ詳細](CHANGELOG.md)で確認できます。 [Maven Central Repository](https://mvnrepository.com/artifact/cn.idev.excel/fastexcel) 内のすべてのバージョンをクエリすることもできます。
72-
## EasyExcelとFastExcelの違い
73-
- FastExcelはEasyExcelのすべての機能をサポートしていますが、FastExcelのパフォーマンスはより良く、より安定しています。
74-
- FastExcelとEasyExcelのAPIは完全に一致しているため、シームレスに切り替えることができます。
75-
- FastExcelは継続して更新され、バグを修正し、パフォーマンスを最適化し、新機能を追加します。
76-
## EasyExcelをFastExcelにアップグレードする方法
77-
### 1. 依存関係の変更
78-
EasyExcelの依存関係をFastExcelの依存関係に置き換えます。以下のように:
79-
```xml
80-
<!-- easyexcel 依存 -->
81-
<dependency>
82-
<groupId>com.alibaba</groupId>
83-
<artifactId>easyexcel</artifactId>
84-
<version>xxxx</version>
85-
</dependency>
86-
```
87-
を以下に置き換えます
88-
```xml
89-
<dependency>
90-
<groupId>cn.idev.excel</groupId>
91-
<artifactId>fastexcel</artifactId>
92-
<version>1.2.0</version>
93-
</dependency>
94-
```
95-
### 2. コードの修正
96-
EasyExcelのパッケージ名をFastExcelのパッケージ名に置き換えます。以下のように:
97-
```java
98-
// EasyExcelのパッケージ名をFastExcelのパッケージ名に置き換えます
99-
import com.alibaba.excel.*;
100-
```
101-
を以下に置き換えます
102-
```java
103-
import cn.idev.excel.*;
104-
```
105-
### 3. コードを修正せずにFastExcelを直接依存する
106-
何らかの理由でコードを修正したくない場合は、FastExcelに直接依存し、pom.xmlファイル内でFastExcelに直接依存できます。EasyExcelとFastExcelは共存できますが、長期的にはFastExcelを使用することを推奨します。
10773

108-
### 4. 以後はFastExcelクラスを使用することをお勧めします
109-
互換性を考慮してEasyExcelクラスが保持されていますが、今後はFastExcelクラスを使用することをお勧めします。FastExcelクラスはFastExcelのエントリークラスであり、EasyExcelクラスのすべての機能を含んでいます。新機能は以後、FastExcelクラスにのみ追加されます。
74+
具体的なバージョンアップ内容は[バージョンアップ詳細](CHANGELOG.md)
75+
で確認できます。 [Maven Central Repository](https://mvnrepository.com/artifact/cn.idev.excel/fastexcel)
76+
内のすべてのバージョンをクエリすることもできます。
11077

11178
## シンプルな例:Excelファイルを読む
79+
11280
以下にExcelドキュメントを読んでいる例を示します:
81+
11382
```java
11483
// ReadListenerインターフェースを実装してデータを読む操作を設定します
11584
public class DemoDataListener implements ReadListener<DemoData> {
85+
11686
@Override
11787
public void invoke(DemoData data, AnalysisContext context) {
11888
System.out.println("データエントリを解析しました" + JSON.toJSONString(data));
11989
}
120-
90+
12191
@Override
12292
public void doAfterAllAnalysed(AnalysisContext context) {
12393
System.out.println("すべてのデータの解析が完了しました!");
@@ -130,17 +100,24 @@ public static void main(String[] args) {
130100
FastExcel.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
131101
}
132102
```
103+
133104
## シンプルな例:Excelファイルを作成
105+
134106
以下はExcelドキュメントを作成する簡単な例です:
107+
135108
```java
136109
// サンプルデータクラス
137110
public class DemoData {
111+
138112
@ExcelProperty("文字列タイトル")
139113
private String string;
114+
140115
@ExcelProperty("日付タイトル")
141116
private Date date;
117+
142118
@ExcelProperty("数字タイトル")
143119
private Double doubleData;
120+
144121
@ExcelIgnore
145122
private String ignore;
146123
}

0 commit comments

Comments
 (0)