IT评测·应用市场-qidao123.com

标题: Easyexcel（1-注解利用） [打印本页]

---

作者: 尚未崩坏    时间: 2025-3-6 08:16
标题: Easyexcel（1-注解利用）
版本依赖

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

复制代码

@ExcelProperty

指定当前字段对应 excel 中的那一列，可以根据名字或者 Index 去匹配，固然也可以不写。

• value：指定写入的列头，如果不指定则利用成员变量的名字作为列头；如果要设置复杂的头，可以为 value 指定多个值
  
• order：优先级高于 value，会根据 order 的顺序来匹配实体和 excel 中数据的顺序
  
• index：优先级高于 value 和 order，指定写到第几列，如果不指定则根据成员变量位置排序；默认第一个字段就是 index=0
  
• converter：指定当前字段用什么转换器，默认会自动选择。可以用来设置类型转换器，需要实现 Converter 接口
  

value

指定属性名

1. @Data
2. public class User {
4.     private Integer userId;
6.     private String name;
8.     private String phone;
10.     private String email;
12.     private Date createTime;
13. }

复制代码

1. @RestController
2. public class TestController {
4.     @GetMapping("/test1")
5.     public void test1(HttpServletResponse response) {
6.         try {
7.             response.setContentType("application/vnd.ms-excel");
8.             response.setCharacterEncoding("utf-8");
9.             String fileName = URLEncoder.encode("test1", "UTF-8").replaceAll("\\+", "%20");
10.             response.setHeader("Content-disposition", "attachment;filename" + fileName + ".xls");
12.             User user = new User();
13.             user.setUserId(123);
14.             user.setName("as");
15.             user.setPhone("15213");
16.             user.setEmail("5456");
17.             user.setCreateTime(13213L);
18.             EasyExcel.write(response.getOutputStream(), User.class)
19.                     .sheet("test")
20.                     .doWrite(Arrays.asList(user));
21.         } catch (Exception e) {
22.             e.printStackTrace();
23.         }
24.     }
25. }

复制代码

默认情况下，利用类的属性名作为 Excel 的列表，固然也可以利用@ExcelProperty 注解来重新指定属性名称。

1. @Data
2. public class User {
3.     @ExcelProperty(value = "用户Id")
4.     private Integer userId;
6.     @ExcelProperty(value = "姓名")
7.     private String name;
9.     @ExcelProperty(value = "手机")
10.     private String phone;
12.     @ExcelProperty(value = "邮箱")
13.     private String email;
15.     @ExcelProperty(value = "创建时间")
16.     private Date createTime;
17. }

复制代码

表头合并

value 在写的时候，如果指定了多个值，会自动进行合并

1. @Data
2. public class User {
3.     @ExcelProperty(value = "用户Id")
4.     private Integer userId;
6.     @ExcelProperty(value = {"用户基本信息", "姓名"})
7.     private String name;
9.     @ExcelProperty(value = {"用户基本信息", "手机"})
10.     private String phone;
12.     @ExcelProperty(value = {"用户基本信息", "邮箱"})
13.     private String email;
15.     @ExcelProperty(value = "创建时间")
16.     private Date createTime;
17. }

复制代码

index

指定位置

@ExcelProperty 注解有两个属性 index 和 order，如果不指定则按照属性在类中的分列顺序来。index 是指定该属性在 Excel 中列的下标，下标从 0 开始

1. @Data
2. public class User {
3.     @ExcelProperty(value = "用户Id", index = 2)
4.     private Integer userId;
6.     @ExcelProperty(value = "姓名", index = 1)
7.     private String name;
9.     @ExcelProperty(value = "手机")
10.     private String phone;
12.     @ExcelProperty(value = "邮箱")
13.     private String email;
15.     @ExcelProperty(value = "创建时间")
16.     private Date createTime;
17. }

复制代码

1. @Data
2. public class User {
3.     @ExcelProperty(value = "用户Id", index = 2)
4.     private Integer userId;
6.     @ExcelProperty(value = "姓名", index = 1)
7.     private String name;
9.     @ExcelProperty(value = "手机", index = 10)
10.     private String phone;
12.     @ExcelProperty(value = "邮箱", index = 12)
13.     private String email;
15.     @ExcelProperty(value = "创建时间")
16.     private Date createTime;
17. }

