Easy Excel——API

淡淡的烟草味﹌ 2023-10-16 13:38 74阅读 0赞

#### 目录 ####

*  Easy Excel API
 *   *  注解
     *   *  ExcelProperty
         *  ExcelIgnore
         *  ExcelIgnoreUnannotated
         *  DateTimeFormat
         *  NumberFormat
     *  参数
     *   *  概念介绍
         *  通用参数
         *  ReadWorkbook
         *  ReadSheet

## Easy Excel API ##

### 注解 ###

#### ExcelProperty ####

用于匹配excel和实体类的匹配,参数如下：

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>空</td> 
   <td>用于匹配excel中的头，必须全匹配,如果有多行头，会匹配最后一行头</td> 
  </tr> 
  <tr> 
   <td>order</td> 
   <td>Integer.MAX_VALUE</td> 
   <td>优先级高于<code>value</code>，会根据<code>order</code>的顺序来匹配实体和excel中数据的顺序</td> 
  </tr> 
  <tr> 
   <td>index</td> 
   <td>-1</td> 
   <td>优先级高于<code>value</code>和<code>order</code>，会根据<code>index</code>直接指定到excel中具体的哪一列</td> 
  </tr> 
  <tr> 
   <td>converter</td> 
   <td>自动选择</td> 
   <td>指定当前字段用什么转换器，默认会自动选择。读的情况下只要实现<code>com.alibaba.excel.converters.Converter#convertToJavaData(com.alibaba.excel.converters.ReadConverterContext&lt;?&gt;)</code> 方法即可</td> 
  </tr> 
 </tbody> 
</table>

#### ExcelIgnore ####

默认所有字段都会和excel去匹配，加了这个注解会忽略该字段

#### ExcelIgnoreUnannotated ####

默认不加ExcelProperty 的注解的都会参与读写，加了不会参与读写

#### DateTimeFormat ####

日期转换，用String去接收excel日期格式的数据会调用这个注解,参数如下：

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>空</td> 
   <td>参照<code>java.text.SimpleDateFormat</code>书写即可</td> 
  </tr> 
  <tr> 
   <td>use1904windowing</td> 
   <td>自动选择</td> 
   <td>excel中时间是存储1900年起的一个双精度浮点数，但是有时候默认开始日期是1904，所以设置这个值改成默认1904年开始</td> 
  </tr> 
 </tbody> 
</table>

#### NumberFormat ####

数字转换，用String去接收excel数字格式的数据会调用这个注解。

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>空</td> 
   <td>参照<code>java.text.DecimalFormat</code>书写即可</td> 
  </tr> 
  <tr> 
   <td>roundingMode</td> 
   <td>RoundingMode.HALF_UP</td> 
   <td>格式化的时候设置舍入模式</td> 
  </tr> 
 </tbody> 
</table>

### 参数 ###

#### 概念介绍 ####

*  ReadWorkbook 可以理解成一个excel
 *  ReadSheet 理解成一个excel里面的一个表单

#### 通用参数 ####

ReadWorkbook,ReadSheet 都会有的参数，如果为空，默认使用上级。

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>converter</td> 
   <td>空</td> 
   <td>默认加载了很多转换器，这里可以加入不支持的字段</td> 
  </tr> 
  <tr> 
   <td>readListener</td> 
   <td>空</td> 
   <td>可以注册多个监听器，读取excel的时候会不断的回调监听器中的方法</td> 
  </tr> 
  <tr> 
   <td>headRowNumber</td> 
   <td>1</td> 
   <td>excel中头的行数，默认1行</td> 
  </tr> 
  <tr> 
   <td>head</td> 
   <td>空</td> 
   <td>与<code>clazz</code>二选一。读取文件头对应的列表，会根据列表匹配数据，建议使用class</td> 
  </tr> 
  <tr> 
   <td>clazz</td> 
   <td>空</td> 
   <td>与<code>head</code>二选一。读取文件的头对应的class，也可以使用注解。如果两个都不指定，则会读取全部数据</td> 
  </tr> 
  <tr> 
   <td>autoTrim</td> 
   <td>true</td> 
   <td>会对头、读取数据等进行自动trim</td> 
  </tr> 
  <tr> 
   <td>use1904windowing</td> 
   <td>false</td> 
   <td>excel中时间是存储1900年起的一个双精度浮点数，但是有时候默认开始日期是1904，所以设置这个值改成默认1904年开始</td> 
  </tr> 
  <tr> 
   <td>useScientificFormat</td> 
   <td>false</td> 
   <td>数字转文本的时候在较大的数值的是否是否采用科学计数法</td> 
  </tr> 
 </tbody> 
