EasyExcel易用性的体现之一就是可以通过在实体类中使用注解的形式,来与Excel中的表头进行绑定。
现在直接上实体类:
@Data
public class UserData {
@ExcelProperty(index = 0, value = "姓名")
private String username;
@ExcelProperty(index = 1, value = "年龄")
private int age;
@DateTimeFormat("yyyy-MM-dd")
@ExcelProperty(index = 2, value = "生日")
private Date birthday;
}
在上面的实体类中@Data为Lombok的注解,当然你可以自行生成getter/setter方法,其他的注解均为EasyExcel提供的:
@ExcelProperty:用于设置Excel表头,其中index用户表头的编号,从0开始;value为表头对应的内容。
@DateTimeFormat:用于日期的格式化。
完成上述功能准备工作之后,我们先来生成一个Excel。
生成Excel
下面直接展示生成Excel的示例代码:
public class EasyExcelDemo {
public static void main(String[] args) {
// 实现excel写操作
//1.设置写入文件夹地址和excel文件名称
String fileName = "/Users/zzs/temp/excel/write.xlsx";
//调用easyExcel里面的方法实现写操作
//2个参数,第一个参数是文件名称,第二个参数是实体类
EasyExcel.write(fileName, UserData.class).sheet("学生信息表").doWrite(getData());
}
//创建方法返回list集合
public static List<UserData> getData() {
List<UserData> list = new ArrayList<>();
UserData userData1 = new UserData();
userData1.setUsername("张三");
userData1.setAge(22);
userData1.setBirthday(formatDate("2000-10-11"));
list.add(userData1);
UserData userData2 = new UserData();
userData2.setUsername("李四");
userData2.setAge(23);
userData2.setBirthday(formatDate("1999-5-3"));
list.add(userData2);
return list;
}
public static Date formatDate(String birthday) {
SimpleDateFormat sdf = new SimpleDateFormat("yyy-MM-dd");
try {
return sdf.parse(birthday);
} catch (ParseException e) {
e.printStackTrace();
}
return null;
}
}
除了准备数据的代码,核心代码只有main方法中调用的EasyExcel.write方法,就是如此的简单。EasyExcel的write方法会根据传入的数据和实体类UserData进行绑定,生成Excel文件。
性别属性注入SexConverter转换器:
@ExcelProperty(value = "性别", converter = SexConverter.class)
private Integer sex;
复制
再次生成Excel,性别字段内容便显示为:男、女字样。
保留两位小数
比如体重需要保留两位小数,可通过@NumberFormat 注解实现:
@ExcelProperty(value = "体重KG")
@NumberFormat("0.##") // 会以字符串形式生成单元格,要计算的列不推荐
private BigDecimal weight;
复制
另外一种方法是使用@ContentStyle注解:
@ContentStyle(dataFormat = 2)
private BigDecimal weight2;
复制
这样也能达到保留两位小数的效果。
当然,也可以使用实现Converter接口的方式实现(同性别实现)。
排除指定Excel列
在很多场景下,Excel的列与实体类可能并不完全一致,这时就需要排除一些实体类的字段。
方式一:类上加注解 @ExcelIgnoreUnannotated,过滤属性没有@ExcelProperty注解的字段
@Data
@ToString
@AllArgsConstructor
@NoArgsConstructor // 一定要有无参构造方法
@ExcelIgnoreUnannotated
public class UserData {
.....
}
复制
方式二:指定字段加@ExcelIgnore注解
@ExcelIgnore // 该字段不生成excel
private String remark;
复制
方式三:代码指定过滤字段,通过excludeColumnFiledNames方法:
EasyExcel.write(fileName, UserData.class).sheet("学生信息表").excludeColumnFiledNames(Arrays.asList("remark")).doWrite(getData());
复制
这种方法的好处是:同一Excel可以在调用方法时排除不同的数据列。