EasyExcel常用注解

小鱼儿 2023-09-30 19:28 72阅读 0赞

## 11个注解 ##

*  @ExcelProperty
 *  @ColumnWith 列宽
 *  @ContentFontStyle 文本字体样式
 *  @ContentLoopMerge 文本合并
 *  @ContentRowHeight 文本行高度
 *  @ContentStyle 文本样式
 *  @HeadFontStyle |标题字体样式
 *  @HeadRowHeight |标题高度
 *  @HeadStyle |标题样式
 *  @ExcelIgnore |忽略项
 *  @ExcelIgnoreUnannotated |忽略未注解

<table> 
 <thead> 
  <tr> 
   <th>字段注解</th> 
   <th>类注解</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@ColumnWith(列宽)</td> 
   <td>@ColumnWidth(全局列宽)</td> 
  </tr> 
  <tr> 
   <td>@ExcelProperty(字段配置)</td> 
   <td>@HeadFontStyle(头样式)</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>@HeadRowHeight(标题高度)</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>@ContentFontStyle(内容字体样式)</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>@ContentRowHeight(内容高度)</td> 
  </tr> 
 </tbody> 
</table>

### **@ExcelProperty** ###

必要的一个注解，注解中有三个参数value,index,converter  
分别代表列名，列序号，数据转换方式  
value和index只能二选一，通常不用设置converter

1.  value 通过标题文本对应
2.  index 通过文本行号对应
3.  converter 转换器，通常入库和出库转换使用，如性别入库0和1，出库男和女

**最佳实践**

public class ImeiEncrypt {
        
        @ExcelProperty(value = "值")
        private String valueField;
    
        @ExcelProperty(value = 1,converter =IndustryIdConverter.class)
        private String indexField;
    
        @ExcelProperty(value = "值对应和转换器",converter =IndustryIdConverter.class)
        private String valueAndConverterField;
    }

### **@ColumnWith** ###

设置列宽度,只有一个参数value，value的单位是字符长度，最大可以设置255个字符，因为一个excel单元格最大可以写入的字符个数就是255个字符。

**最佳实践**

public class ImeiEncrypt {
        
        @ColumnWidth(value = 18)
        private String imei;
    }

### **@ContentFontStyle** ###

用于设置单元格内容字体格式的注解

参数：

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>fontName</td> 
   <td>字体名称</td> 
  </tr> 
  <tr> 
   <td>fontHeightInPoints</td> 
   <td>字体高度</td> 
  </tr> 
  <tr> 
   <td>italic</td> 
   <td>是否斜体</td> 
  </tr> 
  <tr> 
   <td>strikeout</td> 
   <td>是否设置删除水平线</td> 
  </tr> 
  <tr> 
   <td>color</td> 
   <td>字体颜色</td> 
  </tr> 
  <tr> 
   <td>typeOffset</td> 
   <td>偏移量</td> 
  </tr> 
  <tr> 
   <td>underline</td> 
   <td>下划线</td> 
  </tr> 
  <tr> 
   <td>bold</td> 
   <td>是否加粗</td> 
  </tr> 
  <tr> 
   <td>charset</td> 
   <td>编码格式</td> 
  </tr> 
 </tbody> 
</table>

### **@ContentLoopMerge** ###

用于设置合并单元格的注解

参数：

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>eachRow</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>columnExtend</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

### **@ContentRowHeight** ###

用于设置行高

参数：

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>行高，-1代表自动行高</td> 
  </tr> 
 </tbody> 
</table>

### **@ContentStyle** ###

