对EasyExcel的常用注解的详细介绍

待我称王封你为后i 2023-09-28 23:24 75阅读 0赞

通过下表简单介绍一些使用过的注解，内容并不全面

<table> 
 <tbody> 
 <tr> 
 <td style="width:204px;"> 注解 </td> 
 <td style="width:645px;"> 说明 </td> 
 </tr> 
 <tr> 
 <td style="width:204px;">@ColumnWidth(15)</td> 
 <td style="width:645px;">控制行的宽度，用在class上代表所有单元格的宽度，用在属性上代表当前列的宽度</td> 
 </tr> 
 <tr> 
 <td style="width:204px;">@ContentRowHeight(25)</td> 
 <td style="width:645px;">控制内容的高度，用在class上代表所有单元格的宽度，用在属性上代表当前列的宽度</td> 
 </tr> 
 <tr> 
 <td style="width:204px;">@HeadRowHeight(20)</td> 
 <td style="width:645px;">控制标题的高度</td> 
 </tr> 
 <tr> 
 <td style="width:204px;">@ExcelIgnore</td> 
 <td style="width:645px;">导出时忽略该属性，默认是导出全部的属性，无论属性上写没写@ExcelProperty</td> 
 </tr> 
 <tr> 
 <td style="width:204px;">@ExcelIgnoreUnannotated</td> 
 <td style="width:645px;">在类上使用该注解，忽略所有未添加@ExcelProperty的属性</td> 
 </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
 <tr> 
 <td style="width:207px;">注解</td> 
 <td style="width:186px;">相关子属性</td> 
 <td style="width:456px;">说明</td> 
 </tr> 
 <tr> 
 <td style="width:207px;">@ContentStyle</td> 
 <td style="width:186px;"></td> 
 <td style="width:456px;">设置导出时的单元格格式，可用在class上也可用在属性上</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">horizontalAlignment</td> 
 <td style="width:456px;">使用HorizontalAlignmentEnum.CENTER时，意味着水平居中</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">verticalAlignment</td> 
 <td style="width:456px;">使用VerticalAlignmentEnum.CENTER时，意味着垂直居中</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">indent</td> 
 <td style="width:456px;">缩进</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">locked</td> 
 <td style="width:456px;">是否冻结</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">hidden</td> 
 <td style="width:456px;">是否隐藏</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">dataFormat</td> 
 <td style="width:456px;">数据格式</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">rotation</td> 
 <td style="width:456px;">旋转角度，用于图片</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">quotePrefix</td> 
 <td style="width:456px;">是否引用前缀（没用过）</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">wrapped</td> 
 <td style="width:456px;"> 控制数据的包装是否直接应用，默认为null，不应用， 例如单元格内换行，如果改值不设置为true，需要双击单元格才能换行 </td> 
 </tr> 
 <tr> 
 <td style="width:207px;">@ContentFontStyle</td> 
 <td style="width:186px;"></td> 
 <td style="width:456px;">设置导出时的文本格式</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">underline</td> 
 <td style="width:456px;">下划线，具体值可以参考org.apache.poi.ss.usermodel.FontUnderline的值，但不能直接引用</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">color</td> 
 <td style="width:456px;">颜色，具体值可以参考org.apache.poi.ss.usermodel.IndexedColors的值，但不能直接引用</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">bold</td> 
 <td style="width:456px;">是否加粗</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">strikeout</td> 
 <td style="width:456px;">是否加删除线</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">fontName</td> 
 <td style="width:456px;">字体类型（宋体、微软雅黑...）</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">italic</td> 
 <td style="width:456px;">是否斜体</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">fontHeightInPoints</td> 
 <td style="width:456px;">字体高度</td> 
 </tr> 
 <tr> 
 <td style="width:207px;">@ExcelProperty</td> 
 <td style="width:186px;"></td> 
 <td style="width:456px;">标识导出或导入时，该属性为有效列</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">value</td> 
 <td style="width:456px;">代表Excel的首行标题名称，标题名称相同且相邻的话，标题会自动合并</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">order</td> 
 <td style="width:456px;">排序，数值越小越靠前</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">index</td> 
 <td style="width:456px;">指定列号</td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">converter</td> 
 <td style="width:456px;">在遇到复杂数据时，可自定义处理工具，然后在该属性的位置加入自定义处理工具XxxxConverter.class自定义处理工具需要实现接口Converter&lt;T&gt;</td> 
 </tr> 
 <tr> 
 <td style="width:207px;">@DateTimeFormat</td> 
 <td style="width:186px;"></td> 
 <td style="width:456px;"></td> 
 </tr> 
 <tr> 
 <td style="width:207px;"></td> 
 <td style="width:186px;">value</td> 
 <td style="width:456px;">时间类型转为字符串格式。值可为：yyyy-MM-dd HH:mm:ss</td> 
 </tr> 
 </tbody> 
</table>

**简单举例自定义处理接口**

> @ExcelProperty(value = "自定义标题名", order = 1, converter = CustomStringConverter.class)
> 
> private String customTitle;

public class CustomStringConverter implements Converter<String> {
 @Override
 public Class<?> supportJavaTypeKey() {
 return String.class;
 }
 
 @Override
 public CellDataTypeEnum supportExcelTypeKey() {
 return CellDataTypeEnum.STRING;
 }
 
 /**
 * 这里读的时候会调用
 *
 * @param context
 * @return
 */
 @Override
 public String convertToJavaData(ReadConverterContext<?> context) {
 return "自定义：" + context.getReadCellData().getStringValue();
 }
 
 /**
 * 这里写的时候会调用
 * @return
 */
 @Override
 public WriteCellData<?> convertToExcelData(WriteConverterContext<String> context) {
 String stringValue = context.getValue();
 if (stringValue==null || stringValue.isEmpty()){
 stringValue = "这是一个空值";
 }
 return new WriteCellData<>(stringValue);
 }
 
 }

详情请参考官方文档：[关于Easyexcel | Easy Excel][Easyexcel _ Easy Excel]

[Easyexcel _ Easy Excel]: https://easyexcel.opensource.alibaba.com/docs/current/