easyexcel-write

Original：🇨🇳 Chinese

Translated

An Excel data-writing skill based on Alibaba EasyExcel (com.alibaba:easyexcel:4.0.3). It covers the simplest write methods (3 approaches), complex headers (multi-level), the @ExcelProperty/@ExcelIgnore/@DateTimeFormat/@NumberFormat annotations, selective column export with includeColumn/excludeColumn, style annotations such as @ColumnWidth/@ContentRowHeight, custom styles with @HeadStyle/@ContentStyle, merged cells (@ContentLoopMerge/LoopMergeStrategy), image export (File/InputStream/URL/byte[]), hyperlinks/comments/formulas/rich text (WriteCellData), dynamic headers, automatic column widths, custom interceptors (CellWriteHandler/SheetWriteHandler/RowWriteHandler), paginated and batched writing, direct web downloads to OutputStream, and 03/07 version compatibility. Use this skill when users need to programmatically generate Excel files without predefined templates to export structured data such as orders, users, financial records, inventory, reports, statements, or approval forms. It is not suitable for populating predefined templates; use easyexcel-fill instead. It is also not suitable for reading Excel files; use easyexcel-read instead.

2installs

Sourcefull-stack-skills/java-skills

Added on2026-10-18

NPX Install

npx skill4agent add full-stack-skills/java-skills easyexcel-write

SKILL.md Content (Chinese)

View Translation Comparison →

EasyExcel Data Writing (Write)

Official documentation: https://easyexcel.opensource.alibaba.com/docs/current/quickstart/write Official examples: https://github.com/alibaba/easyexcel/blob/master/easyexcel-test/src/test/java/com/alibaba/easyexcel/test/demo/write/WriteTest.java Current version:
com.alibaba:easyexcel:4.0.3
(Apache-2.0; the repository has been archived and now receives bug fixes only)

This skill focuses on programmatically generating Excel files. Use it when there is no predefined template and structured Excel files such as orders, users, financial records, inventory, reports, statements, or approval forms need to be generated directly from Java objects or Maps.

Capability Boundaries

✅ Strengths

Simplest write methods (JDK8+ style, traditional style, and Builder style)
Complex headers (multi-level headers such as
```
@ExcelProperty({"主标题", "副标题"})
```
)

Selective column export (

includeColumnFiledNames

/

excludeColumnFiledNames

)

Annotation-based formatting (

@ColumnWidth

,

@ContentRowHeight

,

@DateTimeFormat

,

@NumberFormat

)

Custom styles (annotation-based, interceptor-based, and
```
HorizontalCellStyleStrategy
```
)
Merged cells (
```
@ContentLoopMerge
```
/
```
LoopMergeStrategy
```
)
Image export from multiple sources (File/InputStream/URL/byte[])
Hyperlinks, comments, formulas, and rich text (the
```
WriteCellData
```
system)
Dynamic headers (determined at runtime)
Multiple writes, multiple Sheets, and multiple Tables
Direct web output to
```
HttpServletResponse
```

⚠️ Limitations

It is recommended to write fewer than 5,000 rows at once per Sheet; use batches for large datasets
A maximum of 60,000 style objects can be created; otherwise, the Excel file cannot be opened
Images remain in memory; upload oversized images to OSS
Comments require
```
inMemory(true)
```
For 03-version (
```
.xls
```
) compatibility, use
```
excelType(ExcelTypeEnum.XLS)
```

❌ Out of Scope (scenarios where this skill should not be used; use another skill instead)

Filling predefined templates → Not applicable to this skill; use
```
easyexcel-fill
```
Reading Excel data → Not applicable to this skill; use
```
easyexcel-read
```
CSV file processing → Not applicable to this skill; use commons-csv / OpenCSV directly
Word/PPT → Not applicable to this skill; use Apache POI / Apache POI-XML

Data Privacy

This skill does not collect, store, or transmit any user data. All code examples are provided solely as local development references.

When to use this skill

The user asks to "export Excel", "generate Excel", "download Excel", or "export orders/users/financial records/inventory"
There is no predefined template, and structured Excel data must be generated programmatically
The business requires multiple Sheets (such as by month, status, or type), multiple Tables (multiple table blocks), or similar layouts
Images, hyperlinks, formulas, rich text, or merged cells need to be exported