设置内容格式注解  
参数：

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>dataFormat</td> 
   <td>日期格式</td> 
  </tr> 
  <tr> 
   <td>hidden</td> 
   <td>设置单元格使用此样式隐藏</td> 
  </tr> 
  <tr> 
   <td>locked</td> 
   <td>设置单元格使用此样式锁定</td> 
  </tr> 
  <tr> 
   <td>quotePrefix</td> 
   <td>在单元格前面增加`符号，数字或公式将以字符串形式展示</td> 
  </tr> 
  <tr> 
   <td>horizontalAlignment</td> 
   <td>设置是否水平居中</td> 
  </tr> 
  <tr> 
   <td>wrapped</td> 
   <td>设置文本是否应换行。将此标志设置为true通过在多行上显示使单元格中的所有内容可见</td> 
  </tr> 
  <tr> 
   <td>verticalAlignment</td> 
   <td>设置是否垂直居中</td> 
  </tr> 
  <tr> 
   <td>rotation</td> 
   <td>设置单元格中文本旋转角度。03版本的Excel旋转角度区间为-90°90°，07版本的Excel旋转角度区间为0°180°</td> 
  </tr> 
  <tr> 
   <td>indent</td> 
   <td>设置单元格中缩进文本的空格数</td> 
  </tr> 
  <tr> 
   <td>borderLeft</td> 
   <td>设置左边框的样式</td> 
  </tr> 
  <tr> 
   <td>borderRight</td> 
   <td>设置右边框样式</td> 
  </tr> 
  <tr> 
   <td>borderTop</td> 
   <td>设置上边框样式</td> 
  </tr> 
  <tr> 
   <td>borderBottom</td> 
   <td>设置下边框样式</td> 
  </tr> 
  <tr> 
   <td>leftBorderColor</td> 
   <td>设置左边框颜色</td> 
  </tr> 
  <tr> 
   <td>rightBorderColor</td> 
   <td>设置右边框颜色</td> 
  </tr> 
  <tr> 
   <td>topBorderColor</td> 
   <td>设置上边框颜色</td> 
  </tr> 
  <tr> 
   <td>bottomBorderColor</td> 
   <td>设置下边框颜色</td> 
  </tr> 
  <tr> 
   <td>fillPatternType</td> 
   <td>设置填充类型</td> 
  </tr> 
  <tr> 
   <td>fillBackgroundColor</td> 
   <td>设置背景色</td> 
  </tr> 
  <tr> 
   <td>fillForegroundColor</td> 
   <td>设置前景色</td> 
  </tr> 
  <tr> 
   <td>shrinkToFit</td> 
   <td>设置自动单元格自动大小</td> 
  </tr> 
 </tbody> 
</table>

### **@HeadFontStyle** ###

用于定制标题字体格式

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>fontName</td> 
   <td>设置字体名称</td> 
  </tr> 
  <tr> 
   <td>fontHeightInPoints</td> 
   <td>设置字体高度</td> 
  </tr> 
  <tr> 
   <td>italic</td> 
   <td>设置字体是否斜体</td> 
  </tr> 
  <tr> 
   <td>strikeout</td> 
   <td>是否设置删除线</td> 
  </tr> 
  <tr> 
   <td>color</td> 
   <td>设置字体颜色</td> 
  </tr> 
  <tr> 
   <td>typeOffset</td> 
   <td>设置偏移量</td> 
  </tr> 
  <tr> 
   <td>underline</td> 
   <td>设置下划线</td> 
  </tr> 
  <tr> 
   <td>charset</td> 
   <td>设置字体编码</td> 
  </tr> 
  <tr> 
   <td>bold</td> 
   <td>设置字体是否加粗</td> 
  </tr> 
 </tbody> 
</table>

### **@HeadRowHeight** ###

设置标题行行高

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value</td> 
   <td>设置行高，-1代表自动行高</td> 
  </tr> 
 </tbody> 
</table>

### **@HeadStyle** ###

设置标题样式

### **@ExcelIgnore** ###

不将该字段转换成Excel

### **@ExcelIgnoreUnannotated** ###

没有注解的字段都不转换

#### 颜色选择 ####

示例

@ExcelProperty(value = "姓名")
        @HeadFontStyle(bold = false)
        @HeadStyle(fillForegroundColor = 5)
        private String name;

org.apache.poi.ss.usermodelIndexedColors类  
BLACK1(0),  
WHITE1(1),  
RED1(2),  
BRIGHT\_GREEN1(3),  
BLUE1(4),  
YELLOW1(5),  
PINK1(6),  
TURQUOISE1(7),  
BLACK(8),  
WHITE(9),  
RED(10),  
BRIGHT\_GREEN(11),  
BLUE(12),  
YELLOW(13),  
PINK(14),  
TURQUOISE(15),  
DARK\_RED(16),  
GREEN(17),  
DARK\_BLUE(18),  
DARK\_YELLOW(19),  
VIOLET(20),  
TEAL(21),  
GREY\_25\_PERCENT(22),  
GREY\_50\_PERCENT(23),  
CORNFLOWER\_BLUE(24),  
MAROON(25),  
LEMON\_CHIFFON(26),  
LIGHT\_TURQUOISE1(27),  
ORCHID(28),  
CORAL(29),  
ROYAL\_BLUE(30),  
LIGHT\_CORNFLOWER\_BLUE(31),  
SKY\_BLUE(40),  
LIGHT\_TURQUOISE(41),  
LIGHT\_GREEN(42),  
LIGHT\_YELLOW(43),  
PALE\_BLUE(44),  
ROSE(45),  
LAVENDER(46),  
TAN(47),  
LIGHT\_BLUE(48),  
AQUA(49),  
LIME(50),  
GOLD(51),  
LIGHT\_ORANGE(52),  
ORANGE(53),  
BLUE\_GREY(54),  
GREY\_40\_PERCENT(55),  
DARK\_TEAL(56),  
SEA\_GREEN(57),  
DARK\_GREEN(58),  
OLIVE\_GREEN(59),  
BROWN(60),  
PLUM(61),  
INDIGO(62),  
GREY\_80\_PERCENT(63),  
AUTOMATIC(64);