How alibaba/easyexcel works
EasyExcel is a Java library for streaming Excel/CSV reading and generating spreadsheets. The principal workflows are application code configuring a read or write through the public API, then receiving row callbacks or writing supplied data to an output. The tree also shows format-specific readers, template/fill support, converters, and customizable write handlers. The README documents the basic read/write workflows; sampled source supports selected parser and handler relationships. Several subsystems are represented by their existing directories because their implementation files were not sampled.
Main entry points: CellTagHandler.java XLSX cell parser · ExcelAnalyserImpl.java Read analyser · ExcelBuilderImpl.java Write builder · CellWriteHandlerContext.java Cell write context
Components 29
Public API
- Read/write API
easyexcel-core/src/main/java/com/alibaba/excel/EasyExcel.java - Reader builder
easyexcel-core/src/main/java/com/alibaba/excel/read/builder/ExcelReaderBuilder.java - Writer API
easyexcel-core/src/main/java/com/alibaba/excel/ExcelWriter.java
Reading
- Read analyser
easyexcel-core/src/main/java/com/alibaba/excel/analysis/ExcelAnalyserImpl.java - CSV reader
easyexcel-core/src/main/java/com/alibaba/excel/analysis/csv/CsvExcelReadExecutor.java - XLS reader
easyexcel-core/src/main/java/com/alibaba/excel/analysis/v03/XlsSaxAnalyser.java - XLS record handlers
easyexcel-core/src/main/java/com/alibaba/excel/analysis/v03/handlers - XLSX reader
easyexcel-core/src/main/java/com/alibaba/excel/analysis/v07/XlsxSaxAnalyser.java - XLSX cell parser
easyexcel-core/src/main/java/com/alibaba/excel/analysis/v07/handlers/CellTagHandler.java - Shared strings
easyexcel-core/src/main/java/com/alibaba/excel/analysis/v07/handlers/sax/SharedStringsTableHandler.java - Read cache
easyexcel-core/src/main/java/com/alibaba/excel/cache/ReadCache.java - Read event processor
easyexcel-core/src/main/java/com/alibaba/excel/read/processor/DefaultAnalysisEventProcessor.java - Read listeners
easyexcel-core/src/main/java/com/alibaba/excel/read/listener
Writing
- Write builder
easyexcel-core/src/main/java/com/alibaba/excel/write/ExcelBuilderImpl.java - Write context
easyexcel-core/src/main/java/com/alibaba/excel/context/WriteContext.java - Workbook and sheet state
easyexcel-core/src/main/java/com/alibaba/excel/write/metadata/holder - Template fill
easyexcel-core/src/main/java/com/alibaba/excel/write/executor/ExcelWriteFillExecutor.java - Write handlers
easyexcel-core/src/main/java/com/alibaba/excel/write/handler - Cell handler contract
easyexcel-core/src/main/java/com/alibaba/excel/write/handler/CellWriteHandler.java - Cell write context
easyexcel-core/src/main/java/com/alibaba/excel/write/handler/context/CellWriteHandlerContext.java - Fill style handler
easyexcel-core/src/main/java/com/alibaba/excel/write/handler/impl/FillStyleCellWriteHandler.java - Handler execution chain
easyexcel-core/src/main/java/com/alibaba/excel/write/handler/chain/CellHandlerExecutionChain.java - Write context contract
easyexcel-core/src/main/java/com/alibaba/excel/context/WriteContext.java
Data and conversion
- Cell and head metadata
easyexcel-core/src/main/java/com/alibaba/excel/metadata/Cell.java - Read/write cell data
easyexcel-core/src/main/java/com/alibaba/excel/metadata/data/WriteCellData.java - Type converters
easyexcel-core/src/main/java/com/alibaba/excel/converters - Cell type mapping
easyexcel-core/src/main/java/com/alibaba/excel/enums/CellDataTypeEnum.java - Excel XML constants
easyexcel-core/src/main/java/com/alibaba/excel/constant/ExcelXmlConstants.java
Other components
- Application
Connections 25
- Application → Read/write API: configures
README.md - Application → Reader builder: builds reader
README.md - Application → Writer API: writes data
README.md - XLSX cell parser → Excel XML constants: uses tags
easyexcel-core/src/main/java/com/alibaba/excel/analysis/v07/handlers/CellTagHandler.java - XLSX cell parser → Cell type mapping: maps cell type
easyexcel-core/src/main/java/com/alibaba/excel/analysis/v07/handlers/CellTagHandler.java - XLSX cell parser → Read/write cell data: creates cell data
easyexcel-core/src/main/java/com/alibaba/excel/analysis/v07/handlers/CellTagHandler.java - XLSX cell parser → Read cache: looks up strings
easyexcel-core/src/main/java/com/alibaba/excel/analysis/v07/handlers/CellTagHandler.java - Shared strings → Read cache: uses cache
easyexcel-core/src/main/java/com/alibaba/excel/analysis/v07/handlers/sax/SharedStringsTableHandler.java - XLS record handlers → XLS reader: handles records
- Cell write context → Write context contract: carries context
easyexcel-core/src/main/java/com/alibaba/excel/write/handler/context/CellWriteHandlerContext.java - Cell write context → Fill style handler: supports style fill
easyexcel-core/src/main/java/com/alibaba/excel/write/handler/context/CellWriteHandlerContext.java - Fill style handler → Workbook and sheet state: creates cell style
easyexcel-core/src/main/java/com/alibaba/excel/write/handler/impl/FillStyleCellWriteHandler.java - Cell handler contract → Cell write context: accepts context
easyexcel-core/src/main/java/com/alibaba/excel/write/handler/CellWriteHandler.java - Handler execution chain → Cell handler contract: dispatches handlers
easyexcel-core/src/main/java/com/alibaba/excel/write/handler/chain/CellHandlerExecutionChain.java - Write context contract → Workbook and sheet state: exposes holders
easyexcel-core/src/main/java/com/alibaba/excel/context/WriteContext.java - Writer API → Write builder: delegates writing
- Reader builder → Read analyser: starts analysis
- Read analyser → CSV reader: selects format reader
- Read analyser → XLS reader: selects format reader
- Read analyser → XLSX reader: selects format reader
- Read event processor → Read listeners: dispatches events
- Write builder → Write context contract: uses write context
- Write handlers → Cell handler contract: provides handlers
easyexcel-core/src/main/java/com/alibaba/excel/write/handler/chain/CellHandlerExecutionChain.java - Write builder → Template fill: supports template fill
- Type converters → Read/write cell data: converts values