easyexcel 使用说明

旧城等待， 2023-03-01 06:07 252阅读 0赞

easyexcel 使用说明

********************

导入 jar 包

  1. <dependency>
  2.     <groupId>com.alibaba</groupId>
  3.     <artifactId>easyexcel</artifactId>
  4.     <version>2.2.6</version>
  5. </dependency>

********************

相关类与接口

EasyExcel

  1. public class EasyExcel extends EasyExcelFactory {
  2.     public EasyExcel() {
  3.     }
  4. }

EasyExcelFactory

  1. public class EasyExcelFactory {
  3. ************
  4. 构造函数
  6.     public EasyExcelFactory() {
  7.     }
  10. ************
  11. write 方法
  13.     public static ExcelWriterBuilder write() {
  14.     public static ExcelWriterBuilder write(File file) {
  15.     public static ExcelWriterBuilder write(File file, Class head) {
  17.     public static ExcelWriterBuilder write(String pathName) {
  18.     public static ExcelWriterBuilder write(String pathName, Class head) {
  20.     public static ExcelWriterBuilder write(OutputStream outputStream) {
  21.     public static ExcelWriterBuilder write(OutputStream outputStream, Class head) {
  24.     public static ExcelWriterSheetBuilder writerSheet() {
  25.     public static ExcelWriterSheetBuilder writerSheet(Integer sheetNo) {
  26.     public static ExcelWriterSheetBuilder writerSheet(String sheetName) {
  27.     public static ExcelWriterSheetBuilder writerSheet(Integer sheetNo, String sheetName) {
  30.     public static ExcelWriterTableBuilder writerTable() {
  31.     public static ExcelWriterTableBuilder writerTable(Integer tableNo) {
  32.                                           //使用table写入
  35. ************
  36. read 读取
  38.     public static ExcelReaderBuilder read() {
  39.     public static ExcelReaderBuilder read(File file) {
  40.     public static ExcelReaderBuilder read(File file, ReadListener readListener) {
  41.     public static ExcelReaderBuilder read(File file, Class head, ReadListener readListener) {
  43.     public static ExcelReaderBuilder read(String pathName) {
  44.     public static ExcelReaderBuilder read(String pathName, ReadListener readListener) {
  45.     public static ExcelReaderBuilder read(String pathName, Class head, ReadListener readListener) {
  47.     public static ExcelReaderBuilder read(InputStream inputStream) {
  48.     public static ExcelReaderBuilder read(InputStream inputStream, ReadListener readListener) {
  49.     public static ExcelReaderBuilder read(InputStream inputStream, Class head, ReadListener readListener) {
  52.     public static ExcelReaderSheetBuilder readSheet() {
  53.     public static ExcelReaderSheetBuilder readSheet(Integer sheetNo) {
  54.     public static ExcelReaderSheetBuilder readSheet(String sheetName) {
  55.     public static ExcelReaderSheetBuilder readSheet(Integer sheetNo, String sheetName) {

*****************

write 操作

ExcelWriterBuilder

  1. public class ExcelWriterBuilder extends AbstractExcelWriterParameterBuilder<ExcelWriterBuilder, WriteWorkbook> {
  2.     private WriteWorkbook writeWorkbook = new WriteWorkbook();
  4. ********
  5. 构造函数
  7.     public ExcelWriterBuilder() {
  8.     }
  11. ********
  12. 普通方法
  14.     public ExcelWriterBuilder file(OutputStream outputStream) {
  15.     public ExcelWriterBuilder file(File outputFile) {
  16.     public ExcelWriterBuilder file(String outputPathName) {
  18.     public ExcelWriterBuilder withTemplate(InputStream templateInputStream) {
  19.     public ExcelWriterBuilder withTemplate(File templateFile) {
  20.     public ExcelWriterBuilder withTemplate(String pathName) {
  22.     public ExcelWriterSheetBuilder sheet() {
  23.     public ExcelWriterSheetBuilder sheet(Integer sheetNo) {
  24.     public ExcelWriterSheetBuilder sheet(String sheetName) {
  25.     public ExcelWriterSheetBuilder sheet(Integer sheetNo, String sheetName) {
  28.     public ExcelWriterBuilder autoCloseStream(Boolean autoCloseStream) {
  29.     public ExcelWriterBuilder password(String password) {
  30.     public ExcelWriterBuilder inMemory(Boolean inMemory) {
  31.     public ExcelWriterBuilder writeExcelOnException(Boolean writeExcelOnException) {
  32.     public ExcelWriterBuilder excelType(ExcelTypeEnum excelType) {
  34.     public ExcelWriter build() {
  35.     protected WriteWorkbook parameter() {

AbstractExcelWriterParameterBuilder

  1. public abstract class AbstractExcelWriterParameterBuilder<T extends AbstractExcelWriterParameterBuilder, C extends WriteBasicParameter> extends AbstractParameterBuilder<T, C> {
  2.     public AbstractExcelWriterParameterBuilder() {
  3.     }
  5.     public T excludeColumnIndexes(Collection<Integer> excludeColumnIndexes) {
  6.     public T excludeColumnFiledNames(Collection<String> excludeColumnFiledNames) {
  7.                                     //不输出的列
  9.     public T includeColumnIndexes(Collection<Integer> includeColumnIndexes) {
  10.     public T includeColumnFiledNames(Collection<String> includeColumnFiledNames) {
  11.                                     //输出的列
  14.     public T relativeHeadRowIndex(Integer relativeHeadRowIndex) {
  15.     public T needHead(Boolean needHead) {
  16.     public T registerWriteHandler(WriteHandler writeHandler) {
  17.     public T useDefaultStyle(Boolean useDefaultStyle) {
  18.     public T automaticMergeHead(Boolean automaticMergeHead) {

AbstractParameterBuilder

  1. public abstract class AbstractParameterBuilder<T extends AbstractParameterBuilder, C extends BasicParameter> {
  2.     public AbstractParameterBuilder() {
  3.     }
  5.     public T head(List<List<String>> head) {
  6.     public T head(Class clazz) {            //设置head
  8.     public T registerConverter(Converter converter) {     //注册转换器
  9.     public T use1904windowing(Boolean use1904windowing) {
  11.     public T locale(Locale locale) {
  12.     public T autoTrim(Boolean autoTrim) {
  14.     protected T self() {
  15.     protected abstract C parameter();

ExcelWriterSheetBuilder

  1. public class ExcelWriterSheetBuilder extends AbstractExcelWriterParameterBuilder<ExcelWriterSheetBuilder, WriteSheet> {
  2.     private ExcelWriter excelWriter;
  3.     private WriteSheet writeSheet = new WriteSheet();
  5. *********
  6. 构造函数
  8.     public ExcelWriterSheetBuilder() {
  9.     public ExcelWriterSheetBuilder(ExcelWriter excelWriter) {
  12. *********
  13. 普通方法
  15.     public WriteSheet build() {
  17.     public void doWrite(List data) {
  19.     public void doFill(Object data) {
  20.     public void doFill(Object data, FillConfig fillConfig) {
  22.     public ExcelWriterSheetBuilder sheetNo(Integer sheetNo) {       //写入表单的序列号
  23.     public ExcelWriterSheetBuilder sheetName(String sheetName) {    //写入表单的名称
  25.     public ExcelWriterTableBuilder table() {
  26.     public ExcelWriterTableBuilder table(Integer tableNo) {
  28.     protected WriteSheet parameter() {

ExcelWriterTableBuilder：使用table写入

  1. public class ExcelWriterTableBuilder extends AbstractExcelWriterParameterBuilder<ExcelWriterTableBuilder, WriteTable> {
  2.     private ExcelWriter excelWriter;
  3.     private WriteSheet writeSheet;
  4.     private WriteTable writeTable;
  6.     public ExcelWriterTableBuilder() {
  7.         this.writeTable = new WriteTable();
  8.     }
  10.     public ExcelWriterTableBuilder(ExcelWriter excelWriter, WriteSheet writeSheet) {
  11.         this.excelWriter = excelWriter;
  12.         this.writeSheet = writeSheet;
  13.         this.writeTable = new WriteTable();
  14.     }
  16.     public ExcelWriterTableBuilder tableNo(Integer tableNo) {
  17.         this.writeTable.setTableNo(tableNo);
  18.         return this;
  19.     }
  21.     public WriteTable build() {
  22.         return this.writeTable;
  23.     }
  25.     public void doWrite(List data) {
  26.         if (this.excelWriter == null) {
  27.             throw new ExcelGenerateException("Must use 'EasyExcelFactory.write().sheet().table()' to call this method");
  28.         } else {
  29.             this.excelWriter.write(data, this.writeSheet, this.build());
  30.             this.excelWriter.finish();
  31.         }
  32.     }
  34.     protected WriteTable parameter() {
  35.         return this.writeTable;
  36.     }
  37. }

ExcelWriter

  1. public class ExcelWriter {
  2.     private static final Logger LOGGER = LoggerFactory.getLogger(ExcelWriter.class);
  3.     private ExcelBuilder excelBuilder;
  5.     public ExcelWriter(WriteWorkbook writeWorkbook) {
  7.     public ExcelWriter write(List data, WriteSheet writeSheet) {
  8.     public ExcelWriter write(List data, WriteSheet writeSheet, WriteTable writeTable) {
  10.     public ExcelWriter fill(Object data, WriteSheet writeSheet) {
  11.     public ExcelWriter fill(Object data, FillConfig fillConfig, WriteSheet writeSheet) {
  13.     public void finish() {
  14.     public WriteContext writeContext() {
  16.     protected void finalize() {

WriteSheet

  1. public class WriteSheet extends WriteBasicParameter {
  2.     private Integer sheetNo;
  3.     private String sheetName;
  5.     public WriteSheet() {
  6.     }
  8.     public void setSheetNo(Integer sheetNo) {
  9.     public void setSheetName(String sheetName) {
  10.     public void setColumnWidthMap(Map<Integer, Integer> columnWidthMap) {
  11.     public void setTableStyle(TableStyle tableStyle) {
  13.     public Integer getSheetNo() {
  14.     public String getSheetName() {
  15.     public TableStyle getTableStyle() {
  16.     public Map<Integer, Integer> getColumnWidthMap() {
  18.     public String toString() {

WriteTable

  1. public class WriteTable extends WriteBasicParameter {
  2.     private Integer tableNo;
  4.     public WriteTable() {
  5.     }
  7.     public Integer getTableNo() {
  8.         return this.tableNo;
  9.     }
  11.     public void setTableNo(Integer tableNo) {
  12.         this.tableNo = tableNo;
  13.     }
  15.     public TableStyle getTableStyle() {
  16.         return this.tableStyle;
  17.     }
  19.     public void setTableStyle(TableStyle tableStyle) {
  20.         this.tableStyle = tableStyle;
  21.     }
  22. }

WriteBasicParameter

  1. public class WriteBasicParameter extends BasicParameter {
  2.     private Integer relativeHeadRowIndex;
  3.     private Boolean needHead;
  4.     private List<WriteHandler> customWriteHandlerList = new ArrayList();
  5.     private Boolean useDefaultStyle;
  6.     private Boolean automaticMergeHead;
  7.     private Collection<Integer> excludeColumnIndexes;
  8.     private Collection<String> excludeColumnFiledNames;
  9.     private Collection<Integer> includeColumnIndexes;
  10.     private Collection<String> includeColumnFiledNames;
  12.     public WriteBasicParameter() {
  13.     }
  16.     public void setExcludeColumnIndexes(Collection<Integer> excludeColumnIndexes) {
  17.     public void setExcludeColumnFiledNames(Collection<String> excludeColumnFiledNames) {
  19.     public Collection<Integer> getExcludeColumnIndexes() {
  20.     public Collection<String> getExcludeColumnFiledNames() {
  23.     public void setIncludeColumnIndexes(Collection<Integer> includeColumnIndexes) {
  24.     public void setIncludeColumnFiledNames(Collection<String> includeColumnFiledNames) {
  26.     public Collection<Integer> getIncludeColumnIndexes() { 
  27.     public Collection<String> getIncludeColumnFiledNames() {
  30.     public void setNeedHead(Boolean needHead) {
  31.     public void setUseDefaultStyle(Boolean useDefaultStyle) {
  32.     public void setAutomaticMergeHead(Boolean automaticMergeHead) {
  33.     public void setRelativeHeadRowIndex(Integer relativeHeadRowIndex) {
  34.     public void setCustomWriteHandlerList(List<WriteHandler> customWriteHandlerList) {
  36.     public Boolean getNeedHead() {
  37.     public Boolean getUseDefaultStyle() {
  38.     public Boolean getAutomaticMergeHead() {
  39.     public Integer getRelativeHeadRowIndex() {
  40.     public List<WriteHandler> getCustomWriteHandlerList() {

BasicParameter

  1. public class BasicParameter {
  2.     private List<List<String>> head;
  3.     private Class clazz;
  4.     private List<Converter> customConverterList;
  5.     private Boolean autoTrim;
  6.     private Boolean use1904windowing;
  7.     private Locale locale;
  8.     private Boolean useScientificFormat;
  10.     public BasicParameter() {
  11.     }
  13.     public void setClazz(Class clazz) {
  14.     public void setHead(List<List<String>> head) {
  16.     public Class getClazz() {
  17.     public List<List<String>> getHead() {
  19.     public List<Converter> getCustomConverterList() {
  20.     public void setCustomConverterList(List<Converter> customConverterList) {
  23.     public void setLocale(Locale locale) {
  24.     public void setAutoTrim(Boolean autoTrim) {
  25.     public void setUse1904windowing(Boolean use1904windowing) {
  26.     public void setUseScientificFormat(Boolean useScientificFormat) {
  28.     public Locale getLocale() {
  29.     public Boolean getAutoTrim() {
  30.     public Boolean getUse1904windowing() {
  31.     public Boolean getUseScientificFormat() {

*****************

read 操作

ExcelReaderBuilder

  1. public class ExcelReaderBuilder extends AbstractExcelReaderParameterBuilder<ExcelReaderBuilder, ReadWorkbook> {
  2.     private ReadWorkbook readWorkbook = new ReadWorkbook();
  4.     public ExcelReaderBuilder() {
  5.     }
  8.     public ExcelReaderBuilder file(InputStream inputStream) {
  9.     public ExcelReaderBuilder file(File file) {
  10.     public ExcelReaderBuilder file(String pathName) {
  12.     public ExcelReaderSheetBuilder sheet() {
  13.     public ExcelReaderSheetBuilder sheet(Integer sheetNo) {
  14.     public ExcelReaderSheetBuilder sheet(String sheetName) {
  15.     public ExcelReaderSheetBuilder sheet(Integer sheetNo, String sheetName) {
  17.     public void doReadAll() {
  18.     public <T> List<T> doReadAllSync() {
  21.     public ExcelReaderBuilder excelType(ExcelTypeEnum excelType) {
  22.     public ExcelReaderBuilder mandatoryUseInputStream(Boolean mandatoryUseInputStream) {
  23.     public ExcelReaderBuilder autoCloseStream(Boolean autoCloseStream) {
  24.     public ExcelReaderBuilder ignoreEmptyRow(Boolean ignoreEmptyRow) {
  25.     public ExcelReaderBuilder customObject(Object customObject) {
  26.     public ExcelReaderBuilder readCache(ReadCache readCache) {
  27.     public ExcelReaderBuilder readCacheSelector(ReadCacheSelector readCacheSelector) {
  28.     public ExcelReaderBuilder password(String password) {
  29.     public ExcelReaderBuilder xlsxSAXParserFactoryName(String xlsxSAXParserFactoryName) {
  30.     public ExcelReaderBuilder extraRead(CellExtraTypeEnum extraType) {
  31.     public ExcelReaderBuilder useDefaultListener(Boolean useDefaultListener) {
  33.     public ExcelReader build() {
  36.     protected ReadWorkbook parameter() {

ExcelReaderSheetBuilder

  1. public class ExcelReaderSheetBuilder extends AbstractExcelReaderParameterBuilder<ExcelReaderSheetBuilder, ReadSheet> {
  2.     private ExcelReader excelReader;
  3.     private ReadSheet readSheet = new ReadSheet();
  5.     public ExcelReaderSheetBuilder() {
  6.     public ExcelReaderSheetBuilder(ExcelReader excelReader) {
  8.     public ExcelReaderSheetBuilder sheetNo(Integer sheetNo) {
  9.     public ExcelReaderSheetBuilder sheetName(String sheetName) {
  11.     public ReadSheet build() {
  13.     public void doRead() {
  14.     public <T> List<T> doReadSync() {
  16.     protected ReadSheet parameter() {

AbstractExcelReaderParameterBuilder

  1. public abstract class AbstractExcelReaderParameterBuilder<T extends AbstractExcelReaderParameterBuilder, C extends ReadBasicParameter> extends AbstractParameterBuilder<T, C> {
  2.     public AbstractExcelReaderParameterBuilder() {
  3.     }
  5.     public T headRowNumber(Integer headRowNumber) {
  6.     public T useScientificFormat(Boolean useScientificFormat) {
  8.     public T registerReadListener(ReadListener readListener) {

AnalysisEventListener：监听器

  1. public abstract class AnalysisEventListener<T> implements ReadListener<T> {
  2.     public AnalysisEventListener() {
  3.     }
  5.     public void invokeHead(Map<Integer, CellData> headMap, AnalysisContext context) {
  6.         this.invokeHeadMap(ConverterUtils.convertToStringMap(headMap, context), context);
  7.     }
  9.     public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
  10.     }
  12.     public void extra(CellExtra extra, AnalysisContext context) {
  13.     }
  15.     public void onException(Exception exception, AnalysisContext context) throws Exception {
  16.         throw exception;
  17.     }
  19.     public boolean hasNext(AnalysisContext context) {
  20.         return true;
  21.     }
  22. }

ReadListener

  1. public interface ReadListener<T> extends Listener {
  3.     void invoke(T var1, AnalysisContext var2);
  4.     void invokeHead(Map<Integer, CellData> var1, AnalysisContext var2);
  6.     boolean hasNext(AnalysisContext var1);
  7.     void doAfterAllAnalysed(AnalysisContext var1);
  8.     void extra(CellExtra var1, AnalysisContext var2);
  9.     void onException(Exception var1, AnalysisContext var2) throws Exception;
  10. }

Listener

  1. public interface Listener {
  2. }

ExcelReader

  1. public class ExcelReader {
  2.     private static final Logger LOGGER = LoggerFactory.getLogger(ExcelReader.class);
  3.     private ExcelAnalyser excelAnalyser;
  5.     public ExcelReader(ReadWorkbook readWorkbook) {
  7.     public void readAll() {
  8.     public ExcelReader read(ReadSheet... readSheet) {
  9.     public ExcelReader read(List<ReadSheet> readSheetList) {
  12.     public AnalysisContext analysisContext() {
  13.     public ExcelReadExecutor excelExecutor() {
  15.     public void finish() {
  16.     protected void finalize() {

ReadSheet

  1. public class ReadSheet extends ReadBasicParameter {
  2.     private Integer sheetNo;
  3.     private String sheetName;
  5.     public ReadSheet() {
  6.     public ReadSheet(Integer sheetNo) {
  7.     public ReadSheet(Integer sheetNo, String sheetName) {
  10.     public void setSheetNo(Integer sheetNo) {
  11.     public void setSheetName(String sheetName) {
  13.     public Integer getSheetNo() {
  14.     public String getSheetName() {
  16.     public void copyBasicParameter(ReadSheet other) {
  17.     public String toString() {

ReadBasicParameter

  1. public class ReadBasicParameter extends BasicParameter {
  2.     private Integer headRowNumber;
  3.     private List<ReadListener> customReadListenerList = new ArrayList();
  5.     public ReadBasicParameter() {
  6.     }
  8.     public void setHeadRowNumber(Integer headRowNumber) {
  9.     public void setCustomReadListenerList(List<ReadListener> customReadListenerList) {
  11.     public Integer getHeadRowNumber() {
  12.     public List<ReadListener> getCustomReadListenerList() {

********************

相关注解

  1.                 ![20200723171147101.png][]

*****************

format

@DateTimeFormat：标注在字段上，日期格式化

  1. @Target({ElementType.FIELD})
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Inherited
  4. public @interface DateTimeFormat {
  5.     String value() default "";
  7.     boolean use1904windowing() default false;
  8. }

@NumberFormat：标注在字段上，数字格式化

  1. @Target({ElementType.FIELD})
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Inherited
  4. public @interface NumberFormat {
  5.     String value() default "";
  7.     RoundingMode roundingMode() default RoundingMode.HALF_UP;
  8. }

*****************

write.style：输出样式注解

ColumnWidth：标注在类、字段上，设置列宽

  1. @Target({ElementType.FIELD, ElementType.TYPE})
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Inherited
  4. public @interface ColumnWidth {
  5.     int value() default -1;
  6. }

HeadRowHeight：标注在类上，设置表头高度

  1. @Target({ElementType.TYPE})
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Inherited
  4. public @interface HeadRowHeight {
  5.     short value() default -1;
  6. }

ContentRowHeight：标注在类上，设置内容列表高度

  1. @Target({ElementType.TYPE})
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Inherited
  4. public @interface ContentRowHeight {
  5.     short value() default -1;
  6. }

*****************

其余注解

ExcelIgnore：标注在字段上，不输出

  1. @Target({ElementType.FIELD})
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Inherited
  4. public @interface ExcelIgnore {
  5. }

ExcelIgnoreUnannotated：标注在类上，忽略没有注释的字段

  1. @Target({ElementType.TYPE})
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Inherited
  4. public @interface ExcelIgnoreUnannotated {
  5. }

ExcelProperty：标注在字段上，设置顺序，名称，列索引

  1. @Target({ElementType.FIELD})
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Inherited
  4. public @interface ExcelProperty {
  5.     String[] value() default {""};
  7.     int index() default -1;
  9.     int order() default 2147483647;
  11.     Class<? extends Converter> converter() default AutoConverter.class;
  12. }

发表评论

表情：
评论列表 （有 0 条评论，252人围观）

还没有评论，来说两句吧...

相关阅读

    相关 EasyExcel如何使用

    EasyExcel是一个Java库，用于读写Excel文件。要使用EasyExcel，您需要在项目中添加依赖并导入必要的类。 依赖信息： <dependency>

    傷城~傷城~/ 0 赞/ 122 阅读

    相关 EasyExcel的简单使用

    简介 读取execl文件中的内容添加数据，阿里巴巴提供的一个处理excel的工具 读取方式：一行一行读取加载到内存中，保证效率 excel写 ①引入依赖（注意

    Bertha 。Bertha 。/ 0 赞/ 179 阅读

    相关 EasyExcel使用+踩雷

    1.导出的excel,点击数字类型格子里,数据会变科学计数法,并且丢位 这个问题后续会修复 超过一定长度的整型数据有问题。自己要解决 就用string去传入 2.[http

    谁践踏了优雅谁践踏了优雅/ 0 赞/ 267 阅读

    相关 EasyExcel 使用记录

    使用的是阿里的 EasyExcel ，在读的时候出现NPE错误，追究一下 使用 EasyExcel 写excel的时候 api 非常简单好用，而在读的时候却发现有一些bu

    野性酷女野性酷女/ 0 赞/ 376 阅读