广数车床机床解锁▉▉▉【一电一 17154833762-】▉▉▉老项目主要采用的POI框架来进行Excel数据的导入和导出,但经常会出现OOM的情况,导致整个服务不可用。后续逐步转移到EasyExcel,简直不能太好用了。
EasyExcel是阿里巴巴开源插件之一,主要解决了poi框架使用复杂,sax解析模式不容易操作,数据量大起来容易OOM,解决了POI并发造成的报错。主要解决方式:通过解压文件的方式加载,一行一行地加载,并且抛弃样式字体等不重要的数据,降低内存的占用。
在之前专门写过一篇文章《EasyExcel太方便易用了,强烈推荐!》,介绍EasyExcel功能的基本使用。今天这篇文章,我们基于SpringBoot来实现一下EasyExcel的集成,更加方便大家在实践中的直接使用。
SpringBoot项目集成
依赖集成
创建一个基础的SpringBoot项目,比如这里采用SpringBoot 2.7.2版本。
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
EasyExcel在SpringBoot的集成非常方便,只需引入对应的pom依赖即可。在上述dependencies中添加EasyExcel的依赖:
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>2.2.11</version>
</dependency>
EasyExcel目前稳定最新版本2.2.11。如果想查看开源项目或最新版本,可在GitHub上获得:https://github.com/alibaba/ea...。
为了方便和简化代码编写,这里同时引入了Lombok的依赖,后续代码中也会使用对应的注解。
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.22</version>
</dependency>
下面正式开始业务相关代码的编写。如果你想直接获得完整源码,对照源码阅读本篇文章,可在公号「程序新视界」内回“1007”获得完整源码。
实体类实现
这里创建一个Member,会员的实体类,并在实体类中填写基础的个人信息。
@Data
public class Member {
/**
* EasyExcel使用:导出时忽略该字段
*/
@ExcelIgnore
private Integer id;
@ExcelProperty("用户名")
@ColumnWidth(20)
private String username;
/**
* EasyExcel使用:日期的格式化
*/
@ColumnWidth(20)
@ExcelProperty("出生日期")
@DateTimeFormat("yyyy-MM-dd")
private Date birthday;
/**
* EasyExcel使用:自定义转换器
*/
@ColumnWidth(10)
@ExcelProperty(value = "性别", converter = GenderConverter.class)
private Integer gender;
}
为了尽量多的演示EasyExcel的相关功能,在上述实体类中使用了其常见的一些注解:
- @ExcelIgnore:忽略掉该字段;
- @ExcelProperty("用户名"):设置该列的名称为”用户名“;
- @ColumnWidth(20):设置表格列的宽度为20;
- @DateTimeFormat("yyyy-MM-dd"):按照指定的格式对日期进行格式化;
- @ExcelProperty(value = "性别", converter = GenderConverter.class):自定义内容转换器,类似枚举的实现,将“男”、“女”转换成“0”、“1”的数值。
GenderConverter转换器的代码实现如下:
public class GenderConverter implements Converter<Integer> {
private static final String MAN = "男";
private static final String WOMAN = "女";
@Override
public Class<?> supportJavaTypeKey() {
// 实体类中对象属性类型
return Integer.class;
}
@Override
public CellDataTypeEnum supportExcelTypeKey() {
// Excel中对应的CellData属性类型
return CellDataTypeEnum.STRING;
}
@Override
public Integer convertToJavaData(CellData cellData, ExcelContentProperty excelContentProperty,
GlobalConfiguration globalConfiguration) {
// 从Cell中读取数据
String gender = cellData.getStringValue();
// 判断Excel中的值,将其转换为预期的数值
if (MAN.equals(gender)) {
return 0;
} else if (WOMAN.equals(gender)) {
return 1;
}
return null;
}
@Override
public CellData<?> convertToExcelData(Integer integer, ExcelContentProperty excelContentProperty,
GlobalConfiguration globalConfiguration) {
// 判断实体类中获取的值,转换为Excel预期的值,并封装为CellData对象
if (integer == null) {
return new CellData<>("");
} else if (integer == 0) {
return new CellData<>(MAN);
} else if (integer == 1) {
return new CellData<>(WOMAN);
}
return new CellData<>("");
}
}
不同版本中,convertToJavaData和convertToExcelData的方法参数有所不同,对应的值的获取方式也不同,大家在使用时注意对照自己的版本即可。
业务逻辑实现
为方便验证功能,DAO层的逻辑便不再实现,直接通过Service层来封装数据,先来看导出功能的业务类实现。
MemberService实现
定义MemberService接口:
public interface MemberService {
/**
* 获取所有的成员信息
* @return 成员信息列表
*/
List<Member> getAllMember();
}
定义MemberServiceImpl实现类:
@Service("memberService")
public class MemberServiceImpl implements MemberService {
@Override
public List<Member> getAllMember() {
// 这里构造一些测试数据,具体业务场景可从数据库等其他地方获取
List<Member> list = new ArrayList<>();
Member member = new Member();
member.setUsername("张三");
member.setBirthday(getDate(1990, 10, 11));
member.setGender(0);
list.add(member);
Member member1 = new Member();
member1.setUsername("王红");
member1.setBirthday(getDate(1999, 3, 29));
member1.setGender(1);
list.add(member1);
Member member2 = new Member();
member2.setUsername("李四");
member2.setBirthday(getDate(2000, 2, 9));
member2.setGender(0);
list.add(member2);
return list;
}
private Date getDate(int year, int month, int day) {
Calendar calendar = Calendar.getInstance();
calendar.set(year, month, day);
return calendar.getTime();
}
}
其中数据采用模拟的静态数据,返回Member列表。
简单导出实现
在Controller层的实现一个简单的导出实现:
/**
* 普通导出方式
*/
@RequestMapping("/export1")
public void exportMembers1(HttpServletResponse response) throws IOException {
List<Member> members = memberService.getAllMember();
// 设置文本内省
response.setContentType("application/vnd.ms-excel");
// 设置字符编码
response.setCharacterEncoding("utf-8");
// 设置响应头
response.setHeader("Content-disposition", "attachment;filename=demo.xlsx");
EasyExcel.write(response.getOutputStream(), Member.class).sheet("成员列表").doWrite(members);
}
这个实现方式非常简单直接,使用EasyExcel的write方法将查询到的数据进行处理,以流的形式写出即可。
在浏览器访问对应的链接,可下载到如下Excel内容:
如果我们需要将导出的Excel进行一些格式化的处理,这就需要用到导出策略的实现了。
自定义导入实现
在EasyExcel执行write方法之后,获得ExcelWriterBuilder类,通过该类的registerWriteHandler方法可以设置一些处理策略。
这里先实现一个通用的格式策略工具类CommonCellStyleStrategy:
public class CommonCellStyleStrategy {
/**
* 设置单元格样式(仅用于示例)
*
* @return 样式策略
*/
public static HorizontalCellStyleStrategy getHorizontalCellStyleStrategy() {
// 表头策略
WriteCellStyle headerCellStyle = new WriteCellStyle();
// 表头水平对齐居中
headerCellStyle.setHorizontalAlignment(HorizontalAlignment.CENTER);
// 背景色
headerCellStyle.setFillForegroundColor(IndexedColors.SKY_BLUE.getIndex());
WriteFont headerFont = new WriteFont();
headerFont.setFontHeightInPoints((short) 15);
headerCellStyle.setWriteFont(headerFont);
// 自动换行
headerCellStyle.setWrapped(Boolean.FALSE);
// 内容策略
WriteCellStyle contentCellStyle = new WriteCellStyle();
// 设置数据允许的数据格式,这里49代表所有可以都允许设置
contentCellStyle.setDataFormat((short) 49);
// 设置背景色: 需要指定 FillPatternType 为FillPatternType.SOLID_FOREGROUND 不然无法显示背景颜色.头默认了 FillPatternType所以可以不指定
contentCellStyle.setFillPatternType(FillPatternType.SOLID_FOREGROUND);
contentCellStyle.setFillForegroundColor(IndexedColors.GREY_40_PERCENT.getIndex());
// 设置内容靠左对齐
contentCellStyle.setHorizontalAlignment(HorizontalAlignment.LEFT);
// 设置字体
WriteFont contentFont = new WriteFont();
contentFont.setFontHeightInPoints((short) 12);
contentCellStyle.setWriteFont(contentFont);
// 设置自动换行
contentCellStyle.setWrapped(Boolean.FALSE);
// 设置边框样式和颜色
contentCellStyle.setBorderLeft(BorderStyle.MEDIUM);
contentCellStyle.setBorderTop(BorderStyle.MEDIUM);
contentCellStyle.setBorderRight(BorderStyle.MEDIUM);
contentCellStyle.setBorderBottom(BorderStyle.MEDIUM);
contentCellStyle.setTopBorderColor(IndexedColors.RED.getIndex());
contentCellStyle.setBottomBorderColor(IndexedColors.GREEN.getIndex());
contentCellStyle.setLeftBorderColor(IndexedColors.YELLOW.getIndex());
contentCellStyle.setRightBorderColor(IndexedColors.ORANGE.getIndex());
// 将格式加入单元格样式策略
return new HorizontalCellStyleStrategy(headerCellStyle, contentCellStyle);
}
}
该类中示例设置了Excel的基础格式。