Apache Fesod (Incubating)

Introduction

Apache Fesod (Incubating) is a high-performance and memory-efficient Java library for reading and writing Excel files, designed to simplify development and ensure reliability.

Apache Fesod (Incubating) can provide developers and enterprises with great freedom and flexibility. We plan to introduce more new features in the future to continually enhance user experience and tool usability. Apache Fesod ( Incubating) is committed to being your best choice for handling Excel files.

The name fesod(pronounced /ˈfɛsɒd/), an acronym for “fast easy spreadsheet and other documents” expresses the project's origin, background and vision.

Features

• High-performance Reading and Writing: Apache Fesod (Incubating) 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.
• 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.
• Stream Operations: Apache Fesod (Incubating) 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.

Installation

Apache Fesod (Incubating) requires Java 1.8 or later. Using the latest LTS release of Java is encouraged. We strongly recommend using the latest version of Apache Fesod (Incubating), as performance optimizations, bug fixes, and new features in the latest version will enhance your experience.

Currently, Apache Fesod (Incubating) uses POI as its underlying package. If your project already includes POI-related components, you will need to manually exclude POI-related jar files.

We are currently preparing for the first release under the Apache Incubator. Current releases were non-Apache releases. You can see previous verison in this link: https://fesod.apache.org/docs/quickstart/guide/

Maven

If you are using Maven for project building, add the following configuration in the pom.xml file:

<dependency>
    <groupId>org.apache.fesod</groupId>
    <artifactId>fesod</artifactId>
    <version>version</version>
</dependency>

Gradle

If you are using Gradle for project building, add the following configuration in the build.gradle file:

dependencies {
    implementation 'org.apache.fesod:fesod:version'
}

QuickStart

Read

Below is an example of reading an Excel document:

// Implement the ReadListener interface to set up operations for reading data
public class DemoDataListener implements ReadListener<DemoData> {

    @Override
    public void invoke(DemoData data, AnalysisContext context) {
        System.out.println("Parsed a data entry" + JSON.toJSONString(data));
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        System.out.println("All data parsed!");
    }
}

public static void main(String[] args) {
    String fileName = "demo.xlsx";
    // Read Excel file
    Fesod.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
}

Write

Below is a simple example of creating an Excel document:

// Sample data class
public class DemoData {

    @ExcelProperty("String Title")
    private String string;

    @ExcelProperty("Date Title")
    private Date date;

    @ExcelProperty("Number Title")
    private Double doubleData;

    @ExcelIgnore
    private String ignore;
}

// Prepare data to write
private static List<DemoData> data() {
    List<DemoData> list = new ArrayList<>();
    for (int i = 0; i < 10; i++) {
        DemoData data = new DemoData();
        data.setString("String" + i);
        data.setDate(new Date());
        data.setDoubleData(0.56);
        list.add(data);
    }
    return list;
}

public static void main(String[] args) {
    String fileName = "demo.xlsx";
    // Create a "Template" sheet and write data
    Fesod.write(fileName, DemoData.class).sheet("Template").doWrite(data());
}

Community

Contributors

Contributors are welcomed to join the Apache Fesod (Incubating). Please check Contributing Guide about how to contribute to this project.

Thank you to all the people who already contributed to the Apache Fesod (Incubating) !

Note: Showing the first 100 contributors only due to GitHub image size limitations

Subscribe Mailing Lists

Mail List is the most recognized form of communication in the Apache community. Contact us through the following mailing list.

Star History

License

Apache Fesod (Incubating) project is licensed under the Apache License 2.0.