Quick Start

Typical invocation methods (3 approaches):

java

// 写法 1：JDK8+ 用 Supplier（since 3.0.0-beta1，最简洁）
EasyExcel.write(fileName, DemoData.class)
    .sheet("模板")
    .doWrite(() -> data());

// 写法 2：传统 + 已有 List
List<DemoData> data = data();
EasyExcel.write(fileName, DemoData.class)
    .sheet("模板")
    .doWrite(data);

// 写法 3：Builder（多次写入 / 复杂配置）
try (ExcelWriter excelWriter = EasyExcel.write(fileName, DemoData.class).build()) {
    WriteSheet writeSheet = EasyExcel.writerSheet("模板").build();
    excelWriter.write(data(), writeSheet);
}

Official text: "A data volume of 5,000 or fewer is recommended" (the recommended one-time write limit per Sheet).

Workflow

Step 1. Define the data model — Write a DTO/VO and apply annotations such as

@ExcelProperty

Step 2. Choose a writing method — Single

doWrite()

/ multiple

excelWriter.write()

calls / repeated

doWrite()

loops Step 3. Configure the Builder — Include column selection, headers, styles, interceptor registration, and other settings Step 4. Prepare the data — Construct

List<DTO>

/

List<List<String>>

Step 5. Perform the write — Use try-with-resources to close the

ExcelWriter

Step 6. Validate the output — Open the generated

.xlsx

file and inspect the headers, styles, formatting, and merged cells

Critical: Annotation Quick Reference

Annotation	Purpose	Key attributes
`@ExcelProperty`	Specifies the column name, index, or converter	`value` , `index` , `order` , `converter`
`@ExcelIgnore`	Ignores the field	—
`@ExcelIgnoreUnannotated`	Class-level: excludes unannotated fields from reading and writing	—
`@DateTimeFormat`	Date format	`value` , `use1904windowing`
`@NumberFormat`	Number format	`value` , `roundingMode`
`@ColumnWidth`	Column width	`value`
`@HeadRowHeight`	Header row height	`value`
`@ContentRowHeight`	Content row height	`value`
`@HeadStyle`	Header style (POI-style)	fillPatternType, fillForegroundColor, font, etc.
`@HeadFontStyle`	Header font	fontHeightInPoints, color, bold, etc.
`@ContentStyle`	Content style	Same as HeadStyle
`@ContentFontStyle`	Content font	Same as HeadFontStyle
`@ContentLoopMerge`	Loop merge	`eachRow`
`@OnceAbsoluteMerge`	One-time absolute merge	`firstRowIndex` , `lastRowIndex` , etc.

Official text:
order
defaults to
Integer.MAX_VALUE
; priority:
index
>
order
>
value
. Official text: "It is not recommended to use index and name together; use either index alone or name matching alone."

Reference Library (load as needed)

Detailed code and comments have been split into

references/

. Load them according to the scenario:

API & Basic Patterns

references/api/3-write-modes.md — 3 basic writing modes (simplest / selected columns / multiple writes)
references/api/key-classes.md — Key Classes / Methods quick reference

Patterns (headers / styles / merging / images / rich text / web / advanced / big data)

references/patterns/header-format-style.md — Complex headers / custom styles (annotations + interceptors)
references/scenarios/merge-cell.md — Merged cells
references/scenarios/image-export.md — Image export (multiple sources + multiple embedded images)
references/scenarios/hyperlink-comment-formula-richtext.md — Hyperlinks / comments / formulas / rich text
references/scenarios/web-download.md — Web download (including JSON fallback on failure)
references/scenarios/advanced.md — Dynamic headers / automatic column widths / custom interceptors / 03-version compatibility
references/scenarios/million-row.md — Batched writing for millions of rows

Troubleshooting

references/troubleshooting/gotchas.md — 12 common errors and correct practices

References

Official documentation: https://easyexcel.opensource.alibaba.com/docs/current/quickstart/write
Official examples: https://github.com/alibaba/easyexcel/blob/master/easyexcel-test/src/test/java/com/alibaba/easyexcel/test/demo/write/WriteTest.java
Project homepage: https://easyexcel.opensource.alibaba.com/
GitHub: https://github.com/alibaba/easyexcel
API reference: https://easyexcel.opensource.alibaba.com/docs/current/api/