复制代码

order

指定顺序

1. @Data
2. public class User {
3.     @ExcelProperty(value = "用户Id")
4.     private Integer userId;
6.     @ExcelProperty(value = "姓名")
7.     private String name;
9.     @ExcelProperty(value = "手机", order = 11)
10.     private String phone;
12.     @ExcelProperty(value = "邮箱", order = 10)
13.     private String email;
15.     @ExcelProperty(value = "创建时间")
16.     private Long createTime;
17. }

复制代码

order 的默认值为 Integer.MAX_VALUE，通过结果我们可以得出结论：order 值越小，越排在前面
留意：

• 优先级：index > order > 默认配置
  
• index 相称于绝对位置，下标从 0 开始
  
• order 相称于相对位置，值越小的排在越前面
  

convert

自定义转换器

在读写 EXCEL 时，有时候需要我们进行数据类型转换，例如我们这里的创建时间，在实体对象中是 Long 类型，但是这样直接导出到 Excel 中不太直观。我们需要转换成 yyyy-MM-dd HH:mm:ss 格式，此时我们就可以用到转换器。

1. public class DateTimeConverter implements Converter<Long> {
3.     private final DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
5.     // 支持导入的Java类型
6.     @Override
7.     public Class<?> supportJavaTypeKey() {
8.         return Long.class;
9.     }
11.     // 支持导出的Excel类型
12.     @Override
13.     public CellDataTypeEnum supportExcelTypeKey() {
14.         return CellDataTypeEnum.STRING;
15.     }
17.     // 转换为Java
18.     @Override
19.     public Long convertToJavaData(ReadCellData<?> cellData, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) throws Exception {
20.         return null;
21.     }
23.     // 转换为Excel
24.     @Override
25.     public WriteCellData<?> convertToExcelData(Long value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) throws Exception {
26.         if (value == null) {
27.             return new WriteCellData(CellDataTypeEnum.STRING, null);
28.         }
29.         LocalDateTime localDateTime = LocalDateTime.ofInstant(Instant.ofEpochMilli(value), ZoneId.systemDefault());
30.         String dateStr = localDateTime.format(dateTimeFormatter);
31.         return new WriteCellData(dateStr);
32.     }
33. }

复制代码

1. @Data
2. public class User {
3.     @ExcelProperty(value = "用户Id")
4.     private Integer userId;
6.     @ExcelProperty(value = "姓名")
7.     private String name;
9.     @ExcelProperty(value = "手机", order = 11)
10.     private String phone;
12.     @ExcelProperty(value = "邮箱", order = 10)
13.     private String email;
15.     @ExcelProperty(value = "创建时间", converter = DateTimeConverter.class)
16.     private Long createTime;
17. }

复制代码

摆列转换

1. /**
2. * Excel 性别转换器
3. */
4. public class GenderConverter implements Converter<Integer> {
5.     @Override
6.     public Class<?> supportJavaTypeKey() {
7.         return Integer.class;
8.     }
10.     @Override
11.     public CellDataTypeEnum supportExcelTypeKey() {
12.         return CellDataTypeEnum.STRING;
13.     }
15.     @Override
16.     public Integer convertToJavaData(ReadConverterContext<?> context) {
17.         return GenderEnum.convert(context.getReadCellData().getStringValue()).getValue();
18.     }
20.     @Override
21.     public WriteCellData<?> convertToExcelData(WriteConverterContext<Integer> context) {
22.         return new WriteCellData<>(GenderEnum.convert(context.getValue()).getDescription());
23.     }
24. }

复制代码