</table>

#### ReadWorkbook ####

EasyExcel.read(fileName, DemoData.class, new DemoDataListener())
     // 在 read 方法之后， 在 sheet方法之前都是设置ReadWorkbook的参数
     .sheet()
     .doRead();

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>excelType</td> 
   <td>空</td> 
   <td>当前excel的类型,支持XLS、XLSX、CSV</td> 
  </tr> 
  <tr> 
   <td>inputStream</td> 
   <td>空</td> 
   <td>与<code>file</code>二选一。读取文件的流，如果接收到的是流就只用，不用流建议使用<code>file</code>参数。因为使用了<code>inputStream</code> easyexcel会帮忙创建临时文件，最终还是<code>file</code></td> 
  </tr> 
  <tr> 
   <td>file</td> 
   <td>空</td> 
   <td>与<code>inputStream</code>二选一。读取文件的文件。</td> 
  </tr> 
  <tr> 
   <td>mandatoryUseInputStream</td> 
   <td>false</td> 
   <td>强制使用 <code>inputStream</code> 来创建对象，性能会变差，但是不会创建临文件。</td> 
  </tr> 
  <tr> 
   <td>charset</td> 
   <td>Charset#defaultCharset</td> 
   <td>只有csv文件有用，读取文件的时候使用的编码</td> 
  </tr> 
  <tr> 
   <td>autoCloseStream</td> 
   <td>true</td> 
   <td>自动关闭读取的流。</td> 
  </tr> 
  <tr> 
   <td>readCache</td> 
   <td>空</td> 
   <td>默认小于5M用 内存，超过5M会使用 <code>EhCache</code>,这里不建议使用这个参数。</td> 
  </tr> 
  <tr> 
   <td>readCacheSelector</td> 
   <td>SimpleReadCacheSelector</td> 
   <td>用于选择什么时候用内存去存储临时数据，什么时候用磁盘存储临时数据</td> 
  </tr> 
  <tr> 
   <td>ignoreEmptyRow</td> 
   <td>true</td> 
   <td>忽略空的行</td> 
  </tr> 
  <tr> 
   <td>password</td> 
   <td>空</td> 
   <td>读取文件的密码</td> 
  </tr> 
  <tr> 
   <td>xlsxSAXParserFactoryName</td> 
   <td>空</td> 
   <td>指定sax读取使用的class的名称，例如：<code>com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl</code></td> 
  </tr> 
  <tr> 
   <td>useDefaultListener</td> 
   <td>true</td> 
   <td><code>@since 2.1.4</code> <br>默认会加入<code>ModelBuildEventListener</code> 来帮忙转换成传入<code>class</code>的对象，设置成<code>false</code>后将不会协助转换对象，自定义的监听器会接收到<code>Map&lt;Integer,CellData&gt;</code>对象，如果还想继续接听到<code>class</code>对象，请调用<code>readListener</code>方法，加入自定义的<code>beforeListener</code>、 <code>ModelBuildEventListener</code>、 自定义的<code>afterListener</code>即可。</td> 
  </tr> 
  <tr> 
   <td>extraReadSet</td> 
   <td>空</td> 
   <td>额外需要读取内容的set，默认不读取这些数据</td> 
  </tr> 
  <tr> 
   <td>readDefaultReturn</td> 
   <td>STRING</td> 
   <td><code>@since 3.2.0</code><br>STRING:会返回一个Map&lt;Integer,String&gt;的数组，返回值就是你在excel里面不点击单元格看到的内容<br> ACTUAL_DATA：会返回一个Map&lt;Integer,Object&gt;的数组，返回实际上存储的数据，会帮自动转换类型，Object类型为<code>BigDecimal</code>、<code>Boolean</code>、<code>String</code>、<code>LocalDateTime</code>、null，中的一个，<br>READ_CELL_DATA: 会返回一个Map&lt;Integer,ReadCellData&lt;?&gt;&gt;的数组,其中<code>?</code>类型参照ACTUAL_DATA的</td> 
  </tr> 
 </tbody> 
</table>

#### ReadSheet ####

EasyExcel.read(fileName, DemoData.class, new DemoDataListener())
     .sheet()
      // 在 sheet 方法之后， 在 doRead方法之前都是设置ReadSheet的参数
     .doRead();

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>默认值</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>sheetNo</td> 
   <td>0</td> 
   <td>需要读取Sheet的编码，建议使用这个来指定读取哪个Sheet</td> 
  </tr> 
  <tr> 
   <td>sheetName</td> 
   <td>空</td> 
   <td>根据名字去匹配Sheet</td> 
  </tr> 
 </tbody> 
</table>