步骤:
1:引入依赖
2:创建AbstractXlsViews的子类ExcelView
3:创建ExcelView对象ev
4:将导出规则设置给ev
5:将ev设置给ModelAndView对象ev
1:依赖
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi</artifactId>
<version>3.15</version>
</dependency>
2: 创建AbstractXlsView的子类
AbstractXlsView间接继承了ModelAndView,我们设置的导出规则就是它的渲染规则,当我们把AbstractXlsView交给ModelAndView时,springmvc会按照AbstractXlsView的渲染(导出)规则渲染。
ExcelView类有两个字段
fileName表示导出的文件名称
ExcelExportService对象里面包含了导出规则
强制重写一个方法buildExcelDocument
protected void buildExcelDocument(Map<String, Object> model, Workbook workbook, HttpServletRequest request, HttpServletResponse response) throws Exception {
if (excelExportService == null) {
throw new RuntimeException("导出的接口不能为空");
}
if (StringUtils.isEmpty(fileName)) {
//filename为空
fileName = "默认名称.xlsx";
}
String requestCharset = request.getCharacterEncoding();
requestCharset = requestCharset == null ? "UTF-8" : requestCharset;
fileName = new String(fileName.getBytes(requestCharset), "ISO8859-1");
response.setHeader("Content-disposition", "attachment;fileName=" + fileName);
excelExportService.makeWorkBook(model, workbook);
}
ExcelView是一个视图解析器,我们不必纠结于buildExcelDocument方法什么时候去调用,如果好奇,可以去研究源码。这个方法主要是处理一下请求和响应方式,最后一行比较重要:执行导出规则
3:将导出的规则设置给ExcelView
将规则设置给ExcelView很简单,就是初始化ExcelView的字段ExcelExportService对象,上文说到ExcelExportService字段是导出excel的规则。
接口ExcelExport是我自定义的接口
以便所有实现它的类都必须有一个设置规则的方法markWorkBook。这里的markWorkBook就对应了第二步最后的那一行代码。
具体设置导出规则
我们第一步引入的依赖简称POI,
POI中整个excel对应WorkBook对象;
excel中每个sheet对应POI中Sheet
excel中每行对应POI中Row
excel中每个单元格对应POI中Cell
public void makeWorkBook(Map<String, Object> model, Workbook workbook) {
String sheetName;
List<T> pojoList = (List<T>) model.get("list");
if (claz.isAnnotationPresent(EnableExport.class)) {
EnableExport enableExport = (EnableExport) claz.getAnnotation(EnableExport.class);
sheetName = enableExport.value();
} else {
sheetName = "未定义名称";
}
Sheet sheet = workbook.createSheet(sheetName);
Row title = sheet.createRow(0);
Field[] fields = claz.getDeclaredFields();
//创建第一行:标题行
for (int i = 0, j = 0; i < fields.length; i++) {
if (fields[i].isAnnotationPresent(ExportName.class)) {
title.createCell(j).setCellValue(fields[i].getAnnotation(ExportName.class).value());
j++;
}
}
//创建数据行
for (int i = 0; i < pojoList.size(); i++) {
int j = 0;
//创建一行
Row dataRow = sheet.createRow(i + 1);
//创建单元格并填充数据
for (int n = 0; n < fields.length; n++) {
if (fields[n].isAnnotationPresent(ExportName.class)) {
//存在该注解,创建单元格并写入值
try {
fields[n].setAccessible(true);
dataRow.createCell(j).setCellValue(String.valueOf(fields[n].get(pojoList.get(i))));
j++;
} catch (Exception e) {
throw new RuntimeException("创建单元格错误,错误原因:" + e.getMessage());
}
}
}
}
}
这里贴我的makeWorkBook方法,但是我用了自定义注解去实现一个通用的规则, 从这段代码中我们可以看到WorkBook; Sheet: Row: Cell之间的关系:
workBook.creatSheet().creatRow().creatCell()
规则就设置好了
4:将ExcelView对象交给ModelAndView管理
贴一段代码完事:
@RequestMapping("excel")
public ModelAndView excel() {
ModelAndView mv = new ModelAndView();
//创建ExcelView对象
ExcelView ev = new ExcelView();
//将导出规则设置给ev
ev.setExcelExportService(new ExcelExportService(User.class));
ev.setFileName("用户信息.xlsx");
List<User> list = userService.getAll();
mv.addObject("list", list);
//将ev交给mv管理
mv.setView(ev);
return mv;
}
这里的**mv.addObject(“list”,list)**把需要导出的数据存在了Model中,在ExcelExportService类中,被取出。设置规则的时候需要用到。