1. /**
2. * 性别枚举
3. */
4. @Getter
5. @AllArgsConstructor
6. public enum GenderEnum {
8.     UNKNOWN(0, "未知"),
10.     MALE(1, "男性"),
12.     FEMALE(2, "女性");
14.     private final Integer value;
16.     private final String description;
18.     public static GenderEnum convert(Integer value) {
19.         return Stream.of(values())
20.                 .filter(bean -> bean.value.equals(value))
21.                 .findAny()
22.                 .orElse(UNKNOWN);
23.     }
25.     public static GenderEnum convert(String description) {
26.         return Stream.of(values())
27.                 .filter(bean -> bean.description.equals(description))
28.                 .findAny()
29.                 .orElse(UNKNOWN);
30.     }
31. }

复制代码

@ExcelIgnore

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

1. @Data
2. public class User {
3.     @ExcelProperty(value = "用户Id")
4.     private Integer userId;
6.     @ExcelProperty(value = "姓名")
7.     private String name;
9.     @ExcelProperty(value = "手机")
10.     private String phone;
12.     @ExcelProperty(value = "邮箱")
13.     @ExcelIgnore
14.     private String email;
16.     @ExcelProperty(value = "创建时间", converter = DateTimeConverter.class)
17.     @ExcelIgnore
18.     private Long createTime;
19. }

复制代码

@ExcelIgnoreUnannotated

不标注该注解时，默认类中所有成员变量都会参与读写，无论是否在成员变量上加了@ExcelProperty 的注解。标注该注解后，类中的成员变量如果没有标注 @ExcelProperty 注解将不会参与读写。

1. @ExcelIgnoreUnannotated
2. @Data
3. public class User {
5.     @ExcelProperty(value = "用户Id")
6.     private Integer userId;
8.     @ExcelProperty(value = "姓名")
9.     private String name;
11.     @ExcelProperty(value = "手机")
12.     private String phone;
14.     private String email;
16.     private Long createTime;
17. }

复制代码

@ColumnWidth

用于设置表格列的宽度

1. @Data
2. public class User {
4.     @ColumnWidth(200)
5.     @ExcelProperty(value = "用户Id")
6.     private Integer userId;
8.     @ExcelProperty(value = "姓名")
9.     private String name;
11.     @ExcelProperty(value = "手机")
12.     private String phone;
14.     @ExcelProperty(value = "邮箱")
15.     private String email;
17.     @ExcelProperty(value = "创建时间", converter = DateTimeConverter.class)
18.     private Long createTime;
19. }

复制代码

@ContentRowHeight

标注在类上，指定内容行高

1. @Data
2. @ContentRowHeight(value = 50)
3. public class User {
5.     @ExcelProperty(value = "用户Id")
6.     private Integer userId;
8.     @ExcelProperty(value = "姓名")
9.     private String name;
11.     @ExcelProperty(value = "手机")
12.     private String phone;
14.     @ExcelProperty(value = "邮箱")
15.     private String email;
17.     @ExcelProperty(value = "创建时间", converter = DateTimeConverter.class)
18.     private Long createTime;
19. }

复制代码

@HeadRowHeight

标注在类上，指定列头行高

1. @Data
2. @HeadRowHeight(80)
3. @ContentRowHeight(value = 50)
4. public class User {
6.     @ExcelProperty(value = "用户Id")
7.     private Integer userId;
9.     @ExcelProperty(value = "姓名")
10.     private String name;
12.     @ExcelProperty(value = "手机")
13.     private String phone;
15.     @ExcelProperty(value = "邮箱")
16.     private String email;
18.     @ExcelProperty(value = "创建时间", converter = DateTimeConverter.class)
19.     private Long createTime;
20. }

复制代码

@ContentStyle

用于设置内容格式注解

• dataFormat：日期格式
  
• hidden：设置单位格利用此样式潜伏
  
• locked：设置单位格利用此样式锁定
  
• quotePrefix：在单位格前面增加`符号，数字或公式将以字符串情势展示
  
• horizontalAlignment：设置是否水平居中
  
• wrapped：设置文本是否应换行。将此标志设置为 true 通过在多行上表现使单位格中的所有内容可见
  
• verticalAlignment：设置是否垂直居中
  
• rotation：设置单位格中文本旋转角度。03 版本的 Excel 旋转角度区间为-90°90°，07 版本的 Excel 旋转角度区间为 0°180°
  
• indent：设置单位格中缩进文本的空格数
  
• borderLeft：设置左边框的样式
  
• borderRight：设置右边框样式
  
• borderTop：设置上边框样式
  
• borderBottom：设置下边框样式
  
• leftBorderColor：设置左边框颜色
  
• rightBorderColor：设置右边框颜色
  
• topBorderColor：设置上边框颜色
  
• bottomBorderColor：设置下边框颜色
  
• fillPatternType：设置填充类型
  
• fillBackgroundColor：设置背景色
  
• fillForegroundColor：设置前景色
  
• shrinkToFit：设置自动单位格自动巨细
  

@ContentFontStyle

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

• fontName：字体名称
  
• fontHeightInPoints：字体高度
  
• italic：是否斜体
  
• strikeout：是否设置删除水平线
  
• color：字体颜色
  
• typeOffset：偏移量
  
• underline：下划线
  
• bold：是否加粗
  
• charset：编码格式
  

@HeadStyle

用于设置标题样式

• dataFormat：日期格式
  
• hidden：设置单位格利用此样式潜伏
  
• locked：设置单位格利用此样式锁定
  
• quotePrefix：在单位格前面增加`符号，数字或公式将以字符串情势展示
  
• horizontalAlignment：设置是否水平居中
  
• wrapped：设置文本是否应换行。将此标志设置为 true 通过在多行上表现使单位格中的所有内容可见
  
• verticalAlignment：设置是否垂直居中
  
• rotation：设置单位格中文本旋转角度。03 版本的 Excel 旋转角度区间为-90°90°，07 版本的 Excel 旋转角度区间为 0°180°
  
• indent：设置单位格中缩进文本的空格数
  
• borderLeft：设置左边框的样式
  
• borderRight：设置右边框样式
  
• borderTop：设置上边框样式
  
• borderBottom：设置下边框样式
  
• leftBorderColor：设置左边框颜色
  
• rightBorderColor：设置右边框颜色
  
• topBorderColor：设置上边框颜色
  
• bottomBorderColor：设置下边框颜色
  
• fillPatternType：设置填充类型
  
• fillBackgroundColor：设置背景色
  
• fillForegroundColor：设置前景色
  
• shrinkToFit：设置自动单位格自动巨细
  

@HeadFontStyle

用于定制标题字体格式

• fontName：设置字体名称
  
• fontHeightInPoints：设置字体高度
  
• italic：设置字体是否斜体
  
• strikeout：是否设置删除线
  
• color：设置字体颜色
  
• typeOffset：设置偏移量
  
• underline：设置下划线
  
• charset：设置字体编码
  
• bold：设置字体是否加粗
  

@ContentLoopMerge

用于设置合并单位格的注解，作用于字段上

• eachRow：合并列
  
• columnExtend：合并行
  

@OnceAbsoluteMerge

用于指定位置的单位格合并，作用于类上

• firstRowIndex：第一行下标
  
• lastRowIndex：最后一行下标
  
• firstColumnIndex：第一列下标
  
• lastColumnIndex：最后一列下标
  

@DateTimeFormat

日期转换，读取 Excel 文件时用 String 去接收 excel 日期格式的数据会调用这个注解。里面的 value 参照 java.text.SimpleDateFormat

1. @Data
2. public class User {
4.     @ExcelProperty(value = "用户Id")
5.     private Integer userId;
7.     @ExcelProperty(value = "姓名")
8.     private String name;
10.     @ExcelProperty(value = "手机")
11.     private String phone;
13.     @ExcelProperty(value = "邮箱")
14.     private String email;
16.     @DateTimeFormat("yyyy-MM-dd")
17.     @ExcelProperty(value = "创建时间")
18.     private Date createTime;
19. }

复制代码

@NumberFormat

数字转换，用 String 去接收 excel 数字格式的数据会调用这个注解。里面的 value 参照 java.text.DecimalFormat

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

---

欢迎光临 IT评测·应用市场-qidao123.com (https://dis.qidao123.com/)

Powered by Discuz! X3.4